diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json index 0b0ae5a2..d2f551fa 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -1,65 +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", - "UniversalReference": "Content" - }, - "build_entry_point": "docs", - "template_folder": "_themes", - "customized_template_paths": [ - "_dependentPackages/uref/content" - ] - } - ], - "JoinTOCPlugin": [ - { - "TopLevelTOC": "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 -} \ No newline at end of file + "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" + } +} 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/breadcrumb/toc.yml b/SP-Framework/breadcrumb/toc.yml index ac02f441..4754f2e1 100644 --- a/SP-Framework/breadcrumb/toc.yml +++ b/SP-Framework/breadcrumb/toc.yml @@ -1,4 +1,3 @@ - name: SharePoint tocHref: /javascript/api/ topicHref: /sharepoint/dev/index - diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index 8df82eb3..29d1904e 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -1,32 +1,35 @@ ### 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 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 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. - 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: decorators.override + fullName: 'override(target, propertyKey, descriptor)' langs: - typeScript type: function syntax: - content: "export function override(target: Object, propertyKey: string | symbol,\r\n descriptor: TypedPropertyDescriptor): void;" + content: >- + export declare function override(target: Object, propertyKey: string | symbol, descriptor: + TypedPropertyDescriptor): void; return: type: - void @@ -35,27 +38,30 @@ items: - id: target description: '' type: - - Object + - '!Object:interface' + optional: false - id: propertyKey description: '' type: - string | symbol + optional: false - id: descriptor description: '' type: - - TypedPropertyDescriptor - - uid: decorators.sealed + - '@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. name: sealed(target) - fullName: decorators.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 @@ -64,20 +70,23 @@ items: - id: target description: '' type: - - Function - - uid: decorators.virtual + - '!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. + 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: decorators.virtual + fullName: 'virtual(target, propertyKey, descriptor)' langs: - typeScript type: function syntax: - content: "export function virtual(target: Object, propertyKey: string | symbol,\r\n descriptor: TypedPropertyDescriptor): void;" + content: >- + export declare function virtual(target: Object, propertyKey: string | symbol, descriptor: + TypedPropertyDescriptor): void; return: type: - void @@ -86,12 +95,38 @@ items: - id: target description: '' type: - - Object + - '!Object:interface' + optional: false - id: propertyKey description: '' type: - string | symbol + optional: false - id: descriptor description: '' type: - - TypedPropertyDescriptor + - '@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/docfx.json b/SP-Framework/docfx.json index d74575f9..a9373dc8 100644 --- a/SP-Framework/docfx.json +++ b/SP-Framework/docfx.json @@ -14,6 +14,8 @@ "LICENSE-CODE", "ThirdPartyNotices" ], + "version": "sp-typescript-latest", + "src": ".", "dest": "api" } ], @@ -27,17 +29,35 @@ "**/obj/**", "**/includes/**" ], + "version": "sp-typescript-latest", "dest": "api" } ], + "versions": { + "sp-typescript-latest": { + "dest": "sp-typescript-latest" + } + }, "overwrite": [], "externalReference": [], "globalMetadata": { + "apiPlatform":"javascript", "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": { + "monikers": + { + "**/*.yml": [ "sp-typescript-latest" ] + } }, - "fileMetadata": {}, "template": [], "dest": "SP-Framework" } -} \ No newline at end of file +} 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..3af127fd --- /dev/null +++ b/SP-Framework/office-ui-fabric-react-bundle.yml @@ -0,0 +1,23 @@ +### 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(); + name: initializeIcons() + fullName: initializeIcons() + langs: + - typeScript + type: function + syntax: + content: 'export declare function initializeIcons(): void;' + return: + type: + - void + description: '' diff --git a/SP-Framework/overview/sharepoint.md b/SP-Framework/overview/sharepoint.md index de10fce3..20451f07 100644 --- a/SP-Framework/overview/sharepoint.md +++ b/SP-Framework/overview/sharepoint.md @@ -1,3 +1,20 @@ +--- +title: SharePoint Framework TypeScript Reference +description: The SharePoint Framework object model is built in TypeScript. +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) +- [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 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..b2d387d7 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base.yml @@ -0,0 +1,179 @@ +### 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 new file mode 100644 index 00000000..4e1957c1 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml @@ -0,0 +1,107 @@ +### 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 + langs: + - typeScript + type: property + syntax: + content: 'get deviceContext(): DeviceContext;' + return: + 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 + isPreview: true + name: location + fullName: location + langs: + - typeScript + type: property + syntax: + content: 'get location(): Promise;' + return: + 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)' + name: manifest + fullName: manifest + langs: + - typeScript + type: property + syntax: + content: 'readonly manifest: IAdaptiveCardExtensionManifest;' + return: + 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)' + name: propertyPane + fullName: propertyPane + langs: + - typeScript + type: property + syntax: + content: 'get propertyPane(): IPropertyPaneAccessor | undefined;' + return: + 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 new file mode 100644 index 00000000..f9f81f15 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml @@ -0,0 +1,805 @@ +### 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 + langs: + - typeScript + type: property + syntax: + content: 'protected _iconProperty: string;' + return: + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#_title:member' + name: _title + fullName: _title + langs: + - typeScript + type: property + syntax: + content: 'protected _title: string;' + return: + 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.' + name: cardNavigator + fullName: cardNavigator + langs: + - typeScript + type: property + syntax: + content: 'get cardNavigator(): ViewNavigator>;' + return: + 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).' + name: cardSize + fullName: cardSize + langs: + - typeScript + type: property + syntax: + content: 'protected get cardSize(): CardSize;' + return: + 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).' + name: context + fullName: context + langs: + - typeScript + type: property + syntax: + content: 'protected context: AdaptiveCardExtensionContext;' + return: + 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. + name: dataVersion + fullName: dataVersion + langs: + - typeScript + type: property + syntax: + content: 'protected get dataVersion(): Version;' + return: + 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. + name: description + fullName: description + langs: + - typeScript + type: property + syntax: + content: 'protected get description(): string;' + return: + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#displayMode:member' + summary: 'The current [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum).' + name: displayMode + fullName: displayMode + langs: + - typeScript + type: property + syntax: + content: 'get displayMode(): DisplayMode;' + return: + 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 + 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 + optional: false + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getCacheSettings:member(1)' + summary: Override the default cache settings. + isPreview: true + name: getCacheSettings() + fullName: getCacheSettings() + langs: + - typeScript + type: method + syntax: + content: |- + /** @virtual */ + protected getCacheSettings(): Partial; + return: + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getCacheSettings~0:complex' + description: '' + - 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. + 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)). + name: getPropertyPaneConfiguration() + fullName: getPropertyPaneConfiguration() + langs: + - typeScript + type: method + syntax: + content: |- + /** @virtual */ + protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration; + return: + type: + - '@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface' + description: '' + - 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. + name: loadPropertyPaneResources() + fullName: loadPropertyPaneResources() + langs: + - typeScript + type: method + syntax: + content: |- + /** @virtual */ + protected loadPropertyPaneResources(): Promise; + return: + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#loadPropertyPaneResources~0:complex' + description: '' + - 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 + 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. + 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 + 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: + - '@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`.' + 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 + optional: false + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onBeforeSerialize:member(1)' + summary: Lifecycle method called before serialization. + name: onBeforeSerialize() + fullName: onBeforeSerialize() + langs: + - typeScript + type: method + syntax: + content: |- + /** @virtual */ + onBeforeSerialize(): void; + return: + type: + - void + description: '' + - 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.' + 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' + optional: false + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onDispose:member(1)' + summary: Lifecycle method called before disposing the Adaptive Card Extension. + name: onDispose() + fullName: onDispose() + langs: + - typeScript + type: method + syntax: + content: |- + /** @virtual */ + onDispose(): void; + return: + type: + - void + description: '' + - 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. + name: onInit() + fullName: onInit() + langs: + - typeScript + type: method + syntax: + content: |- + /** @virtual */ + onInit(): Promise; + return: + type: + - '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onInit~0:complex' + description: '' + - 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 + 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: >- + 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: + - '@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. + 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 + optional: false + - id: oldValue + description: Old value of the property. This value could be undefined/empty in the case of custom field. + 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 + 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. + 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: + - '@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: + - 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.' + name: renderCard() + fullName: renderCard() + langs: + - typeScript + type: method + syntax: + content: |- + /** @virtual */ + protected renderCard(): string | undefined; + return: + type: + - string | undefined + description: '' + - 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)). + 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: + - '@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: + - '@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 new file mode 100644 index 00000000..43bfa5d4 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardview.yml @@ -0,0 +1,95 @@ +### 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!' + 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. + name: data + fullName: data + langs: + - typeScript + type: property + syntax: + content: |- + /** @virtual */ + get data(): TData; + return: + 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.' + name: externalLink + fullName: externalLink + langs: + - typeScript + type: property + syntax: + content: |- + /** @virtual */ + get externalLink(): IExternalLinkParameters | undefined; + return: + 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. + name: template + fullName: template + langs: + - typeScript + type: property + syntax: + content: |- + /** @virtual */ + abstract get template(): ISPFxAdaptiveCard; + return: + 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) + name: title + fullName: title + langs: + - typeScript + type: property + syntax: + content: |- + /** @virtual */ + get title(): string; + return: + 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 new file mode 100644 index 00000000..cbad079f --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml @@ -0,0 +1,62 @@ +### 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!' + 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). + name: template + fullName: template + langs: + - typeScript + type: property + syntax: + content: |- + /** @sealed */ + get template(): ISPFxAdaptiveCard; + return: + 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. + name: cardButtons + fullName: cardButtons + langs: + - typeScript + type: property + syntax: + content: |- + /** @virtual */ + get cardButtons(): [ICardButton] | [ICardButton, ICardButton] | undefined; + return: + 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. + name: data + fullName: data + langs: + - typeScript + type: property + syntax: + content: 'abstract get data(): TData;' + return: + 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.' + name: isCacheEnabled + fullName: isCacheEnabled + langs: + - typeScript + type: property + syntax: + content: |- + /** @virtual */ + get isCacheEnabled(): boolean; + return: + type: + - boolean + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#onCardSelection:member' + summary: Action to invoke when the card is selected. + name: onCardSelection + fullName: onCardSelection + langs: + - typeScript + type: property + syntax: + content: >- + /** @virtual */ + + get onCardSelection(): IQuickViewCardAction | IExternalLinkCardAction | ISelectMediaCardAction | + IGetLocationCardAction | IShowLocationCardAction | undefined; + return: + 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 new file mode 100644 index 00000000..e324e3d2 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml @@ -0,0 +1,62 @@ +### 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!' + 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). + name: template + fullName: template + langs: + - typeScript + type: property + syntax: + content: |- + /** @sealed */ + get template(): ISPFxAdaptiveCard; + return: + 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 + 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!' + 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). + name: template + fullName: template + langs: + - typeScript + type: property + syntax: + content: |- + /** @sealed */ + get template(): ISPFxAdaptiveCard; + return: + 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). + name: cardNavigator + fullName: cardNavigator + langs: + - typeScript + type: property + syntax: + content: 'get cardNavigator(): ViewNavigator>;' + return: + 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). + name: cardSize + fullName: cardSize + langs: + - typeScript + type: property + syntax: + content: 'get cardSize(): CardSize;' + return: + 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). + name: context + fullName: context + langs: + - typeScript + type: property + syntax: + content: 'get context(): AdaptiveCardExtensionContext;' + return: + 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. + name: data + fullName: data + langs: + - typeScript + type: property + syntax: + content: 'abstract get data(): TData | undefined;' + return: + type: + - TData | undefined + - uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#onAction:member(1)' + summary: Action handler for Adaptive Card Actions. + 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: + - '@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. + isPreview: true + 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: + - '@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: + - 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)). + 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: + - '@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). + 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 + 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: + - '@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 new file mode 100644 index 00000000..54e3bbea --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/cardsize.yml @@ -0,0 +1,15 @@ +### 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 new file mode 100644 index 00000000..3868e404 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/devicecontext.yml @@ -0,0 +1,17 @@ +### 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 new file mode 100644 index 00000000..8ec8ba7c --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionarguments.yml @@ -0,0 +1,47 @@ +### 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 new file mode 100644 index 00000000..368a80ca --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionerror.yml @@ -0,0 +1,21 @@ +### 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 new file mode 100644 index 00000000..9151a15b --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iactionerrorarguments.yml @@ -0,0 +1,43 @@ +### 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 new file mode 100644 index 00000000..c3d26288 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertiesmetadata.yml @@ -0,0 +1,12 @@ +### 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 new file mode 100644 index 00000000..f71788fb --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml @@ -0,0 +1,17 @@ +### 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 new file mode 100644 index 00000000..552c2cf8 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iattachmenterror.yml @@ -0,0 +1,26 @@ +### 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!' + 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 + isPreview: true + name: errorCode + fullName: errorCode + langs: + - typeScript + type: property + 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 new file mode 100644 index 00000000..305ca470 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionarguments.yml @@ -0,0 +1,43 @@ +### 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!' + 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 + name: id + fullName: id + langs: + - typeScript + type: property + syntax: + content: 'id?: string;' + return: + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionArguments#type:member' + summary: The type of Adaptive Card Action. + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''Submit'' | ''ShowCard'';' + return: + 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 new file mode 100644 index 00000000..22dbea62 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml @@ -0,0 +1,59 @@ +### 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!' + 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 + isPreview: true + name: error + fullName: error + langs: + - typeScript + type: property + syntax: + content: 'error: IActionError;' + return: + 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 + isPreview: true + name: id + fullName: id + langs: + - typeScript + type: property + syntax: + content: 'id?: string;' + return: + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments#type:member' + summary: The type of Adaptive Card Action thsat caused the error. + isPreview: true + 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''' +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 new file mode 100644 index 00000000..6e3ca5eb --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasecardparameters.yml @@ -0,0 +1,51 @@ +### 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!' + 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. + name: iconAltText + fullName: iconAltText + langs: + - typeScript + type: property + syntax: + content: 'iconAltText?: string;' + return: + 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. + name: iconProperty + fullName: iconProperty + langs: + - typeScript + type: property + syntax: + content: 'iconProperty?: string;' + return: + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!IBaseCardParameters#title:member' + summary: The title to display. + name: title + fullName: title + langs: + - typeScript + type: property + 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..dbca635c --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml @@ -0,0 +1,33 @@ +### 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!' + 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. + name: primaryText + fullName: primaryText + langs: + - typeScript + type: property + syntax: + content: 'primaryText: string;' + return: + 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 new file mode 100644 index 00000000..67944d50 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml @@ -0,0 +1,39 @@ +### 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!' + 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 + name: cardNavigatorState + fullName: cardNavigatorState + langs: + - typeScript + type: property + syntax: + content: 'cardNavigatorState: string[];' + return: + type: + - 'string[]' + - uid: '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters#state:member' + isPreview: true + name: state + fullName: state + langs: + - typeScript + type: property + 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..dc0b095f --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml @@ -0,0 +1,65 @@ +### 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!' + 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. + isPreview: true + name: cachedCardView + fullName: cachedCardView + langs: + - typeScript + type: property + syntax: + content: 'cachedCardView?: () => BaseCardView;' + return: + 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)' + isPreview: true + name: expiryTimeInSeconds + fullName: expiryTimeInSeconds + langs: + - typeScript + type: property + syntax: + content: 'expiryTimeInSeconds: number;' + return: + type: + - number + - uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings#isEnabled:member' + summary: 'Whether cache is enabled. Default: true' + isPreview: true + name: isEnabled + fullName: isEnabled + langs: + - typeScript + type: property + syntax: + content: 'isEnabled: boolean;' + return: + 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 new file mode 100644 index 00000000..5c07c5fb --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/icardaction.yml @@ -0,0 +1,54 @@ +### 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 new file mode 100644 index 00000000..c73a9804 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml @@ -0,0 +1,69 @@ +### 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!' + 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. + name: action + fullName: action + langs: + - typeScript + type: property + syntax: + content: 'action: ICardAction;' + return: + 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. + name: id + fullName: id + langs: + - typeScript + type: property + syntax: + content: 'id?: string;' + return: + 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 + name: style + fullName: style + langs: + - typeScript + type: property + syntax: + content: 'style?: ActionStyle;' + return: + type: + - 'adaptivecards!ActionStyle:class' + - uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#title:member' + summary: Text displayed on the button. + name: title + fullName: title + langs: + - typeScript + type: property + syntax: + content: 'title: string;' + return: + 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 new file mode 100644 index 00000000..a65efca5 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iconfirmationdialog.yml @@ -0,0 +1,35 @@ +### 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 + langs: + - typeScript + type: property + syntax: + content: 'message: string;' + return: + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!IConfirmationDialog#title:member' + name: title + fullName: title + langs: + - typeScript + type: property + 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..da63c8eb --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml @@ -0,0 +1,40 @@ +### 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!' + 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. + name: parameters + fullName: parameters + langs: + - typeScript + type: property + syntax: + content: 'parameters: IExternalLinkParameters;' + return: + 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. + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''ExternalLink'';' + return: + 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 new file mode 100644 index 00000000..b73a6910 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkparameters.yml @@ -0,0 +1,37 @@ +### 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!' + 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. + name: isTeamsDeepLink + fullName: isTeamsDeepLink + langs: + - typeScript + type: property + syntax: + content: 'isTeamsDeepLink?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkParameters#target:member' + summary: The URL of the link. + name: target + fullName: target + langs: + - typeScript + type: property + 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..192bc710 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml @@ -0,0 +1,47 @@ +### 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!' + 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. + name: parameters + fullName: parameters + langs: + - typeScript + type: property + syntax: + content: 'parameters?: IGetLocationActionParameters;' + return: + 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. + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''VivaAction.GetLocation'';' + return: + 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 new file mode 100644 index 00000000..dedc5c15 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml @@ -0,0 +1,72 @@ +### 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!' + 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.' + name: location + fullName: location + langs: + - typeScript + type: property + syntax: + content: 'location?: ILocation;' + return: + 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. + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''VivaAction.GetLocation'';' + return: + type: + - '''VivaAction.GetLocation''' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments~0:complex' + name: Omit- + 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!' + 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. + name: imageUrl + fullName: imageUrl + langs: + - typeScript + type: property + syntax: + content: 'imageUrl: string;' + return: + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardParameters#primaryText:member' + summary: The primary text to display. + name: primaryText + fullName: primaryText + langs: + - typeScript + type: property + syntax: + content: 'primaryText: string;' + return: + 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 new file mode 100644 index 00000000..8857007b --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocation.yml @@ -0,0 +1,63 @@ +### 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!' + 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. + name: accuracy + fullName: accuracy + langs: + - typeScript + type: property + syntax: + content: 'accuracy?: number;' + return: + type: + - number + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#latitude:member' + summary: Latitude of the location. + name: latitude + fullName: latitude + langs: + - typeScript + type: property + syntax: + content: 'latitude: number;' + return: + type: + - number + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#longitude:member' + summary: Longitude of the location. + name: longitude + fullName: longitude + langs: + - typeScript + type: property + syntax: + content: 'longitude: number;' + return: + type: + - number + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocation#timestamp:member' + summary: Timestamp + name: timestamp + fullName: timestamp + langs: + - typeScript + type: property + syntax: + content: 'timestamp?: number;' + return: + type: + - number 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..20b10ccc --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml @@ -0,0 +1,73 @@ +### 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!' + 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 + name: error + fullName: error + langs: + - typeScript + type: property + syntax: + content: |- + error: { + code: 'InternalError' | 'PermissionDenied'; + }; + return: + type: + - |- + { + code: 'InternalError' | 'PermissionDenied'; + } + - uid: '@microsoft/sp-adaptive-card-extension-base!ILocationErrorArguments#type:member' + summary: Indicates this is a Viva Select Location button. + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''VivaAction.GetLocation'';' + return: + 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). + 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!' + 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. + name: description + fullName: description + langs: + - typeScript + type: property + syntax: + content: 'description: string;' + return: + type: + - string + - uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardParameters#primaryText:member' + summary: The primary text to display. + name: primaryText + fullName: primaryText + langs: + - typeScript + type: property + syntax: + content: 'primaryText: string;' + return: + 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 new file mode 100644 index 00000000..a18367bf --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml @@ -0,0 +1,40 @@ +### 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!' + 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 + name: parameters + fullName: parameters + langs: + - typeScript + type: property + syntax: + content: 'parameters: IQuickViewParameters;' + return: + 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. + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''QuickView'';' + return: + 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 new file mode 100644 index 00000000..f9d69609 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewparameters.yml @@ -0,0 +1,24 @@ +### 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!' + 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. + name: view + fullName: view + langs: + - typeScript + type: property + 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..604ef56d --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml @@ -0,0 +1,49 @@ +### 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!' + 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 + isPreview: true + name: parameters + fullName: parameters + langs: + - typeScript + type: property + syntax: + content: 'parameters: ISelectMediaActionParameters;' + return: + 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. + isPreview: true + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''VivaAction.SelectMedia'';' + return: + 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 new file mode 100644 index 00000000..c6821d0d --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml @@ -0,0 +1,95 @@ +### 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!' + 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. + isPreview: true + name: data + fullName: data + langs: + - typeScript + type: property + syntax: + content: 'data: any;' + return: + type: + - any + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#media:member' + summary: media object returned media picker API + isPreview: true + name: media + fullName: media + langs: + - typeScript + type: property + syntax: + content: 'media: ISelectMediaAttachment[];' + return: + 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. + isPreview: true + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''VivaAction.SelectMedia'';' + return: + type: + - '''VivaAction.SelectMedia''' +references: + - uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments~0:complex' + name: Omit- + 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!' + 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. + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''ShowCard'';' + return: + 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 new file mode 100644 index 00000000..8d6fac66 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml @@ -0,0 +1,47 @@ +### 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!' + 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. + name: parameters + fullName: parameters + langs: + - typeScript + type: property + syntax: + content: 'parameters?: IShowLocationActionParameters;' + return: + 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. + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''VivaAction.ShowLocation'';' + return: + 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 new file mode 100644 index 00000000..b533b6f6 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml @@ -0,0 +1,28 @@ +### 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!' + 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.' + name: locationCoordinates + fullName: locationCoordinates + langs: + - typeScript + type: property + syntax: + content: 'locationCoordinates?: ILocation;' + return: + 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 new file mode 100644 index 00000000..118dbf26 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml @@ -0,0 +1,41 @@ +### 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!' + 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. + name: parameters + fullName: parameters + langs: + - typeScript + type: property + syntax: + content: 'parameters?: IShowLocationActionParameters;' + return: + 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. + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''VivaAction.ShowLocation'';' + return: + 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 new file mode 100644 index 00000000..c9351296 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml @@ -0,0 +1,95 @@ +### 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!' + 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 + name: actions + fullName: actions + langs: + - typeScript + type: property + syntax: + content: >- + actions?: (ISubmitAction | IOpenUrlAction | IShowCardAction | ISelectMediaAction | IGetLocationAction | + IShowLocationAction)[]; + return: + 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 new file mode 100644 index 00000000..cf697b89 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml @@ -0,0 +1,47 @@ +### 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!' + 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 + name: data + fullName: data + langs: + - typeScript + type: property + syntax: + content: 'data: any;' + return: + type: + - any + - uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitActionArguments#type:member' + summary: The type of Adaptive Card Action. + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''Submit'';' + return: + 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 new file mode 100644 index 00000000..d6fdcc22 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml @@ -0,0 +1,55 @@ +### 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!' + 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. + name: confirmationDialog + fullName: confirmationDialog + langs: + - typeScript + type: property + syntax: + content: 'confirmationDialog?: IConfirmationDialog;' + return: + 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. + name: parameters + fullName: parameters + langs: + - typeScript + type: property + syntax: + content: 'parameters: ISubmitCardParameters;' + return: + 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. + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''Submit'';' + return: + 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 new file mode 100644 index 00000000..21761718 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardparameters.yml @@ -0,0 +1,10 @@ +### 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 new file mode 100644 index 00000000..e7f23520 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/mediatype.yml @@ -0,0 +1,31 @@ +### 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!' + 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 new file mode 100644 index 00000000..e61538b8 --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml @@ -0,0 +1,38 @@ +### 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. + 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!' + 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. + name: close() + fullName: close() + langs: + - typeScript + type: method + syntax: + content: 'close(): void;' + return: + type: + - void + description: '' +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 new file mode 100644 index 00000000..1a862a9d --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/rendertype.yml @@ -0,0 +1,15 @@ +### 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 new file mode 100644 index 00000000..0a3bd8ed --- /dev/null +++ b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml @@ -0,0 +1,185 @@ +### 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!' + 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 + name: '(constructor)(_handleStackChangedCallback, _handleInitializeCallback)' + fullName: '(constructor)(_handleStackChangedCallback, _handleInitializeCallback)' + langs: + - typeScript + type: constructor + syntax: + content: >- + constructor(_handleStackChangedCallback: (skipUpdate: boolean) => void, _handleInitializeCallback: (view: + BaseView) => void); + parameters: + - id: _handleStackChangedCallback + description: '' + type: + - '(skipUpdate: boolean) => void' + optional: false + - id: _handleInitializeCallback + description: '' + 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' + name: currentId + fullName: currentId + langs: + - typeScript + type: property + syntax: + content: 'get currentId(): string | undefined;' + return: + 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. + 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 + 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. + 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 + optional: false + - id: skipUpdate + description: Whether to skip the update (and re-render) after pushing the new view. + 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' + 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 + 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 + 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. + 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 + optional: false + - id: skipUpdate + description: Whether to skip the update (and re-render) after replacing the current view. + 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: + - 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 b61d8611..94cdbe8c 100644 --- a/SP-Framework/sp-application-base.yml +++ b/SP-Framework/sp-application-base.yml @@ -1,32 +1,32 @@ ### 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: sp-application-base + fullName: '@microsoft/sp-application-base' langs: - 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 228e9ead..1e7028c2 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 @@ -15,22 +15,25 @@ 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 - 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). - name: constructor(serviceScope) - fullName: sp-application-base.ApplicationAccessor.constructor + [BaseApplicationCustomizer.context](xref:@microsoft/sp-application-base!BaseApplicationCustomizer%23context:member). + name: (constructor)(serviceScope) + fullName: (constructor)(serviceScope) langs: - typeScript type: constructor @@ -40,19 +43,37 @@ items: - id: serviceScope description: '' type: - - ServiceScope - - uid: sp-application-base.ApplicationAccessor.navigatedEvent + - '@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 [@microsoft/sp-page-context:PageContext](xref:sp-page-context.PageContext) - has navigated to a new page. + This event fires after the top-level [PageContext](xref:@microsoft/sp-page-context!PageContext:class) has + navigated to a new page. name: navigatedEvent - fullName: sp-application-base.ApplicationAccessor.navigatedEvent + fullName: navigatedEvent langs: - typeScript - type: property + type: event syntax: - content: 'public readonly navigatedEvent: Event;' + content: 'get navigatedEvent(): SPEvent;' return: type: - - Event + - '@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 04df38f0..8ec3c950 100644 --- a/SP-Framework/sp-application-base/applicationcustomizercontext.yml +++ b/SP-Framework/sp-application-base/applicationcustomizercontext.yml @@ -1,42 +1,70 @@ ### 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. + create subclasses that extend the `ApplicationCustomizerContext` class. name: ApplicationCustomizerContext - fullName: sp-application-base.ApplicationCustomizerContext + fullName: ApplicationCustomizerContext langs: - typeScript type: class extends: - - 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.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: sp-application-base.ApplicationCustomizerContext.application + fullName: application langs: - typeScript type: property syntax: - content: 'public readonly application: ApplicationAccessor;' + content: 'get application(): ApplicationAccessor;' return: type: - - ApplicationAccessor - - uid: sp-application-base.ApplicationCustomizerContext.placeholderProvider + - '@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: sp-application-base.ApplicationCustomizerContext.placeholderProvider + fullName: placeholderProvider langs: - typeScript type: property syntax: - content: 'public readonly placeholderProvider: PlaceholderProvider;' + content: 'get placeholderProvider(): PlaceholderProvider;' return: type: - - 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 17800a68..b851e2a5 100644 --- a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml +++ b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml @@ -1,34 +1,35 @@ ### 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. + 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. name: BaseApplicationCustomizer - fullName: sp-application-base.BaseApplicationCustomizer + fullName: BaseApplicationCustomizer langs: - typeScript type: class extends: - - BaseExtension - package: sp-application-base + - '@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: - - sp-application-base.BaseApplicationCustomizer.context - - 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. + - '@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: sp-application-base.BaseApplicationCustomizer.context + fullName: context langs: - typeScript type: property @@ -36,4 +37,48 @@ items: content: 'protected readonly context: ApplicationCustomizerContext;' return: type: - - ApplicationCustomizerContext + - '@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. virtual + 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' + 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/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/iplaceholdercreatecontentoptions.yml b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml index fdbbab7b..18d82c71 100644 --- a/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml +++ b/SP-Framework/sp-application-base/iplaceholdercreatecontentoptions.yml @@ -1,25 +1,26 @@ ### 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%23tryCreateContent:member(1)) + method. name: IPlaceholderCreateContentOptions - fullName: sp-application-base.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 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 @@ -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 d0e0f1de..e08eee41 100644 --- a/SP-Framework/sp-application-base/placeholdercontent.yml +++ b/SP-Framework/sp-application-base/placeholdercontent.yml @@ -1,69 +1,105 @@ ### 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: >- - 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:@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. - 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: sp-application-base.PlaceholderContent + fullName: PlaceholderContent langs: - typeScript type: class - package: sp-application-base + implements: + - '@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.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%23onDispose:member) 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 syntax: - content: 'public dispose(): void;' + content: 'dispose(): void;' return: 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%23onDispose:member) callback. name: domElement - fullName: sp-application-base.PlaceholderContent.domElement + fullName: domElement + langs: + - typeScript + type: property + syntax: + content: 'get domElement(): HTMLDivElement;' + return: + type: + - '!HTMLDivElement:interface' + - uid: '@microsoft/sp-application-base!PlaceholderContent#isDisposed:member' + name: isDisposed + fullName: isDisposed + langs: + - typeScript + type: property + syntax: + content: 'get 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: 'public readonly domElement: HTMLDivElement;' + content: 'get isVisible(): boolean;' return: type: - - HTMLDivElement - - uid: sp-application-base.PlaceholderContent.name + - 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: sp-application-base.PlaceholderContent.name + fullName: name langs: - typeScript type: property syntax: - content: 'public readonly name: PlaceholderName;' + content: 'get name(): PlaceholderName;' return: type: - - 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 e8e1ab9f..f46b2010 100644 --- a/SP-Framework/sp-application-base/placeholdername.yml +++ b/SP-Framework/sp-application-base/placeholdername.yml @@ -1,33 +1,33 @@ ### 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: sp-application-base.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: sp-application-base.PlaceholderName.Bottom + fullName: Bottom langs: - 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: 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 5df6e50d..8a574547 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -1,64 +1,92 @@ ### 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: >- - 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:@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: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. + 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: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: sp-application-base.PlaceholderProvider + fullName: PlaceholderProvider langs: - typeScript type: class - package: sp-application-base + implements: + - '@microsoft/sp-core-library!IDisposable:interface' + package: '@microsoft/sp-application-base!' children: - - sp-application-base.PlaceholderProvider.changedEvent - - 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 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 + 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 langs: - typeScript type: property syntax: - content: 'public readonly changedEvent: Event;' + content: 'get isDisposed(): boolean;' return: type: - - Event - - uid: sp-application-base.PlaceholderProvider.placeholderNames + - boolean + - uid: '@microsoft/sp-application-base!PlaceholderProvider#placeholderNames:member' summary: Returns the names of the currently available placeholders. name: placeholderNames - fullName: sp-application-base.PlaceholderProvider.placeholderNames + fullName: placeholderNames langs: - typeScript type: property syntax: - content: 'public readonly placeholderNames: ReadonlyArray;' + content: 'get 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. @@ -67,22 +95,70 @@ 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(name, options)' langs: - 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 + - '@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: - - PlaceholderName + - '@microsoft/sp-application-base!~PlaceholderName:enum' + optional: false - id: options description: 'Additional options, for example to detect when the placeholder is disposed.' type: - - IPlaceholderCreateContentOptions + - '@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 2d85d124..36cfa4e0 100644 --- a/SP-Framework/sp-component-base.yml +++ b/SP-Framework/sp-component-base.yml @@ -1,21 +1,54 @@ ### 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 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 children: - - sp-component-base.BaseComponent - - sp-component-base.BaseComponentContext + - '@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: 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: '@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 f93ec1a1..dab320f4 100644 --- a/SP-Framework/sp-component-base/basecomponent.yml +++ b/SP-Framework/sp-component-base/basecomponent.yml @@ -1,128 +1,135 @@ ### 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 - create subclasses that extend the BaseComponent class. + create subclasses that extend the `BaseComponent` class. name: BaseComponent - fullName: sp-component-base.BaseComponent + fullName: BaseComponent langs: - typeScript type: class implements: - - IEventObserver - 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 - summary: Returns the component identifier as defined in the component’s associated manifest. + - '@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: sp-component-base.BaseComponent.componentId + fullName: componentId langs: - typeScript type: property syntax: - content: 'public readonly componentId: string;' + content: 'get componentId(): string;' 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 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 syntax: - content: 'protected context: BaseComponentContext;' + content: 'protected context?: BaseComponentContext;' return: type: - - 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. + [BaseComponent.onDispose()](xref:@microsoft/sp-component-base!BaseComponent%23onDispose:member(1)) method. name: dispose() - fullName: sp-component-base.BaseComponent.dispose + fullName: dispose() langs: - typeScript type: method syntax: - content: 'public dispose(): void;' + content: 'dispose(): void;' return: 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 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 syntax: - content: 'public readonly instanceId: string;' + content: 'get instanceId(): string;' 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: sp-component-base.BaseComponent.isDisposed + fullName: isDisposed langs: - typeScript type: property syntax: - content: 'public readonly isDisposed: boolean;' + content: 'get isDisposed(): boolean;' return: type: - boolean - - uid: sp-component-base.BaseComponent.manifest - summary: Provides access to the manifest for the client-side component. + - 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. name: manifest - fullName: sp-component-base.BaseComponent.manifest + fullName: manifest langs: - typeScript type: property syntax: - content: 'public readonly manifest: IClientSideComponentManifest;' + content: 'get 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. + associated resources, cancel any outstanding requests, etc. virtual name: onDispose() - fullName: sp-component-base.BaseComponent.onDispose + fullName: onDispose() langs: - typeScript type: method syntax: - content: '@virtual protected onDispose(): void;' + 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 diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index ce3a9d16..d1afc269 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -1,78 +1,232 @@ ### 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: >- - 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: sp-component-base.BaseComponentContext + fullName: BaseComponentContext langs: - typeScript type: class - package: sp-component-base + implements: + - '@microsoft/sp-core-library!IDisposable:interface' + package: '@microsoft/sp-component-base!' children: - - sp-component-base.BaseComponentContext.instanceId - - sp-component-base.BaseComponentContext.manifest - - sp-component-base.BaseComponentContext.pageContext - - sp-component-base.BaseComponentContext.serviceScope - - uid: sp-component-base.BaseComponentContext.instanceId + - '@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 + name: aadHttpClientFactory + fullName: aadHttpClientFactory + langs: + - typeScript + type: property + syntax: + content: 'get 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: 'get 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: 'get 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: 'get 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: 'get 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: sp-component-base.BaseComponentContext.instanceId + fullName: instanceId langs: - typeScript type: property syntax: - content: 'public readonly instanceId: string;' + content: 'get instanceId(): string;' return: type: - string - - uid: sp-component-base.BaseComponentContext.manifest - summary: Manifest for the client side component. + - 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: 'get isDisposed(): boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-component-base!BaseComponentContext#isServedFromLocalhost:member' + summary: Returns true if the solution is being served from localhost + name: isServedFromLocalhost + fullName: isServedFromLocalhost + langs: + - typeScript + type: property + syntax: + content: 'get isServedFromLocalhost(): boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-component-base!BaseComponentContext#manifest:member' + summary: Manifest for the client-side component. name: manifest - fullName: sp-component-base.BaseComponentContext.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: 'public readonly manifest: IClientSideComponentManifest;' + content: 'get msGraphClientFactory(): MSGraphClientFactory;' return: type: - - IClientSideComponentManifest - - 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. name: pageContext - fullName: sp-component-base.BaseComponentContext.pageContext + fullName: pageContext langs: - typeScript type: property syntax: - content: 'public readonly pageContext: PageContext;' + content: 'get pageContext(): PageContext;' return: type: - - PageContext - - uid: sp-component-base.BaseComponentContext.serviceScope - summary: 'The associated [@microsoft/sp-core-library: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: sp-component-base.BaseComponentContext.serviceScope + fullName: serviceScope + langs: + - typeScript + type: property + syntax: + content: 'get 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: 'public readonly serviceScope: ServiceScope;' + content: 'get spHttpClient(): SPHttpClient;' return: type: - - ServiceScope + - '@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 new file mode 100644 index 00000000..53c3e1c5 --- /dev/null +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -0,0 +1,254 @@ +### 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!' + 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 + syntax: + content: 'dispose(): void;' + return: + type: + - void + description: '' + - uid: '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources:member(1)' + summary: Returns a list with all available Dynamic Data Sources. + name: getAvailableSources() + fullName: getAvailableSources() + langs: + - typeScript + type: method + syntax: + content: 'getAvailableSources(): ReadonlyArray;' + return: + type: + - '@microsoft/sp-component-base!DynamicDataProvider#getAvailableSources~0:complex' + 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: '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. + 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 + 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. + 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 + optional: false + - id: propertyId + description: Id of the property of the source. + type: + - string + optional: false + - id: callback + description: Function to execute when the source updates its data. + 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. + 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 + optional: false + - id: callback + description: Function to execute when the source updates its data. + 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.' + 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 + 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. + 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 + 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. + 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 + optional: false + - id: propertyId + description: Id of the property of the source. + type: + - string + optional: false + - id: callback + description: Function to remove from the registration. Must be the same it was registered with. + 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. + 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 + optional: false + - id: callback + description: Function to remove from the registration. Must be the same it was registered with. + 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 new file mode 100644 index 00000000..0e3727cd --- /dev/null +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -0,0 +1,163 @@ +### YamlMime:UniversalReference +items: + - 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 + 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!' + 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 + syntax: + content: 'dispose(): void;' + return: + type: + - void + description: '' + - uid: '@microsoft/sp-component-base!DynamicDataSourceManager#initializeSource:member(1)' + summary: Initializes the Dynamic Data Source for the component. + 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: + - '@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: + - 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. + 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 + 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. + name: notifySourceChanged() + fullName: notifySourceChanged() + langs: + - typeScript + type: method + syntax: + content: 'notifySourceChanged(): void;' + return: + 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: '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. + 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: + - '@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 new file mode 100644 index 00000000..885a286d --- /dev/null +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -0,0 +1,271 @@ +### 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!' + 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 + syntax: + content: 'constructor(provider: DynamicDataProvider, callback?: () => void);' + parameters: + - id: provider + description: DynamicDataProvider. + 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 + 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.' + name: isDisposed + fullName: isDisposed + langs: + - typeScript + type: property + syntax: + content: 'get 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: 'get 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) + 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 + 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. + name: removeDefaultCallback() + fullName: removeDefaultCallback() + langs: + - typeScript + type: method + syntax: + content: 'removeDefaultCallback(): void;' + return: + 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) + 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 + optional: false + - uid: '@microsoft/sp-component-base!DynamicProperty#setValue:member(1)' + summary: Sets a static value in the DynamicProperty. + 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 + 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. + name: tryGetSource() + fullName: tryGetSource() + langs: + - typeScript + type: method + syntax: + content: 'tryGetSource(): IDynamicDataSource | undefined;' + return: + type: + - '@microsoft/sp-component-base!DynamicProperty#tryGetSource~0:complex' + description: '' + - 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 + 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. + name: tryGetValue() + fullName: tryGetValue() + langs: + - typeScript + type: method + 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)' + 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. + name: tryGetValues() + fullName: 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: '@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) + 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 + 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 new file mode 100644 index 00000000..1b9b7d54 --- /dev/null +++ b/SP-Framework/sp-component-base/icomponentpropertymetadata.yml @@ -0,0 +1,119 @@ +### 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!' + 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 + 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: isHtmlString + langs: + - typeScript + type: property + syntax: + content: 'isHtmlString?: boolean;' + return: + 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. + name: isImageSource + fullName: isImageSource + langs: + - typeScript + type: property + syntax: + content: 'isImageSource?: boolean;' + return: + 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. + name: isLink + fullName: isLink + langs: + - typeScript + type: property + syntax: + content: 'isLink?: boolean;' + return: + 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 + 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: isSearchablePlainText + langs: + - typeScript + type: property + syntax: + content: 'isSearchablePlainText?: boolean;' + return: + 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 + 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. + name: shouldNotPersist + fullName: shouldNotPersist + langs: + - typeScript + type: property + syntax: + content: 'shouldNotPersist?: boolean;' + return: + type: + - boolean diff --git a/SP-Framework/sp-component-base/ifontstyles.yml b/SP-Framework/sp-component-base/ifontstyles.yml new file mode 100644 index 00000000..54c4e77c --- /dev/null +++ b/SP-Framework/sp-component-base/ifontstyles.yml @@ -0,0 +1,143 @@ +### 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!' + fullName: large + summary: Large font style. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'large: IRawStyle;' + return: + type: '' + - name: medium + uid: '@microsoft/sp-component-base!IFontStyles#medium:member' + package: '@microsoft/sp-component-base!' + fullName: medium + summary: Medium font style. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'medium: IRawStyle;' + return: + type: '' + - name: mediumPlus + uid: '@microsoft/sp-component-base!IFontStyles#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: IRawStyle;' + return: + type: '' + - name: mega + uid: '@microsoft/sp-component-base!IFontStyles#mega:member' + package: '@microsoft/sp-component-base!' + fullName: mega + summary: Mega sized font style. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'mega: IRawStyle;' + return: + type: '' + - name: small + uid: '@microsoft/sp-component-base!IFontStyles#small:member' + package: '@microsoft/sp-component-base!' + fullName: small + summary: Small font style. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'small: IRawStyle;' + return: + type: '' + - name: smallPlus + uid: '@microsoft/sp-component-base!IFontStyles#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: IRawStyle;' + return: + type: '' + - name: superLarge + uid: '@microsoft/sp-component-base!IFontStyles#superLarge:member' + package: '@microsoft/sp-component-base!' + fullName: superLarge + summary: Super large font style. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'superLarge: IRawStyle;' + return: + type: '' + - name: tiny + uid: '@microsoft/sp-component-base!IFontStyles#tiny:member' + package: '@microsoft/sp-component-base!' + fullName: tiny + summary: Tiny font style. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'tiny: IRawStyle;' + return: + type: '' + - name: xLarge + uid: '@microsoft/sp-component-base!IFontStyles#xLarge:member' + package: '@microsoft/sp-component-base!' + fullName: xLarge + summary: Extra large font style. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'xLarge: IRawStyle;' + return: + type: '' + - name: xSmall + uid: '@microsoft/sp-component-base!IFontStyles#xSmall:member' + package: '@microsoft/sp-component-base!' + fullName: xSmall + summary: Extra small font style. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'xSmall: IRawStyle;' + return: + type: '' + - name: xxLarge + uid: '@microsoft/sp-component-base!IFontStyles#xxLarge:member' + package: '@microsoft/sp-component-base!' + fullName: xxLarge + summary: Extra extra large font style. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'xxLarge: IRawStyle;' + return: + type: '' diff --git a/SP-Framework/sp-component-base/ipalette.yml b/SP-Framework/sp-component-base/ipalette.yml new file mode 100644 index 00000000..14120567 --- /dev/null +++ b/SP-Framework/sp-component-base/ipalette.yml @@ -0,0 +1,603 @@ +### 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 + summary: Color code for the accent. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'accent: string;' + return: + type: string + - name: black + uid: '@microsoft/sp-component-base!IPalette#black:member' + package: '@microsoft/sp-component-base!' + fullName: black + 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 + - name: blackTranslucent40 + uid: '@microsoft/sp-component-base!IPalette#blackTranslucent40:member' + package: '@microsoft/sp-component-base!' + fullName: blackTranslucent40 + summary: Color code for blackTranslucent40. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'blackTranslucent40: string;' + return: + type: string + - name: blue + uid: '@microsoft/sp-component-base!IPalette#blue:member' + package: '@microsoft/sp-component-base!' + fullName: blue + summary: Color code for blue. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'blue: string;' + return: + type: string + - name: blueDark + uid: '@microsoft/sp-component-base!IPalette#blueDark:member' + package: '@microsoft/sp-component-base!' + fullName: blueDark + summary: Color code for blueDark. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'blueDark: string;' + return: + type: string + - name: blueLight + uid: '@microsoft/sp-component-base!IPalette#blueLight:member' + package: '@microsoft/sp-component-base!' + fullName: blueLight + summary: Color code for blueLight. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'blueLight: string;' + return: + type: string + - name: blueMid + uid: '@microsoft/sp-component-base!IPalette#blueMid:member' + package: '@microsoft/sp-component-base!' + fullName: blueMid + summary: Color code for blueMid. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'blueMid: string;' + return: + type: string + - name: green + uid: '@microsoft/sp-component-base!IPalette#green:member' + package: '@microsoft/sp-component-base!' + fullName: green + summary: Color code for green. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'green: string;' + return: + type: string + - name: greenDark + uid: '@microsoft/sp-component-base!IPalette#greenDark:member' + package: '@microsoft/sp-component-base!' + fullName: greenDark + summary: Color code for greenDark. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'greenDark: string;' + return: + type: string + - name: greenLight + uid: '@microsoft/sp-component-base!IPalette#greenLight:member' + package: '@microsoft/sp-component-base!' + fullName: greenLight + summary: Color code for greenLight. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'greenLight: string;' + return: + type: string + - name: magenta + uid: '@microsoft/sp-component-base!IPalette#magenta:member' + package: '@microsoft/sp-component-base!' + fullName: magenta + summary: Color code for magenta. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'magenta: string;' + return: + type: string + - name: magentaDark + uid: '@microsoft/sp-component-base!IPalette#magentaDark:member' + package: '@microsoft/sp-component-base!' + fullName: magentaDark + summary: Color code for magentaDark. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'magentaDark: string;' + return: + type: string + - name: magentaLight + uid: '@microsoft/sp-component-base!IPalette#magentaLight:member' + package: '@microsoft/sp-component-base!' + fullName: magentaLight + summary: Color code for magentaLight. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'magentaLight: string;' + return: + type: string + - name: neutralDark + uid: '@microsoft/sp-component-base!IPalette#neutralDark:member' + package: '@microsoft/sp-component-base!' + fullName: neutralDark + summary: Color code for neutralDark. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'neutralDark: string;' + return: + type: string + - name: neutralLight + uid: '@microsoft/sp-component-base!IPalette#neutralLight:member' + package: '@microsoft/sp-component-base!' + fullName: neutralLight + summary: Color code for neutralLight. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'neutralLight: string;' + return: + type: string + - name: neutralLighter + uid: '@microsoft/sp-component-base!IPalette#neutralLighter:member' + package: '@microsoft/sp-component-base!' + fullName: neutralLighter + summary: Color code for neutralLighter. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'neutralLighter: string;' + return: + type: string + - name: neutralLighterAlt + uid: '@microsoft/sp-component-base!IPalette#neutralLighterAlt:member' + package: '@microsoft/sp-component-base!' + fullName: neutralLighterAlt + summary: Color code for neutralLighterAlt. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'neutralLighterAlt: string;' + return: + type: string + - name: neutralPrimary + uid: '@microsoft/sp-component-base!IPalette#neutralPrimary:member' + package: '@microsoft/sp-component-base!' + fullName: neutralPrimary + summary: Color code for neutralPrimary. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'neutralPrimary: string;' + return: + type: string + - name: neutralPrimaryAlt + uid: '@microsoft/sp-component-base!IPalette#neutralPrimaryAlt:member' + package: '@microsoft/sp-component-base!' + fullName: neutralPrimaryAlt + summary: Color code for neutralPrimaryAlt. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'neutralPrimaryAlt: string;' + return: + type: string + - name: neutralQuaternary + uid: '@microsoft/sp-component-base!IPalette#neutralQuaternary:member' + package: '@microsoft/sp-component-base!' + fullName: neutralQuaternary + summary: Color code for neutralQuaternary. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'neutralQuaternary: string;' + return: + type: string + - name: neutralQuaternaryAlt + uid: '@microsoft/sp-component-base!IPalette#neutralQuaternaryAlt:member' + package: '@microsoft/sp-component-base!' + fullName: neutralQuaternaryAlt + summary: Color code for neutralQuaternaryAlt. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'neutralQuaternaryAlt: string;' + return: + type: string + - name: neutralSecondary + uid: '@microsoft/sp-component-base!IPalette#neutralSecondary:member' + package: '@microsoft/sp-component-base!' + fullName: neutralSecondary + summary: Color code for neutralSecondary. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'neutralSecondary: string;' + return: + type: string + - name: neutralSecondaryAlt + uid: '@microsoft/sp-component-base!IPalette#neutralSecondaryAlt:member' + package: '@microsoft/sp-component-base!' + fullName: neutralSecondaryAlt + summary: Color code for neutralSecondaryAlt. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'neutralSecondaryAlt: string;' + return: + type: string + - name: neutralTertiary + uid: '@microsoft/sp-component-base!IPalette#neutralTertiary:member' + package: '@microsoft/sp-component-base!' + fullName: neutralTertiary + summary: Color code for neutralTertiary. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'neutralTertiary: string;' + return: + type: string + - name: neutralTertiaryAlt + uid: '@microsoft/sp-component-base!IPalette#neutralTertiaryAlt:member' + package: '@microsoft/sp-component-base!' + fullName: neutralTertiaryAlt + summary: Color code for neutralTertiaryAlt. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'neutralTertiaryAlt: string;' + return: + type: string + - name: orange + uid: '@microsoft/sp-component-base!IPalette#orange:member' + package: '@microsoft/sp-component-base!' + fullName: orange + summary: Color code for orange. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'orange: string;' + return: + type: string + - name: orangeLight + uid: '@microsoft/sp-component-base!IPalette#orangeLight:member' + package: '@microsoft/sp-component-base!' + fullName: orangeLight + summary: Color code for orangeLight. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'orangeLight: string;' + return: + type: string + - name: orangeLighter + uid: '@microsoft/sp-component-base!IPalette#orangeLighter:member' + package: '@microsoft/sp-component-base!' + fullName: orangeLighter + summary: Color code for orangeLighter. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'orangeLighter: string;' + return: + type: string + - name: purple + uid: '@microsoft/sp-component-base!IPalette#purple:member' + package: '@microsoft/sp-component-base!' + fullName: purple + summary: Color code for purple. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'purple: string;' + return: + type: string + - name: purpleDark + uid: '@microsoft/sp-component-base!IPalette#purpleDark:member' + package: '@microsoft/sp-component-base!' + fullName: purpleDark + summary: Color code for purpleDark. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'purpleDark: string;' + return: + type: string + - name: purpleLight + uid: '@microsoft/sp-component-base!IPalette#purpleLight:member' + package: '@microsoft/sp-component-base!' + fullName: purpleLight + summary: Color code for purpleLight. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'purpleLight: string;' + return: + type: string + - name: red + uid: '@microsoft/sp-component-base!IPalette#red:member' + package: '@microsoft/sp-component-base!' + fullName: red + summary: Color code for red. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'red: string;' + return: + type: string + - name: redDark + uid: '@microsoft/sp-component-base!IPalette#redDark:member' + package: '@microsoft/sp-component-base!' + fullName: redDark + summary: Color code for redDark. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'redDark: string;' + return: + type: string + - name: teal + uid: '@microsoft/sp-component-base!IPalette#teal:member' + package: '@microsoft/sp-component-base!' + fullName: teal + summary: Color code for teal. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'teal: string;' + return: + type: string + - name: tealDark + uid: '@microsoft/sp-component-base!IPalette#tealDark:member' + package: '@microsoft/sp-component-base!' + fullName: tealDark + summary: Color code for tealDark. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'tealDark: string;' + return: + type: string + - name: tealLight + uid: '@microsoft/sp-component-base!IPalette#tealLight:member' + package: '@microsoft/sp-component-base!' + fullName: tealLight + summary: Color code for tealLight. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'tealLight: string;' + return: + type: string + - name: themeDark + uid: '@microsoft/sp-component-base!IPalette#themeDark:member' + package: '@microsoft/sp-component-base!' + fullName: themeDark + summary: Color code for themeDark. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'themeDark: string;' + return: + type: string + - name: themeDarkAlt + uid: '@microsoft/sp-component-base!IPalette#themeDarkAlt:member' + package: '@microsoft/sp-component-base!' + fullName: themeDarkAlt + summary: Color code for themeDarkAlt. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'themeDarkAlt: string;' + return: + type: string + - name: themeDarker + uid: '@microsoft/sp-component-base!IPalette#themeDarker:member' + package: '@microsoft/sp-component-base!' + fullName: themeDarker + summary: Color code for themeDarker. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'themeDarker: string;' + return: + type: string + - name: themeLight + uid: '@microsoft/sp-component-base!IPalette#themeLight:member' + package: '@microsoft/sp-component-base!' + fullName: themeLight + summary: Color code for themeLight. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'themeLight: string;' + return: + type: string + - name: themeLighter + uid: '@microsoft/sp-component-base!IPalette#themeLighter:member' + package: '@microsoft/sp-component-base!' + fullName: themeLighter + summary: Color code for themeLighter. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'themeLighter: string;' + return: + type: string + - name: themeLighterAlt + uid: '@microsoft/sp-component-base!IPalette#themeLighterAlt:member' + package: '@microsoft/sp-component-base!' + fullName: themeLighterAlt + summary: Color code for themeLighterAlt. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'themeLighterAlt: string;' + return: + type: string + - name: themePrimary + uid: '@microsoft/sp-component-base!IPalette#themePrimary:member' + package: '@microsoft/sp-component-base!' + fullName: themePrimary + summary: Color code for themePrimary. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'themePrimary: string;' + return: + type: string + - name: themeSecondary + uid: '@microsoft/sp-component-base!IPalette#themeSecondary:member' + package: '@microsoft/sp-component-base!' + fullName: themeSecondary + summary: Color code for themeSecondary. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'themeSecondary: string;' + return: + type: string + - name: themeTertiary + uid: '@microsoft/sp-component-base!IPalette#themeTertiary:member' + package: '@microsoft/sp-component-base!' + fullName: themeTertiary + summary: Color code for themeTertiary. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'themeTertiary: string;' + return: + type: string + - name: white + uid: '@microsoft/sp-component-base!IPalette#white:member' + package: '@microsoft/sp-component-base!' + fullName: 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. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'white: string;' + return: + type: string + - name: whiteTranslucent40 + uid: '@microsoft/sp-component-base!IPalette#whiteTranslucent40:member' + package: '@microsoft/sp-component-base!' + fullName: whiteTranslucent40 + summary: Color code for whiteTranslucent40 + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'whiteTranslucent40: string;' + return: + type: string + - name: yellow + uid: '@microsoft/sp-component-base!IPalette#yellow:member' + package: '@microsoft/sp-component-base!' + fullName: yellow + summary: Color code for yellow. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'yellow: string;' + return: + type: string + - name: yellowLight + uid: '@microsoft/sp-component-base!IPalette#yellowLight:member' + package: '@microsoft/sp-component-base!' + fullName: yellowLight + summary: Color code for yellowLight. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'yellowLight: string;' + return: + type: string diff --git a/SP-Framework/sp-component-base/irawstyle.yml b/SP-Framework/sp-component-base/irawstyle.yml new file mode 100644 index 00000000..3f5b0698 --- /dev/null +++ b/SP-Framework/sp-component-base/irawstyle.yml @@ -0,0 +1,44 @@ +### 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!' + fullName: displayName + summary: Display name for the style. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'displayName?: string;' + return: + type: string + - name: selectors + uid: '@microsoft/sp-component-base!IRawStyle#selectors:member' + package: '@microsoft/sp-component-base!' + fullName: selectors + summary: Custom selectors for the style. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: |- + selectors?: { + [key: string]: IStyle; + }; + return: + type: |- + { + [key: string]: ; + } +extends: '' diff --git a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml new file mode 100644 index 00000000..ec8b6a94 --- /dev/null +++ b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml @@ -0,0 +1,38 @@ +### 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; + 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 new file mode 100644 index 00000000..be8058b0 --- /dev/null +++ b/SP-Framework/sp-component-base/ireadonlytheme.yml @@ -0,0 +1,39 @@ +### 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- + The collection of all semantic slots for colors used in themes. + + + Note: text colors are defined in ISemanticTextColors.ts. + + + \#\# 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. +remarks: '' +isPreview: false +isDeprecated: false +type: interface +properties: + - name: accentButtonBackground + uid: '@microsoft/sp-component-base!ISemanticColors#accentButtonBackground:member' + package: '@microsoft/sp-component-base!' + fullName: accentButtonBackground + summary: Background of an accent button (kicker) + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'accentButtonBackground: string;' + return: + type: string + - name: blockingBackground + uid: '@microsoft/sp-component-base!ISemanticColors#blockingBackground:member' + package: '@microsoft/sp-component-base!' + fullName: blockingBackground + 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 + - name: bodyBackground + uid: '@microsoft/sp-component-base!ISemanticColors#bodyBackground:member' + package: '@microsoft/sp-component-base!' + fullName: bodyBackground + summary: The default color for backgrounds. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'bodyBackground: string;' + return: + type: string + - name: bodyDivider + uid: '@microsoft/sp-component-base!ISemanticColors#bodyDivider:member' + package: '@microsoft/sp-component-base!' + fullName: bodyDivider + summary: >- + Divider lines; e.g. lines that separate sections in a menu, an
+ element. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'bodyDivider: string;' + return: + type: string + - name: bodyFrameBackground + uid: '@microsoft/sp-component-base!ISemanticColors#bodyFrameBackground:member' + package: '@microsoft/sp-component-base!' + fullName: 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 + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'bodyFrameBackground: string;' + return: + 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 + disappear. See also: bodyFrameBackground + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'bodyFrameDivider: string;' + return: + type: string + - name: bodyStandoutBackground + uid: '@microsoft/sp-component-base!ISemanticColors#bodyStandoutBackground:member' + package: '@microsoft/sp-component-base!' + fullName: 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. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'bodyStandoutBackground: string;' + return: + type: string + - name: buttonBackground + uid: '@microsoft/sp-component-base!ISemanticColors#buttonBackground:member' + package: '@microsoft/sp-component-base!' + fullName: buttonBackground + summary: Background of a standard button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'buttonBackground: string;' + return: + type: string + - name: buttonBackgroundChecked + uid: >- + @microsoft/sp-component-base!ISemanticColors#buttonBackgroundChecked:member + package: '@microsoft/sp-component-base!' + fullName: buttonBackgroundChecked + 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 + - name: buttonBackgroundCheckedHovered + uid: >- + @microsoft/sp-component-base!ISemanticColors#buttonBackgroundCheckedHovered:member + package: '@microsoft/sp-component-base!' + fullName: buttonBackgroundCheckedHovered + 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 + - name: buttonBackgroundDisabled + uid: >- + @microsoft/sp-component-base!ISemanticColors#buttonBackgroundDisabled:member + package: '@microsoft/sp-component-base!' + fullName: buttonBackgroundDisabled + summary: Background of a disabled standard button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'buttonBackgroundDisabled: string;' + return: + type: string + - name: buttonBackgroundHovered + uid: >- + @microsoft/sp-component-base!ISemanticColors#buttonBackgroundHovered:member + package: '@microsoft/sp-component-base!' + fullName: buttonBackgroundHovered + summary: Background of a hovered standard button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'buttonBackgroundHovered: string;' + return: + type: string + - name: buttonBackgroundPressed + uid: >- + @microsoft/sp-component-base!ISemanticColors#buttonBackgroundPressed:member + package: '@microsoft/sp-component-base!' + fullName: buttonBackgroundPressed + 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 + - name: buttonBorder + uid: '@microsoft/sp-component-base!ISemanticColors#buttonBorder:member' + package: '@microsoft/sp-component-base!' + fullName: buttonBorder + summary: Border of a standard button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'buttonBorder: string;' + return: + type: string + - name: buttonBorderDisabled + uid: '@microsoft/sp-component-base!ISemanticColors#buttonBorderDisabled:member' + package: '@microsoft/sp-component-base!' + fullName: buttonBorderDisabled + summary: Border of a disabled standard button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'buttonBorderDisabled: string;' + return: + type: string + - name: defaultStateBackground + uid: '@microsoft/sp-component-base!ISemanticColors#defaultStateBackground:member' + package: '@microsoft/sp-component-base!' + fullName: 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. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'defaultStateBackground: string;' + return: + type: string + - name: disabledBackground + uid: '@microsoft/sp-component-base!ISemanticColors#disabledBackground:member' + package: '@microsoft/sp-component-base!' + fullName: disabledBackground + 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 + - name: errorBackground + uid: '@microsoft/sp-component-base!ISemanticColors#errorBackground:member' + package: '@microsoft/sp-component-base!' + fullName: errorBackground + 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 + - name: focusBorder + uid: '@microsoft/sp-component-base!ISemanticColors#focusBorder:member' + package: '@microsoft/sp-component-base!' + fullName: focusBorder + 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 + - name: inputBackground + uid: '@microsoft/sp-component-base!ISemanticColors#inputBackground:member' + package: '@microsoft/sp-component-base!' + fullName: inputBackground + summary: 'The background color of an input, e.g. textbox background.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'inputBackground: string;' + return: + type: string + - name: inputBackgroundChecked + uid: '@microsoft/sp-component-base!ISemanticColors#inputBackgroundChecked:member' + package: '@microsoft/sp-component-base!' + fullName: inputBackgroundChecked + 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 + - name: inputBackgroundCheckedHovered + uid: >- + @microsoft/sp-component-base!ISemanticColors#inputBackgroundCheckedHovered:member + package: '@microsoft/sp-component-base!' + fullName: inputBackgroundCheckedHovered + 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 + - name: inputBorder + uid: '@microsoft/sp-component-base!ISemanticColors#inputBorder:member' + package: '@microsoft/sp-component-base!' + fullName: inputBorder + 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 + - name: inputBorderHovered + uid: '@microsoft/sp-component-base!ISemanticColors#inputBorderHovered:member' + package: '@microsoft/sp-component-base!' + fullName: inputBorderHovered + 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 + - name: inputFocusBorderAlt + uid: '@microsoft/sp-component-base!ISemanticColors#inputFocusBorderAlt:member' + package: '@microsoft/sp-component-base!' + fullName: inputFocusBorderAlt + 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 + - name: inputForegroundChecked + uid: '@microsoft/sp-component-base!ISemanticColors#inputForegroundChecked:member' + package: '@microsoft/sp-component-base!' + fullName: 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. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'inputForegroundChecked: string;' + return: + type: string + - name: listBackground + uid: '@microsoft/sp-component-base!ISemanticColors#listBackground:member' + package: '@microsoft/sp-component-base!' + fullName: listBackground + summary: The background color for the entire list. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'listBackground: string;' + return: + type: string + - name: listHeaderBackgroundHovered + uid: >- + @microsoft/sp-component-base!ISemanticColors#listHeaderBackgroundHovered:member + package: '@microsoft/sp-component-base!' + fullName: listHeaderBackgroundHovered + summary: The background color for a hovered list header. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'listHeaderBackgroundHovered: string;' + return: + type: string + - name: listHeaderBackgroundPressed + uid: >- + @microsoft/sp-component-base!ISemanticColors#listHeaderBackgroundPressed:member + package: '@microsoft/sp-component-base!' + fullName: listHeaderBackgroundPressed + summary: The background color for a pressed list header. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'listHeaderBackgroundPressed: string;' + return: + type: string + - name: listItemBackgroundChecked + uid: >- + @microsoft/sp-component-base!ISemanticColors#listItemBackgroundChecked:member + package: '@microsoft/sp-component-base!' + fullName: listItemBackgroundChecked + summary: The background color of a checked list item. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'listItemBackgroundChecked: string;' + return: + type: string + - name: listItemBackgroundCheckedHovered + uid: >- + @microsoft/sp-component-base!ISemanticColors#listItemBackgroundCheckedHovered:member + package: '@microsoft/sp-component-base!' + fullName: listItemBackgroundCheckedHovered + summary: The background color of a checked and hovered list item. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'listItemBackgroundCheckedHovered: string;' + return: + type: string + - name: listItemBackgroundHovered + uid: >- + @microsoft/sp-component-base!ISemanticColors#listItemBackgroundHovered:member + package: '@microsoft/sp-component-base!' + fullName: listItemBackgroundHovered + summary: The background color of a hovered list item. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'listItemBackgroundHovered: string;' + return: + type: string + - name: listText + uid: '@microsoft/sp-component-base!ISemanticColors#listText:member' + package: '@microsoft/sp-component-base!' + fullName: listText + 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 + - name: menuBackground + uid: '@microsoft/sp-component-base!ISemanticColors#menuBackground:member' + package: '@microsoft/sp-component-base!' + fullName: menuBackground + summary: The background of a menu. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'menuBackground: string;' + return: + type: string + - name: menuDivider + uid: '@microsoft/sp-component-base!ISemanticColors#menuDivider:member' + package: '@microsoft/sp-component-base!' + fullName: menuDivider + summary: The divider between menu items. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'menuDivider: string;' + return: + type: string + - name: menuHeader + uid: '@microsoft/sp-component-base!ISemanticColors#menuHeader:member' + package: '@microsoft/sp-component-base!' + fullName: menuHeader + summary: The headers in menus that denote title of a section. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'menuHeader: string;' + return: + type: string + - name: menuIcon + uid: '@microsoft/sp-component-base!ISemanticColors#menuIcon:member' + package: '@microsoft/sp-component-base!' + fullName: menuIcon + summary: The default colors of icons in menus. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'menuIcon: string;' + return: + type: string + - name: menuItemBackgroundChecked + uid: >- + @microsoft/sp-component-base!ISemanticColors#menuItemBackgroundChecked:member + package: '@microsoft/sp-component-base!' + fullName: menuItemBackgroundChecked + 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 + - name: menuItemBackgroundHovered + uid: >- + @microsoft/sp-component-base!ISemanticColors#menuItemBackgroundHovered:member + package: '@microsoft/sp-component-base!' + fullName: menuItemBackgroundHovered + summary: The background of a hovered menu item. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'menuItemBackgroundHovered: string;' + return: + type: string + - name: menuItemBackgroundPressed + uid: >- + @microsoft/sp-component-base!ISemanticColors#menuItemBackgroundPressed:member + package: '@microsoft/sp-component-base!' + fullName: menuItemBackgroundPressed + summary: The background of a pressed menu item. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'menuItemBackgroundPressed: string;' + return: + type: string + - name: menuItemText + uid: '@microsoft/sp-component-base!ISemanticColors#menuItemText:member' + package: '@microsoft/sp-component-base!' + fullName: menuItemText + summary: The text color of a menu item. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'menuItemText: string;' + return: + type: string + - name: menuItemTextHovered + uid: '@microsoft/sp-component-base!ISemanticColors#menuItemTextHovered:member' + package: '@microsoft/sp-component-base!' + fullName: menuItemTextHovered + summary: The text color of a hovered menu item. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'menuItemTextHovered: string;' + return: + type: string + - name: primaryButtonBackground + uid: >- + @microsoft/sp-component-base!ISemanticColors#primaryButtonBackground:member + package: '@microsoft/sp-component-base!' + fullName: primaryButtonBackground + summary: Background of a primary button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'primaryButtonBackground: string;' + return: + type: string + - name: primaryButtonBackgroundDisabled + uid: >- + @microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundDisabled:member + package: '@microsoft/sp-component-base!' + fullName: primaryButtonBackgroundDisabled + summary: Background of a disabled primary button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'primaryButtonBackgroundDisabled: string;' + return: + type: string + - name: primaryButtonBackgroundHovered + uid: >- + @microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundHovered:member + package: '@microsoft/sp-component-base!' + fullName: primaryButtonBackgroundHovered + summary: Background of a hovered primary button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'primaryButtonBackgroundHovered: string;' + return: + type: string + - name: primaryButtonBackgroundPressed + uid: >- + @microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundPressed:member + package: '@microsoft/sp-component-base!' + fullName: primaryButtonBackgroundPressed + 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 + - name: primaryButtonBorder + uid: '@microsoft/sp-component-base!ISemanticColors#primaryButtonBorder:member' + package: '@microsoft/sp-component-base!' + fullName: primaryButtonBorder + summary: Border of a primary button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'primaryButtonBorder: string;' + return: + type: string + - name: smallInputBorder + uid: '@microsoft/sp-component-base!ISemanticColors#smallInputBorder:member' + package: '@microsoft/sp-component-base!' + fullName: smallInputBorder + 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 + - name: successBackground + uid: '@microsoft/sp-component-base!ISemanticColors#successBackground:member' + package: '@microsoft/sp-component-base!' + fullName: successBackground + summary: Background for success + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'successBackground: string;' + return: + type: string + - name: variantBorder + uid: '@microsoft/sp-component-base!ISemanticColors#variantBorder:member' + package: '@microsoft/sp-component-base!' + fullName: variantBorder + 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 + - name: variantBorderHovered + uid: '@microsoft/sp-component-base!ISemanticColors#variantBorderHovered:member' + package: '@microsoft/sp-component-base!' + fullName: variantBorderHovered + 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 + - name: warningBackground + uid: '@microsoft/sp-component-base!ISemanticColors#warningBackground:member' + package: '@microsoft/sp-component-base!' + fullName: warningBackground + summary: Background for warning messages. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'warningBackground: string;' + return: + type: string + - name: warningHighlight + uid: '@microsoft/sp-component-base!ISemanticColors#warningHighlight:member' + package: '@microsoft/sp-component-base!' + fullName: warningHighlight + summary: Foreground color for warning highlights + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'warningHighlight: string;' + return: + type: string +extends: '' diff --git a/SP-Framework/sp-component-base/isemantictextcolors.yml b/SP-Framework/sp-component-base/isemantictextcolors.yml new file mode 100644 index 00000000..cbe8c7f3 --- /dev/null +++ b/SP-Framework/sp-component-base/isemantictextcolors.yml @@ -0,0 +1,378 @@ +### 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!' + fullName: accentButtonText + summary: Color of text for accent button (kicker) + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'accentButtonText: string;' + return: + type: string + - name: actionLink + uid: '@microsoft/sp-component-base!ISemanticTextColors#actionLink:member' + package: '@microsoft/sp-component-base!' + fullName: actionLink + summary: Neutral colored links and links for action buttons. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'actionLink: string;' + return: + type: string + - name: actionLinkHovered + uid: '@microsoft/sp-component-base!ISemanticTextColors#actionLinkHovered:member' + package: '@microsoft/sp-component-base!' + fullName: actionLinkHovered + summary: Hover state for neutral colored links and links for action buttons. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'actionLinkHovered: string;' + return: + type: string + - name: bodySubtext + uid: '@microsoft/sp-component-base!ISemanticTextColors#bodySubtext:member' + package: '@microsoft/sp-component-base!' + fullName: bodySubtext + summary: 'De-emphasized text; e.g. metadata, captions, placeholder text.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'bodySubtext: string;' + return: + type: string + - name: bodyText + uid: '@microsoft/sp-component-base!ISemanticTextColors#bodyText:member' + package: '@microsoft/sp-component-base!' + fullName: bodyText + summary: The default color for text. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'bodyText: string;' + return: + type: string + - name: bodyTextChecked + uid: '@microsoft/sp-component-base!ISemanticTextColors#bodyTextChecked:member' + package: '@microsoft/sp-component-base!' + fullName: bodyTextChecked + summary: 'Checked text color, e.g. selected menu item text.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'bodyTextChecked: string;' + return: + type: string + - name: buttonText + uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonText:member' + package: '@microsoft/sp-component-base!' + fullName: buttonText + summary: Color of text in a standard button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'buttonText: string;' + return: + type: string + - name: buttonTextChecked + uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextChecked:member' + package: '@microsoft/sp-component-base!' + fullName: buttonTextChecked + summary: Color of text in a checked standard button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'buttonTextChecked: string;' + return: + type: string + - name: buttonTextCheckedHovered + uid: >- + @microsoft/sp-component-base!ISemanticTextColors#buttonTextCheckedHovered:member + package: '@microsoft/sp-component-base!' + fullName: buttonTextCheckedHovered + summary: Color of text in a checked and hovered standard button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'buttonTextCheckedHovered: string;' + return: + type: string + - name: buttonTextDisabled + uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextDisabled:member' + package: '@microsoft/sp-component-base!' + fullName: buttonTextDisabled + summary: Color of text in a disabled standard button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'buttonTextDisabled: string;' + return: + type: string + - name: buttonTextHovered + uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextHovered:member' + package: '@microsoft/sp-component-base!' + fullName: buttonTextHovered + summary: Color of text in a hovered standard button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'buttonTextHovered: string;' + return: + type: string + - name: buttonTextPressed + uid: '@microsoft/sp-component-base!ISemanticTextColors#buttonTextPressed:member' + package: '@microsoft/sp-component-base!' + fullName: buttonTextPressed + 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 + - name: disabledBodySubtext + uid: >- + @microsoft/sp-component-base!ISemanticTextColors#disabledBodySubtext:member + package: '@microsoft/sp-component-base!' + fullName: disabledBodySubtext + summary: >- + Disabled de-emphasized text, for use on the default background + (bodyBackground). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'disabledBodySubtext: string;' + return: + type: string + - name: disabledBodyText + uid: '@microsoft/sp-component-base!ISemanticTextColors#disabledBodyText:member' + package: '@microsoft/sp-component-base!' + fullName: disabledBodyText + summary: >- + The default color for disabled text on the default background + (bodyBackground). + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'disabledBodyText: string;' + return: + type: string + - name: disabledSubtext + uid: '@microsoft/sp-component-base!ISemanticTextColors#disabledSubtext:member' + package: '@microsoft/sp-component-base!' + fullName: disabledSubtext + summary: 'Disabled de-emphasized text, for use on disabledBackground.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'disabledSubtext: string;' + return: + type: string + - name: disabledText + uid: '@microsoft/sp-component-base!ISemanticTextColors#disabledText:member' + package: '@microsoft/sp-component-base!' + fullName: disabledText + 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 + - name: errorText + uid: '@microsoft/sp-component-base!ISemanticTextColors#errorText:member' + package: '@microsoft/sp-component-base!' + fullName: errorText + summary: 'The default color of error text, used on bodyBackground.' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'errorText: string;' + return: + type: string + - name: inputPlaceholderText + uid: >- + @microsoft/sp-component-base!ISemanticTextColors#inputPlaceholderText:member + package: '@microsoft/sp-component-base!' + fullName: inputPlaceholderText + summary: The color of placeholder text. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'inputPlaceholderText: string;' + return: + type: string + - name: inputText + uid: '@microsoft/sp-component-base!ISemanticTextColors#inputText:member' + package: '@microsoft/sp-component-base!' + fullName: inputText + summary: The color of input text. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'inputText: string;' + return: + type: string + - name: inputTextHovered + uid: '@microsoft/sp-component-base!ISemanticTextColors#inputTextHovered:member' + package: '@microsoft/sp-component-base!' + fullName: inputTextHovered + summary: The color of input text on hover. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'inputTextHovered: string;' + return: + type: string + - name: link + uid: '@microsoft/sp-component-base!ISemanticTextColors#link:member' + package: '@microsoft/sp-component-base!' + fullName: link + summary: The color of a link. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'link: string;' + return: + type: string + - name: linkHovered + uid: '@microsoft/sp-component-base!ISemanticTextColors#linkHovered:member' + package: '@microsoft/sp-component-base!' + fullName: linkHovered + 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 + - name: listText + uid: '@microsoft/sp-component-base!ISemanticTextColors#listText:member' + package: '@microsoft/sp-component-base!' + fullName: listText + 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 + - name: listTextColor + uid: '@microsoft/sp-component-base!ISemanticTextColors#listTextColor:member' + package: '@microsoft/sp-component-base!' + fullName: listTextColor + summary: '' + remarks: '' + isPreview: false + isDeprecated: true + customDeprecatedMessage: This slot was incorrectly named. Use listText instead. + syntax: + content: 'listTextColor: string;' + return: + type: string + - name: primaryButtonText + uid: '@microsoft/sp-component-base!ISemanticTextColors#primaryButtonText:member' + package: '@microsoft/sp-component-base!' + fullName: primaryButtonText + summary: Color of text in a primary button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'primaryButtonText: string;' + return: + type: string + - name: primaryButtonTextDisabled + uid: >- + @microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextDisabled:member + package: '@microsoft/sp-component-base!' + fullName: primaryButtonTextDisabled + summary: Color of text in a disabled primary button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'primaryButtonTextDisabled: string;' + return: + type: string + - name: primaryButtonTextHovered + uid: >- + @microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextHovered:member + package: '@microsoft/sp-component-base!' + fullName: primaryButtonTextHovered + summary: Color of text in a hovered primary button + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'primaryButtonTextHovered: string;' + return: + type: string + - name: primaryButtonTextPressed + uid: >- + @microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextPressed:member + package: '@microsoft/sp-component-base!' + fullName: primaryButtonTextPressed + 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 + - name: warningText + uid: '@microsoft/sp-component-base!ISemanticTextColors#warningText:member' + package: '@microsoft/sp-component-base!' + fullName: warningText + summary: >- + The color of text on errorBackground, warningBackground, + blockingBackground, or successBackground. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'warningText: string;' + return: + type: string diff --git a/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml b/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml new file mode 100644 index 00000000..9f850668 --- /dev/null +++ b/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml @@ -0,0 +1,141 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-component-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-component-base!' + children: + - '@microsoft/sp-component-base!ISerializedServerProcessedData#htmlStrings:member' + - '@microsoft/sp-component-base!ISerializedServerProcessedData#imageSources:member' + - '@microsoft/sp-component-base!ISerializedServerProcessedData#links:member' + - '@microsoft/sp-component-base!ISerializedServerProcessedData#searchablePlainTexts:member' + - uid: '@microsoft/sp-component-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-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. + + 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-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. + + 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-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, + 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; + } diff --git a/SP-Framework/sp-component-base/itheme.yml b/SP-Framework/sp-component-base/itheme.yml new file mode 100644 index 00000000..8d3418f1 --- /dev/null +++ b/SP-Framework/sp-component-base/itheme.yml @@ -0,0 +1,17 @@ +### 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 new file mode 100644 index 00000000..fbbc3b73 --- /dev/null +++ b/SP-Framework/sp-component-base/themechangedeventargs.yml @@ -0,0 +1,40 @@ +### 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!' + 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 + 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' diff --git a/SP-Framework/sp-component-base/themeprovider.yml b/SP-Framework/sp-component-base/themeprovider.yml new file mode 100644 index 00000000..1f272711 --- /dev/null +++ b/SP-Framework/sp-component-base/themeprovider.yml @@ -0,0 +1,116 @@ +### 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!' + 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 + syntax: + content: 'constructor(serviceScope: ServiceScope, theme?: ITheme);' + parameters: + - id: serviceScope + description: The current service scope. + type: + - '@microsoft/sp-core-library!ServiceScope:class' + optional: false + - id: theme + description: Theme to provide. + type: + - '@microsoft/sp-component-base!ITheme:interface' + optional: true + - uid: '@microsoft/sp-component-base!ThemeProvider.serviceKey:member' + summary: The service key for ThemeProvider. + name: serviceKey + fullName: serviceKey + langs: + - typeScript + type: property + 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 + 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.' + name: tryGetTheme() + fullName: tryGetTheme() + langs: + - typeScript + type: method + syntax: + content: 'tryGetTheme(): IReadonlyTheme | undefined;' + return: + type: + - '@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 391869b3..de2d8aa0 100644 --- a/SP-Framework/sp-core-library.yml +++ b/SP-Framework/sp-core-library.yml @@ -1,78 +1,84 @@ ### 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 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 children: - - 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.ITimeProvider - - sp-core-library.Log - - sp-core-library.RandomNumberGenerator - - sp-core-library.ServiceKey - - sp-core-library.ServiceScope - - sp-core-library.Session - - 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!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: 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.Event - name: Event - - uid: sp-core-library.EventArgs - name: EventArgs - - uid: sp-core-library.Guid + - uid: '@microsoft/sp-core-library!FormDisplayMode:enum' + name: FormDisplayMode + - 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.IEventObserver - name: IEventObserver - - 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.ITimeProvider + - uid: '@microsoft/sp-core-library!ISPEventObserver:interface' + name: ISPEventObserver + - 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:type' + name: ServiceCreator + - 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.Text - name: Text - - uid: sp-core-library.TimeProvider + - 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: 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 a1283a35..2ff32dec 100644 --- a/SP-Framework/sp-core-library/displaymode.yml +++ b/SP-Framework/sp-core-library/displaymode.yml @@ -1,32 +1,32 @@ ### 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: sp-core-library.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. name: Edit - fullName: sp-core-library.DisplayMode.Edit + fullName: Edit langs: - 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. 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 d329fb05..a1e21053 100644 --- a/SP-Framework/sp-core-library/environment.yml +++ b/SP-Framework/sp-core-library/environment.yml @@ -1,24 +1,27 @@ ### 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: sp-core-library.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: sp-core-library.Environment.type + fullName: type langs: - typeScript type: property syntax: - content: 'public static readonly type: EnvironmentType;' + content: 'static get type(): EnvironmentType;' return: type: - - 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 c827622f..b3036ca7 100644 --- a/SP-Framework/sp-core-library/environmenttype.yml +++ b/SP-Framework/sp-core-library/environmenttype.yml @@ -1,56 +1,64 @@ ### 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: sp-core-library.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. name: ClassicSharePoint - fullName: sp-core-library.EnvironmentType.ClassicSharePoint + fullName: ClassicSharePoint langs: - typeScript type: field - - uid: sp-core-library.EnvironmentType.Local + 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. + deprecated: + content: >- + The local workbench has been removed. Use + [EnvironmentType.SharePoint](xref:@microsoft/sp-core-library!EnvironmentType.SharePoint:member) instead. name: Local - fullName: sp-core-library.EnvironmentType.Local + fullName: Local langs: - typeScript type: field - - uid: sp-core-library.EnvironmentType.SharePoint + 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: sp-core-library.EnvironmentType.SharePoint + fullName: SharePoint langs: - typeScript type: field - - uid: sp-core-library.EnvironmentType.Test + 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: sp-core-library.EnvironmentType.Test + fullName: Test langs: - typeScript type: field + numericValue: '0' diff --git a/SP-Framework/sp-core-library/eventargs.yml b/SP-Framework/sp-core-library/eventargs.yml deleted file mode 100644 index dcac4325..00000000 --- a/SP-Framework/sp-core-library/eventargs.yml +++ /dev/null @@ -1,11 +0,0 @@ -### 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 diff --git a/SP-Framework/sp-core-library/formdisplaymode.yml b/SP-Framework/sp-core-library/formdisplaymode.yml new file mode 100644 index 00000000..740ff6a1 --- /dev/null +++ b/SP-Framework/sp-core-library/formdisplaymode.yml @@ -0,0 +1,34 @@ +### YamlMime:UniversalReference +items: + - uid: '@microsoft/sp-core-library!FormDisplayMode:enum' + name: FormDisplayMode + fullName: FormDisplayMode + langs: + - typeScript + type: enum + package: '@microsoft/sp-core-library!' + 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 c90ac793..99f55cf9 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -1,49 +1,50 @@ ### 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 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. name: Guid - fullName: sp-core-library.Guid + fullName: Guid 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.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: sp-core-library.Guid.empty + fullName: empty langs: - typeScript type: property syntax: - content: 'public static readonly empty: Guid;' + content: 'static readonly empty: Guid;' return: type: - - 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: sp-core-library.Guid.equals + fullName: equals(guid) langs: - typeScript type: method syntax: - content: 'public equals(guid: Guid): boolean;' + content: 'equals(guid: Guid): boolean;' return: type: - boolean @@ -52,18 +53,19 @@ items: - id: guid description: '' type: - - Guid - - uid: sp-core-library.Guid.isValid + - '@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. + 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(guid) langs: - typeScript type: method syntax: - content: 'public static isValid(guid: string | undefined | null): boolean;' + content: 'static isValid(guid: string | undefined | null): boolean;' return: type: - boolean @@ -73,67 +75,115 @@ items: description: The input string. type: - string | undefined | null - - uid: sp-core-library.Guid.newGuid + 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. name: newGuid(randomNumberGenerator) - fullName: sp-core-library.Guid.newGuid + fullName: newGuid(randomNumberGenerator) langs: - typeScript type: method syntax: - content: 'public static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;' + content: 'static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;' return: type: - - Guid + - '@microsoft/sp-core-library!default:class' description: A new unique Guid object parameters: - id: randomNumberGenerator description: '' type: - - IRandomNumberGenerator - - uid: sp-core-library.Guid.parse + - '@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: 'd5369f3b-bd7a-412a-9c0f-7f0650bb5489' - '{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}' '/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)' + 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: sp-core-library.Guid.parse + fullName: parse(guidString) langs: - typeScript type: method syntax: - content: 'public static parse(guidString: string | undefined | null): Guid;' + content: 'static parse(guidString: string | undefined | null): Guid;' return: type: - - 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.tryParse + optional: false + - 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: 'd5369f3b-bd7a-412a-9c0f-7f0650bb5489' - '{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}' '/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)' + 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: sp-core-library.Guid.tryParse + fullName: tryParse(guid) langs: - 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 + - '@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 + 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 a13b61dd..41872079 100644 --- a/SP-Framework/sp-core-library/idisposable.yml +++ b/SP-Framework/sp-core-library/idisposable.yml @@ -1,22 +1,22 @@ ### 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 - fullName: sp-core-library.IDisposable + fullName: IDisposable 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() - fullName: sp-core-library.IDisposable.dispose + fullName: dispose() langs: - typeScript type: method @@ -26,13 +26,13 @@ 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. 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..01d02eaf 100644 --- a/SP-Framework/sp-core-library/irandomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/irandomnumbergenerator.yml @@ -1,24 +1,27 @@ ### 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: sp-core-library.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: 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..e4cfacf8 100644 --- a/SP-Framework/sp-core-library/iservicecollection.yml +++ b/SP-Framework/sp-core-library/iservicecollection.yml @@ -1,27 +1,23 @@ ### 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: >- 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 - 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. - deprecated: - content: >- - 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 @@ -29,4 +25,7 @@ items: content: 'readonly serviceScope: ServiceScope;' return: type: - - 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/ieventobserver.yml b/SP-Framework/sp-core-library/ispeventobserver.yml similarity index 52% rename from SP-Framework/sp-core-library/ieventobserver.yml rename to SP-Framework/sp-core-library/ispeventobserver.yml index f7091e00..98e52327 100644 --- a/SP-Framework/sp-core-library/ieventobserver.yml +++ b/SP-Framework/sp-core-library/ispeventobserver.yml @@ -1,30 +1,32 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.IEventObserver + - uid: '@microsoft/sp-core-library!ISPEventObserver:interface' summary: >- - Used with the [Event](xref:sp-core-library.Event) 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: >- - IEventObserver is an abstraction of the key features that a component must have in order to subscribe to a + 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: IEventObserver - fullName: sp-core-library.IEventObserver + name: ISPEventObserver + fullName: ISPEventObserver langs: - typeScript type: interface extends: - - 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.IEventObserver.componentId - - sp-core-library.IEventObserver.instanceId - - uid: sp-core-library.IEventObserver.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 - fullName: sp-core-library.IEventObserver.componentId + fullName: componentId langs: - typeScript type: property @@ -33,11 +35,11 @@ items: return: type: - string - - uid: sp-core-library.IEventObserver.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 - fullName: sp-core-library.IEventObserver.instanceId + fullName: instanceId langs: - typeScript type: property @@ -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 e30fcc70..6cf5fea3 100644 --- a/SP-Framework/sp-core-library/itimeprovider.yml +++ b/SP-Framework/sp-core-library/itimeprovider.yml @@ -1,25 +1,27 @@ ### 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: sp-core-library.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: sp-core-library.ITimeProvider.getDate + fullName: getDate() langs: - typeScript type: method @@ -27,12 +29,12 @@ 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: sp-core-library.ITimeProvider.getTimestamp + fullName: getTimestamp() langs: - typeScript type: method @@ -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 5eba0943..3bb158c4 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 @@ -8,25 +8,25 @@ 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 - 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: sp-core-library.Log.error + fullName: 'error(source, error, scope)' langs: - 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 @@ -38,25 +38,28 @@ items: the logged error. If the source's length is more than 20, only the first 20 characters are kept. type: - string + optional: false - id: error description: the error to be logged type: - - Error + - '!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: - - ServiceScope - - uid: sp-core-library.Log.info + - '@microsoft/sp-core-library!default:class' + optional: true + - uid: '@microsoft/sp-core-library!Log.info:member(1)' summary: Logs a general informational message. name: 'info(source, message, scope)' - fullName: sp-core-library.Log.info + fullName: 'info(source, message, scope)' langs: - 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 @@ -68,25 +71,28 @@ items: for the logged message. If the source's length is more than 20, only the first 20 characters are kept. 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 + 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: - - ServiceScope - - uid: sp-core-library.Log.verbose + - '@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. name: 'verbose(source, message, scope)' - fullName: sp-core-library.Log.verbose + fullName: 'verbose(source, message, scope)' langs: - 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 @@ -98,25 +104,28 @@ items: for the logged message. If the source's length is more than 20, only the first 20 characters are kept. 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 + 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: - - ServiceScope - - uid: sp-core-library.Log.warn + - '@microsoft/sp-core-library!default:class' + optional: true + - uid: '@microsoft/sp-core-library!Log.warn:member(1)' summary: Logs a warning. name: 'warn(source, message, scope)' - fullName: sp-core-library.Log.warn + fullName: 'warn(source, message, scope)' langs: - 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 @@ -128,13 +137,21 @@ items: for the logged message. If the source's length is more than 20, only the first 20 characters are kept. 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 + 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: - - ServiceScope + - '@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 a6c87fbd..c7edc187 100644 --- a/SP-Framework/sp-core-library/randomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/randomnumbergenerator.yml @@ -1,25 +1,26 @@ ### 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: sp-core-library.RandomNumberGenerator + fullName: RandomNumberGenerator langs: - typeScript type: class implements: - - 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 - summary: 'Constructs a new instance of the [RandomNumberGenerator](xref:sp-core-library.RandomNumberGenerator) class' - name: constructor(serviceScope) - fullName: 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) langs: - typeScript type: constructor @@ -29,29 +30,49 @@ items: - id: serviceScope description: '' type: - - ServiceScope - - uid: sp-core-library.RandomNumberGenerator.generate + - '@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().' name: generate() - fullName: sp-core-library.RandomNumberGenerator.generate + fullName: generate() langs: - typeScript type: method syntax: - content: 'public generate(): number;' + content: 'generate(): number;' return: 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: sp-core-library.RandomNumberGenerator.serviceKey + fullName: serviceKey langs: - typeScript type: property syntax: - content: 'public static readonly serviceKey: ServiceKey;' + 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/servicecreator.yml b/SP-Framework/sp-core-library/servicecreator.yml new file mode 100644 index 00000000..8d647750 --- /dev/null +++ b/SP-Framework/sp-core-library/servicecreator.yml @@ -0,0 +1,29 @@ +### 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 19717585..c2049be9 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -1,101 +1,122 @@ ### 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%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: sp-core-library.ServiceKey + fullName: ServiceKey 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: sp-core-library.ServiceKey.create + fullName: 'create(name, serviceClass)' langs: - 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): TKey; + }): ServiceKey; return: type: - - ServiceKey + - '@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: - - '{ new (serviceScope: ServiceScope); }' - - uid: sp-core-library.ServiceKey.createCustom + - '@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: sp-core-library.ServiceKey.createCustom + fullName: 'createCustom(name, defaultCreator)' langs: - 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 + - '@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: - - ServiceCreator - - uid: sp-core-library.ServiceKey.defaultCreator + - '@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. name: defaultCreator - fullName: sp-core-library.ServiceKey.defaultCreator + fullName: defaultCreator langs: - typeScript type: property syntax: - content: 'public readonly defaultCreator: ServiceCreator;' + content: 'readonly defaultCreator: ServiceCreator;' return: 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. + - '@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: sp-core-library.ServiceKey.id + fullName: id langs: - typeScript type: property syntax: - content: 'public readonly id: string;' + content: 'readonly id: string;' 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 @@ -103,14 +124,76 @@ 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%23id:member) is used wherever a lookup key is needed. name: name - fullName: sp-core-library.ServiceKey.name + fullName: name langs: - typeScript type: property syntax: - content: 'public readonly name: string;' + 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: diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index 9af28b4a..f2b952cc 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 @@ -45,34 +45,50 @@ 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 - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - 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.consume + - '@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' + 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. name: consume(serviceKey) - fullName: sp-core-library.ServiceScope.consume + fullName: consume(serviceKey) langs: - typeScript type: method syntax: - content: 'public consume < T >(serviceKey: ServiceKey): T;' + content: 'consume(serviceKey: ServiceKey): T;' return: type: - T @@ -81,18 +97,24 @@ 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' + 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(). name: 'createAndProvide(serviceKey, simpleServiceClass)' - fullName: sp-core-library.ServiceScope.createAndProvide + fullName: 'createAndProvide(serviceKey, simpleServiceClass)' langs: - 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; + }): T; return: type: - T @@ -101,22 +123,26 @@ 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' + optional: false - id: simpleServiceClass description: the TypeScript class to be constructed type: - - '{ new (serviceScope: ServiceScope); }' - - uid: sp-core-library.ServiceScope.createDefaultAndProvide + - '@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(). name: createDefaultAndProvide(serviceKey) - fullName: sp-core-library.ServiceScope.createDefaultAndProvide + fullName: createDefaultAndProvide(serviceKey) langs: - typeScript type: method syntax: - content: 'public createDefaultAndProvide < T >(serviceKey: ServiceKey): T;' + content: 'createDefaultAndProvide(serviceKey: ServiceKey): T;' return: type: - T @@ -125,8 +151,11 @@ 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' + 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 @@ -139,41 +168,41 @@ 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 syntax: - content: 'public finish(): void;' + content: 'finish(): void;' return: 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: sp-core-library.ServiceScope.getParent + fullName: getParent() langs: - typeScript type: method syntax: - content: 'public getParent(): ServiceScope | undefined;' + 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 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(serviceKey, service)' langs: - typeScript type: method syntax: - content: 'public provide < T >(serviceKey: ServiceKey, service: T): T;' + content: 'provide(serviceKey: ServiceKey, service: T): T;' return: type: - T @@ -182,44 +211,50 @@ 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' + optional: false - id: service description: the service instance that is being registered type: - T - - uid: sp-core-library.ServiceScope.startNewChild + 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. name: startNewChild() - fullName: sp-core-library.ServiceScope.startNewChild + fullName: startNewChild() langs: - typeScript type: method syntax: - content: 'public startNewChild(): ServiceScope;' + content: 'startNewChild(): ServiceScope;' return: type: - - 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. name: startNewRoot() - fullName: sp-core-library.ServiceScope.startNewRoot + fullName: startNewRoot() langs: - typeScript type: method syntax: - content: 'public static startNewRoot(): ServiceScope;' + content: 'static startNewRoot(): ServiceScope;' return: type: - - 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%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 @@ -231,12 +266,12 @@ 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(callback) langs: - typeScript type: method syntax: - content: 'public whenFinished(callback: () => void): void;' + content: 'whenFinished(callback: () => void): void;' return: type: - void @@ -246,3 +281,86 @@ items: description: A block of code that needs to call ServiceScope.consume() 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 f10605ec..4962d0c7 100644 --- a/SP-Framework/sp-core-library/session.yml +++ b/SP-Framework/sp-core-library/session.yml @@ -1,17 +1,18 @@ ### 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: sp-core-library.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.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 @@ -20,21 +21,33 @@ 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 syntax: - content: 'public static readonly applicationId: Guid;' + content: 'static get applicationId(): Guid;' return: type: - - Guid - - uid: sp-core-library.Session.pageId + - '@microsoft/sp-core-library!default:class' + - uid: '@microsoft/sp-core-library!Session.clientSideApplicationId:member' + summary: The id of the currently running application + name: clientSideApplicationId + fullName: clientSideApplicationId + langs: + - typeScript + type: property + syntax: + content: 'static get clientSideApplicationId(): string;' + return: + 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 - [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 @@ -46,12 +59,15 @@ 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 syntax: - content: 'public static readonly pageId: Guid;' + content: 'static get pageId(): Guid;' return: type: - - 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/event.yml b/SP-Framework/sp-core-library/spevent.yml similarity index 56% rename from SP-Framework/sp-core-library/event.yml rename to SP-Framework/sp-core-library/spevent.yml index fc5346f3..8c753e53 100644 --- a/SP-Framework/sp-core-library/event.yml +++ b/SP-Framework/sp-core-library/spevent.yml @@ -1,49 +1,49 @@ ### YamlMime:UniversalReference items: - - uid: sp-core-library.Event + - uid: '@microsoft/sp-core-library!SPEvent:class' 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. + 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: Event - fullName: sp-core-library.Event + + + 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: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.Event.add - - sp-core-library.Event.remove - - uid: sp-core-library.Event.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 - IEventObserver interface, a web part or extension can pass itself as the observer. This will cause the event + 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.Event.add + fullName: 'add(observer, eventHandler)' langs: - typeScript type: method syntax: - content: 'public add(observer: IEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' + content: 'add(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' return: type: - void @@ -55,21 +55,23 @@ 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: - - IEventObserver + - '@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' - - uid: sp-core-library.Event.remove + 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.' name: 'remove(observer, eventHandler)' - fullName: sp-core-library.Event.remove + fullName: 'remove(observer, eventHandler)' langs: - typeScript type: method syntax: - content: 'public remove(observer: IEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' + content: 'remove(observer: ISPEventObserver, eventHandler: (eventArgs: TEventArgs) => void): void;' return: type: - void @@ -78,8 +80,13 @@ items: - id: observer description: This must be the same observer that was passed to the add() function. type: - - IEventObserver + - '@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' + 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 new file mode 100644 index 00000000..cdd91e77 --- /dev/null +++ b/SP-Framework/sp-core-library/speventargs.yml @@ -0,0 +1,11 @@ +### 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.yml b/SP-Framework/sp-core-library/text.yml index dbc2fa1b..98a6feb9 100644 --- a/SP-Framework/sp-core-library/text.yml +++ b/SP-Framework/sp-core-library/text.yml @@ -1,45 +1,72 @@ -### YamlMime:UniversalReference -items: - - uid: sp-core-library.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.' - name: Text - fullName: sp-core-library.Text - langs: - - typeScript - type: class - package: sp-core-library - children: - - sp-core-library.Text.format - - 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. - - - Usage example: - - - Text.format("hello {0}!", "world") will return "hello world!" - name: 'format(s, values)' - fullName: sp-core-library.Text.format - langs: - - typeScript - type: method - syntax: - content: 'public static format(s: string, ...values: any[]): string;' - return: - type: - - string - description: '' - parameters: - - id: s - description: '' - type: - - string - - id: values - description: '' - type: - - 'any[]' +### 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/text_2.yml b/SP-Framework/sp-core-library/text_2.yml new file mode 100644 index 00000000..35ae2eba --- /dev/null +++ b/SP-Framework/sp-core-library/text_2.yml @@ -0,0 +1,78 @@ +### 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!' + 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 + 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: unknown[]): string;' + return: + type: + - string + description: '' + parameters: + - id: s + description: '' + type: + - string + optional: false + - id: values + description: '' + 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.' + 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 + optional: false + - id: searchValue + description: The value to search for + type: + - string + optional: false + - id: replaceValue + description: The replacement text + type: + - string + optional: false diff --git a/SP-Framework/sp-core-library/timeprovider.yml b/SP-Framework/sp-core-library/timeprovider.yml index be440ce1..f6f25c68 100644 --- a/SP-Framework/sp-core-library/timeprovider.yml +++ b/SP-Framework/sp-core-library/timeprovider.yml @@ -1,26 +1,26 @@ ### 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: sp-core-library.TimeProvider + fullName: TimeProvider langs: - typeScript type: class implements: - - 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 - summary: 'Constructs a new instance of the [TimeProvider](xref:sp-core-library.TimeProvider) class' - name: constructor(serviceScope) - fullName: 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) langs: - typeScript type: constructor @@ -30,42 +30,64 @@ items: - id: serviceScope description: '' type: - - ServiceScope - - uid: sp-core-library.TimeProvider.getDate + - '@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.' name: getDate() - fullName: sp-core-library.TimeProvider.getDate + fullName: getDate() langs: - typeScript type: method syntax: - content: 'public getDate(): Date;' + 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: sp-core-library.TimeProvider.getTimestamp + fullName: getTimestamp() langs: - typeScript type: method syntax: - content: 'public getTimestamp(): number;' + content: 'getTimestamp(): number;' return: 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: sp-core-library.TimeProvider.serviceKey + fullName: serviceKey langs: - typeScript type: property syntax: - content: 'public static readonly serviceKey: ServiceKey;' + 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 e3445ace..2df5047c 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 @@ -17,23 +17,19 @@ 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 - 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 - 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: 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) langs: - typeScript type: constructor @@ -44,21 +40,28 @@ items: description: '' type: - string - - uid: sp-core-library.UrlQueryParameterCollection.getValue + 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: 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. + 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: sp-core-library.UrlQueryParameterCollection.getValue + fullName: getValue(param) langs: - typeScript type: method syntax: - content: 'public getValue(param: string): string | undefined;' + content: 'getValue(param: string): string | undefined;' return: type: - string | undefined @@ -68,21 +71,28 @@ items: description: the case insensitive key for the desired query parameter value. type: - string - - uid: sp-core-library.UrlQueryParameterCollection.getValues + 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: 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. + 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: sp-core-library.UrlQueryParameterCollection.getValues + fullName: getValues(param) langs: - typeScript type: method syntax: - content: 'public getValues(param: string): (string | undefined)[] | undefined;' + content: 'getValues(param: string): (string | undefined)[] | undefined;' return: type: - '(string | undefined)[] | undefined' @@ -92,3 +102,4 @@ items: description: the case insensitive key for the desired query parameter value. type: - string + optional: false diff --git a/SP-Framework/sp-core-library/validate.yml b/SP-Framework/sp-core-library/validate.yml index 013e82c6..ce5d9825 100644 --- a/SP-Framework/sp-core-library/validate.yml +++ b/SP-Framework/sp-core-library/validate.yml @@ -1,30 +1,31 @@ ### 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 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 - package: sp-core-library + package: '@microsoft/sp-core-library!' children: - - sp-core-library.Validate.isNonemptyString - - 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: sp-core-library.Validate.isNonemptyString + fullName: 'isNonemptyString(value, variableName)' langs: - 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 @@ -34,19 +35,45 @@ items: description: the value to check type: - string | undefined | null + optional: false - id: variableName description: 'the program variable name, which will be mentioned in the error message' type: - string - - uid: sp-core-library.Validate.isNotNullOrUndefined + optional: false + - 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' + optional: false + - id: className + description: 'the class name, which will be mentioned in the error message' + 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. name: 'isNotNullOrUndefined(value, variableName)' - fullName: sp-core-library.Validate.isNotNullOrUndefined + fullName: 'isNotNullOrUndefined(value, variableName)' langs: - typeScript type: method syntax: - content: 'public static isNotNullOrUndefined(value: any, variableName: string): void;' + content: 'static isNotNullOrUndefined(value: any, variableName: string): void;' return: type: - void @@ -56,19 +83,21 @@ items: description: the value to check type: - any + optional: false - id: variableName description: 'the program variable name, which will be mentioned in the error message' type: - string - - uid: sp-core-library.Validate.isTrue + optional: false + - 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: sp-core-library.Validate.isTrue + fullName: 'isTrue(value, variableName)' langs: - 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 @@ -78,7 +107,12 @@ items: description: the value to check type: - boolean | undefined | null + optional: false - id: variableName description: 'the program variable name, which will be mentioned in the error message' 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 1dd4dbb2..b7a548a8 100644 --- a/SP-Framework/sp-core-library/version.yml +++ b/SP-Framework/sp-core-library/version.yml @@ -1,42 +1,43 @@ ### 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, 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 + fullName: Version 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.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: sp-core-library.Version.compare + fullName: 'compare(v1, v2)' langs: - typeScript type: method syntax: - content: 'public static compare(v1: Version, v2: Version): number;' + content: 'static compare(v1: Version, v2: Version): number;' return: type: - number @@ -47,26 +48,31 @@ items: - id: v1 description: The first version class for comparison type: - - Version + - '@microsoft/sp-core-library!default:class' + optional: false - id: v2 description: The second version class for comparison type: - - Version - - uid: sp-core-library.Version.equals + - '@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: >- + 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 + fullName: equals(compareWith) langs: - typeScript type: method syntax: - content: 'public equals(compareWith: Version): boolean;' + content: 'equals(compareWith: Version): boolean;' return: type: - boolean @@ -75,20 +81,25 @@ items: - id: compareWith description: The version to compare with type: - - Version - - uid: sp-core-library.Version.greaterThan + - '@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: - 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 + fullName: greaterThan(compareWith) langs: - typeScript type: method syntax: - content: 'public greaterThan(compareWith: Version): boolean;' + content: 'greaterThan(compareWith: Version): boolean;' return: type: - boolean @@ -97,16 +108,17 @@ items: - id: compareWith description: The version to compare with type: - - Version - - uid: sp-core-library.Version.isValid + - '@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. name: isValid(versionString) - fullName: sp-core-library.Version.isValid + fullName: isValid(versionString) langs: - typeScript type: method syntax: - content: 'public static isValid(versionString: string | undefined | null): boolean;' + content: 'static isValid(versionString: string | undefined | null): boolean;' return: type: - boolean @@ -116,21 +128,25 @@ items: description: The version string type: - string | undefined | null - - uid: sp-core-library.Version.lessThan + 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: >- + 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 + fullName: lessThan(compareWith) langs: - typeScript type: method syntax: - content: 'public lessThan(compareWith: Version): boolean;' + content: 'lessThan(compareWith: Version): boolean;' return: type: - boolean @@ -139,84 +155,86 @@ items: - id: compareWith description: The version to compare with type: - - Version - - uid: sp-core-library.Version.major + - '@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: sp-core-library.Version.major + fullName: major langs: - typeScript type: property syntax: - content: 'public readonly major: number;' + content: 'get major(): number;' 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 compatible with previous releases. name: minor - fullName: sp-core-library.Version.minor + fullName: minor langs: - typeScript type: property syntax: - content: 'public readonly minor: number;' + content: 'get minor(): number;' 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: sp-core-library.Version.parse + fullName: parse(versionString) langs: - typeScript type: method syntax: - content: 'public static parse(versionString: string | undefined | null): Version;' + content: 'static parse(versionString: string | undefined | null): Version;' return: type: - - 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 + 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: sp-core-library.Version.patch + fullName: patch langs: - typeScript type: property syntax: - content: 'public readonly patch: number | undefined;' + content: 'get patch(): number | undefined;' 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 version numbers. name: revision - fullName: sp-core-library.Version.revision + fullName: revision langs: - typeScript type: property syntax: - content: 'public readonly revision: number | undefined;' + content: 'get revision(): number | undefined;' 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. @@ -228,15 +246,24 @@ 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 + fullName: satisfies(compareWith) langs: - typeScript type: method syntax: - content: 'public satisfies(compareWith: Version): boolean;' + content: 'satisfies(compareWith: Version): boolean;' return: type: - boolean @@ -245,24 +272,54 @@ items: - id: compareWith description: The version to compare with type: - - Version - - uid: sp-core-library.Version.tryParse + - '@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. + 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: sp-core-library.Version.tryParse + fullName: tryParse(versionString) langs: - 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 + - '@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 + 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 new file mode 100644 index 00000000..106d66bc --- /dev/null +++ b/SP-Framework/sp-diagnostics.yml @@ -0,0 +1,39 @@ +### 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 1583228a..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: 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.SecondaryDialogProvider + - '@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.SecondaryDialogProvider - name: SecondaryDialogProvider + - 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 86e1e7db..e2a5ad0c 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. @@ -11,40 +11,53 @@ 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 + fullName: BaseDialog 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 - summary: Constructor for the BaseDialog class. + - '@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 + 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. - name: constructor(config) - fullName: sp-dialog.BaseDialog.constructor + + + 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 @@ -52,143 +65,134 @@ 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. - isPreview: true + - '@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: sp-dialog.BaseDialog.close + fullName: close() langs: - typeScript type: method syntax: - content: 'public close(): Promise;' + 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 - 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. - isPreview: true + - 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. name: domElement - fullName: sp-dialog.BaseDialog.domElement + fullName: domElement langs: - typeScript type: property syntax: - content: 'protected readonly domElement: HTMLElement;' + content: 'protected get domElement(): HTMLElement;' return: 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. - isPreview: true + - '!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: sp-dialog.BaseDialog.isHidden + fullName: isHidden langs: - typeScript type: property syntax: - content: 'public readonly isHidden: boolean;' + content: 'get isHidden(): boolean;' 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. - isPreview: true name: isOpen - fullName: sp-dialog.BaseDialog.isOpen + fullName: isOpen langs: - typeScript type: property syntax: - content: 'public readonly isOpen: boolean;' + content: 'get isOpen(): boolean;' 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. - isPreview: true name: isSecondary - fullName: sp-dialog.BaseDialog.isSecondary + fullName: isSecondary langs: - typeScript type: property syntax: - content: 'public readonly isSecondary: boolean;' + content: 'get isSecondary(): boolean;' return: 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. - isPreview: true + - 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: sp-dialog.BaseDialog.onAfterClose + fullName: onAfterClose() langs: - typeScript type: method syntax: - content: '@virtual protected onAfterClose(): void;' + content: 'protected onAfterClose(): void;' return: 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. - remarks: All resource allocations in onBeforeOpen() should be properly disposed in onAfterClose() to a avoid memory leak. - isPreview: true + 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. name: onBeforeOpen() - fullName: sp-dialog.BaseDialog.onBeforeOpen + fullName: onBeforeOpen() langs: - typeScript type: method syntax: - content: '@virtual protected onBeforeOpen(): Promise;' + 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 - 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. + 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 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 is a bad user experience practice. - isPreview: true name: render() - fullName: sp-dialog.BaseDialog.render + fullName: render() langs: - typeScript type: method @@ -198,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. @@ -206,35 +210,79 @@ 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 + fullName: secondaryDialogProvider langs: - typeScript type: property syntax: - content: 'public readonly secondaryDialogProvider: SecondaryDialogProvider | undefined;' + content: 'get secondaryDialogProvider(): ISecondaryDialogProvider | undefined;' return: type: - - SecondaryDialogProvider | 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. - isPreview: true name: show(options) - fullName: sp-dialog.BaseDialog.show + fullName: show(options) langs: - typeScript type: method syntax: - content: 'public show(options?: IDialogShowOptions): Promise;' + 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: - - IDialogShowOptions + - '@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 a789e3c3..0fb30fa6 100644 --- a/SP-Framework/sp-dialog/dialog.yml +++ b/SP-Framework/sp-dialog/dialog.yml @@ -1,18 +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. - isPreview: true name: Dialog - fullName: sp-dialog.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. @@ -20,28 +19,29 @@ 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 + fullName: 'alert(message, options)' langs: - typeScript type: method syntax: - content: 'public static alert(message: string, options?: IAlertOptions): Promise;' + content: 'static alert(message: string, options?: IAlertOptions): Promise;' return: type: - - Promise + - '@microsoft/sp-dialog!Dialog.alert~0:complex' description: '' parameters: - id: message description: The message to alert type: - string + optional: false - id: options description: '' type: - - IAlertOptions - - uid: sp-dialog.Dialog.prompt + - '@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. @@ -49,24 +49,48 @@ 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 + fullName: 'prompt(message, options)' langs: - typeScript type: method syntax: - content: 'public static prompt(message: string, options?: IPromptOptions): Promise;' + 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 description: The message for prompt dialog type: - string + optional: false - id: options description: '' type: - - IPromptOptions + - '@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 21fc8eef..b1e708f8 100644 --- a/SP-Framework/sp-dialog/ialertoptions.yml +++ b/SP-Framework/sp-dialog/ialertoptions.yml @@ -1,13 +1,17 @@ ### YamlMime:UniversalReference items: - - uid: sp-dialog.IAlertOptions + - uid: '@microsoft/sp-dialog!IAlertOptions:interface' summary: Options for showing an alert dialog - isPreview: true name: IAlertOptions - fullName: sp-dialog.IAlertOptions + fullName: IAlertOptions langs: - typeScript type: interface extends: - - 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 3655d71a..f5ad498b 100644 --- a/SP-Framework/sp-dialog/idialogconfiguration.yml +++ b/SP-Framework/sp-dialog/idialogconfiguration.yml @@ -1,21 +1,19 @@ ### YamlMime:UniversalReference items: - - uid: sp-dialog.IDialogConfiguration + - uid: '@microsoft/sp-dialog!IDialogConfiguration:interface' summary: The interface for dialog configuration - isPreview: true name: IDialogConfiguration - fullName: sp-dialog.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). - isPreview: true 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 9ec3de1d..9f9d920b 100644 --- a/SP-Framework/sp-dialog/idialogshowoptions.yml +++ b/SP-Framework/sp-dialog/idialogshowoptions.yml @@ -1,17 +1,16 @@ ### YamlMime:UniversalReference items: - - uid: sp-dialog.IDialogShowOptions + - uid: '@microsoft/sp-dialog!IDialogShowOptions:interface' summary: Options for showing a dialog - isPreview: true name: IDialogShowOptions - fullName: sp-dialog.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 @@ -19,9 +18,8 @@ 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 + fullName: confirmOpen langs: - typeScript type: property diff --git a/SP-Framework/sp-dialog/ipromptoptions.yml b/SP-Framework/sp-dialog/ipromptoptions.yml index 4c114848..99101ec1 100644 --- a/SP-Framework/sp-dialog/ipromptoptions.yml +++ b/SP-Framework/sp-dialog/ipromptoptions.yml @@ -1,23 +1,23 @@ ### YamlMime:UniversalReference items: - - uid: sp-dialog.IPromptOptions + - uid: '@microsoft/sp-dialog!IPromptOptions:interface' summary: Options for showing a prompt dialog - isPreview: true name: IPromptOptions - fullName: sp-dialog.IPromptOptions + fullName: IPromptOptions langs: - typeScript type: interface extends: - - 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 - isPreview: true name: defaultValue - fullName: sp-dialog.IPromptOptions.defaultValue + fullName: defaultValue langs: - typeScript type: property @@ -26,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 new file mode 100644 index 00000000..4f76a2fe --- /dev/null +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -0,0 +1,146 @@ +### 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. + name: ISecondaryDialogProvider + fullName: ISecondaryDialogProvider + langs: + - typeScript + type: interface + 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 + syntax: + content: 'alert(message: string, options?: IAlertOptions): Promise;' + return: + type: + - '@microsoft/sp-dialog!ISecondaryDialogProvider#alert~0:complex' + description: '' + parameters: + - id: message + description: '' + type: + - string + optional: false + - id: options + description: >- + Dialog showing options. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for + more information. + 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. + 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 + 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: + - '@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. + 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: + - '@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: + - '@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-dialog/secondarydialogprovider.yml b/SP-Framework/sp-dialog/secondarydialogprovider.yml deleted file mode 100644 index e44e63e7..00000000 --- a/SP-Framework/sp-dialog/secondarydialogprovider.yml +++ /dev/null @@ -1,104 +0,0 @@ -### 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: 'public 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: 'public 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: 'public 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 new file mode 100644 index 00000000..6de54b03 --- /dev/null +++ b/SP-Framework/sp-dynamic-data.yml @@ -0,0 +1,44 @@ +### 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 new file mode 100644 index 00000000..f3fba494 --- /dev/null +++ b/SP-Framework/sp-dynamic-data/dynamicdatareference.yml @@ -0,0 +1,85 @@ +### 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` + name: DynamicDataReference + fullName: DynamicDataReference + langs: + - typeScript + type: class + 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 + syntax: + content: 'constructor(reference: string);' + parameters: + - id: reference + description: '' + type: + - string + optional: false + - uid: '@microsoft/sp-dynamic-data!DynamicDataReference#property:member' + summary: Returns the referred property of the Dynamic Data. + name: property + fullName: property + langs: + - typeScript + type: property + syntax: + content: 'get 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 + fullName: propertyPath + langs: + - typeScript + type: property + syntax: + content: 'get 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 + fullName: reference + langs: + - typeScript + type: property + syntax: + content: 'get 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 + fullName: sourceId + langs: + - typeScript + type: property + 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 new file mode 100644 index 00000000..b761577d --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml @@ -0,0 +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 + 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 + 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 + fullName: sampleValue + langs: + - typeScript + type: property + syntax: + content: 'sampleValue: any;' + 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 new file mode 100644 index 00000000..6a4ca1dc --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -0,0 +1,159 @@ +### 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!' + 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. + isPreview: true + name: allowedEvents() + fullName: allowedEvents() + langs: + - typeScript + type: method + syntax: + content: 'allowedEvents?(): ReadonlyArray;' + return: + type: + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#allowedEvents~0:complex' + 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) + 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 + optional: false + - uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions:member(1)' + summary: Returns all the property definitions that the DataSource will provide. + name: getPropertyDefinitions() + fullName: getPropertyDefinitions() + langs: + - typeScript + type: method + syntax: + content: 'getPropertyDefinitions(): ReadonlyArray;' + return: + type: + - '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions~0:complex' + description: '' + - 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) + fullName: getPropertyValue(propertyId) + langs: + - typeScript + type: method + syntax: + content: 'getPropertyValue(propertyId: string): any;' + return: + type: + - any + description: '' + parameters: + - id: propertyId + description: '' + 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. + 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 + optional: false + - id: data + description: Data to be sent to the dynamic data source. + 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 new file mode 100644 index 00000000..5ff4f010 --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml @@ -0,0 +1,43 @@ +### 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. + isPreview: true + name: IDynamicDataEventDefinition + fullName: IDynamicDataEventDefinition + langs: + - typeScript + type: interface + 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' + summary: 'User-friendly, localized description of the event.' + isPreview: true + name: description + fullName: description + langs: + - typeScript + type: property + syntax: + content: 'description?: string;' + return: + type: + - string + - uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#name:member' + summary: Event name + isPreview: true + name: name + fullName: 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 new file mode 100644 index 00000000..3c584110 --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml @@ -0,0 +1,35 @@ +### 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!' + 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 + syntax: + content: 'id: string;' + 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 new file mode 100644 index 00000000..d3c87555 --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertymetadata.yml @@ -0,0 +1,41 @@ +### 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!' + 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 + 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 + fullName: title + langs: + - typeScript + type: property + 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 new file mode 100644 index 00000000..09a560ac --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml @@ -0,0 +1,33 @@ +### 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!' + 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 + 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 diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml new file mode 100644 index 00000000..1772c297 --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml @@ -0,0 +1,80 @@ +### 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. + + + 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: 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 new file mode 100644 index 00000000..435f5685 --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -0,0 +1,296 @@ +### 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!' + 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. + isPreview: true + name: allowedEventsAsync() + fullName: allowedEventsAsync() + langs: + - typeScript + type: method + syntax: + content: 'allowedEventsAsync?(): Promise>;' + return: + type: + - '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync~0:complex' + 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) + 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 + 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. + 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 + 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. + 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: + - '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions~0:complex' + 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() + 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: + - 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 + 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. + 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 + 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: + - 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. + 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 + optional: false + - id: data + description: Data to be sent to the dynamic data source. + 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 new file mode 100644 index 00000000..3aa4bd14 --- /dev/null +++ b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml @@ -0,0 +1,85 @@ +### 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!' + 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 + 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 + fullName: componentId + langs: + - typeScript + type: property + 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 + fullName: description + langs: + - typeScript + type: property + syntax: + content: 'description?: string;' + return: + 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. + name: instanceId + fullName: instanceId + langs: + - typeScript + type: property + 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 + fullName: title + langs: + - typeScript + type: property + syntax: + content: 'title: string;' + return: + type: + - string diff --git a/SP-Framework/sp-extension-base.yml b/SP-Framework/sp-extension-base.yml index 8129a8fa..95d38cc3 100644 --- a/SP-Framework/sp-extension-base.yml +++ b/SP-Framework/sp-extension-base.yml @@ -1,17 +1,17 @@ ### 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: sp-extension-base + fullName: '@microsoft/sp-extension-base' langs: - 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 9f2c491d..5edddc9c 100644 --- a/SP-Framework/sp-extension-base/baseextension.yml +++ b/SP-Framework/sp-extension-base/baseextension.yml @@ -1,30 +1,32 @@ ### 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 - create subclasses that extend the BaseExtension class. + create subclasses that extend the `BaseExtension` class. name: BaseExtension - fullName: sp-extension-base.BaseExtension + fullName: BaseExtension langs: - typeScript type: class extends: - - 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 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 @@ -32,33 +34,47 @@ items: content: 'protected readonly context: ExtensionContext;' return: type: - - ExtensionContext - - uid: sp-extension-base.BaseExtension.onInit - summary: This event method is called when the client-side extension is first activated on the page. + - '@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: sp-extension-base.BaseExtension.onInit + fullName: onInit() langs: - typeScript type: method syntax: - content: '@virtual protected onInit(): Promise;' + 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 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 syntax: - content: 'protected readonly properties: TProperties;' + content: 'protected get 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: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 c4b6b0d7..1c7a0a04 100644 --- a/SP-Framework/sp-extension-base/extensioncontext.yml +++ b/SP-Framework/sp-extension-base/extensioncontext.yml @@ -1,55 +1,20 @@ ### 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 - create subclasses that extend the ExtensionContext class. + create subclasses that extend the `ExtensionContext` class. name: ExtensionContext - fullName: sp-extension-base.ExtensionContext + fullName: ExtensionContext langs: - typeScript type: class 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 + - '@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 cc7713be..729b7fa7 100644 --- a/SP-Framework/sp-http.yml +++ b/SP-Framework/sp-http.yml @@ -1,99 +1,144 @@ ### 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 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 children: - - sp-http.GraphHttpClient - - sp-http.GraphHttpClientConfiguration - - sp-http.GraphHttpClientResponse - - sp-http.HttpClient - - sp-http.HttpClientConfiguration - - sp-http.HttpClientResponse - - sp-http.IGraphHttpClientConfiguration - - sp-http.IGraphHttpClientConfigurations - - 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.ODataVersion - - sp-http.SPHttpClient - - sp-http.SPHttpClientBatch - - sp-http.SPHttpClientBatchConfiguration - - sp-http.SPHttpClientCommonConfiguration - - sp-http.SPHttpClientConfiguration - - sp-http.SPHttpClientResponse - - sp-http.SPHttpHeader + - '@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: sp-http.GraphHttpClient - name: GraphHttpClient - - uid: sp-http.GraphHttpClientConfiguration - name: GraphHttpClientConfiguration - - uid: sp-http.GraphHttpClientResponse - name: GraphHttpClientResponse - - uid: sp-http.HttpClient + - 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: 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.IGraphHttpClientConfiguration - name: IGraphHttpClientConfiguration - - uid: sp-http.IGraphHttpClientConfigurations - name: IGraphHttpClientConfigurations - - uid: sp-http.IGraphHttpClientOptions - name: IGraphHttpClientOptions - - uid: sp-http.IHttpClientConfiguration + - 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: 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.ODataVersion + - 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: 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: '@microsoft/sp-http!TokenAcquisitionEventArgs:class' + name: TokenAcquisitionEventArgs diff --git a/SP-Framework/sp-http/aadhttpclient.yml b/SP-Framework/sp-http/aadhttpclient.yml new file mode 100644 index 00000000..902172ab --- /dev/null +++ b/SP-Framework/sp-http/aadhttpclient.yml @@ -0,0 +1,216 @@ +### 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. + name: AadHttpClient + fullName: AadHttpClient + langs: + - typeScript + type: class + 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 + 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: + - '@microsoft/sp-core-library!ServiceScope:class' + optional: false + - id: resourceEndpoint + description: '' + type: + - string + optional: false + - id: options + description: Configuration options for the request to get an access token. + 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. + name: configurations + fullName: configurations + langs: + - typeScript + type: property + syntax: + content: 'static readonly configurations: IAadHttpClientConfigurations;' + return: + 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/ + 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 + optional: false + - 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' + optional: false + - id: options + description: Additional options that affect the request. + 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".' + 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 + optional: false + - 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' + optional: false + - id: options + description: Additional options that affect the request. + 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".' + 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 + optional: false + - 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' + optional: false + - id: options + description: Additional options that affect the request. + 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 new file mode 100644 index 00000000..357c2c98 --- /dev/null +++ b/SP-Framework/sp-http/aadhttpclientconfiguration.yml @@ -0,0 +1,83 @@ +### 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!' + 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 + syntax: + content: 'constructor(flags: IAadHttpClientConfiguration, overrideFlags?: IAadHttpClientConfiguration);' + parameters: + - id: flags + description: '' + type: + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + optional: false + - id: overrideFlags + description: '' + type: + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + optional: true + - uid: '@microsoft/sp-http!AadHttpClientConfiguration#flags:member' + name: flags + fullName: flags + langs: + - typeScript + type: property + syntax: + content: 'protected flags: IAadHttpClientConfiguration;' + return: + type: + - '@microsoft/sp-http!IAadHttpClientConfiguration:interface' + - uid: '@microsoft/sp-http!AadHttpClientConfiguration#overrideWith:member(1)' + name: overrideWith(sourceFlags) + fullName: overrideWith(sourceFlags) + langs: + - typeScript + type: method + syntax: + content: |- + /** @override */ + overrideWith(sourceFlags: IAadHttpClientConfiguration): AadHttpClientConfiguration; + return: + type: + - '@microsoft/sp-http!default:class' + description: '' + parameters: + - id: sourceFlags + description: '' + 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 new file mode 100644 index 00000000..ef255a16 --- /dev/null +++ b/SP-Framework/sp-http/aadhttpclientfactory.yml @@ -0,0 +1,80 @@ +### 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!' + 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 + 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 + 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: + - '@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 new file mode 100644 index 00000000..530bcb47 --- /dev/null +++ b/SP-Framework/sp-http/aadhttpclientresponse.yml @@ -0,0 +1,43 @@ +### 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!' + children: + - '@microsoft/sp-http!AadHttpClientResponse:constructor(1)' + - uid: '@microsoft/sp-http!AadHttpClientResponse:constructor(1)' + summary: Constructs a new instance of the `AadHttpClientResponse` class + 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:interface' + optional: false + - id: tokenFetchRequestTime + description: '' + 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 new file mode 100644 index 00000000..c4f839ed --- /dev/null +++ b/SP-Framework/sp-http/aadtokenprovider.yml @@ -0,0 +1,120 @@ +### 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. + + + 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!' + 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. + 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 + 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 + optional: true + - uid: '@microsoft/sp-http!AadTokenProvider#onBeforeRedirectEvent:member' + summary: Notifies the developer before a full page redirect occurs. + name: onBeforeRedirectEvent + fullName: onBeforeRedirectEvent + langs: + - typeScript + type: event + syntax: + content: 'readonly onBeforeRedirectEvent: SPEvent;' + return: + 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. + name: tokenAcquisitionEvent + fullName: tokenAcquisitionEvent + langs: + - typeScript + type: event + syntax: + content: 'get tokenAcquisitionEvent(): SPEvent;' + return: + 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 new file mode 100644 index 00000000..9b9dce4c --- /dev/null +++ b/SP-Framework/sp-http/aadtokenproviderfactory.yml @@ -0,0 +1,69 @@ +### 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!' + 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 + syntax: + content: 'getTokenProvider(): Promise;' + return: + 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 new file mode 100644 index 00000000..2a31e3bb --- /dev/null +++ b/SP-Framework/sp-http/beforeredirecteventargs.yml @@ -0,0 +1,65 @@ +### 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!' + 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 + 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 + optional: false + - id: cancel + description: '' + 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. + name: cancel + fullName: cancel + langs: + - typeScript + type: property + syntax: + content: 'cancel: () => void;' + return: + type: + - () => void + - uid: '@microsoft/sp-http!BeforeRedirectEventArgs#redirectUrl:member' + summary: The url of the page to redirect to if automatic redirect is cancelled + name: redirectUrl + fullName: redirectUrl + langs: + - typeScript + type: property + syntax: + content: 'redirectUrl: string;' + return: + 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 new file mode 100644 index 00000000..7ab05dd3 --- /dev/null +++ b/SP-Framework/sp-http/digestcache.yml @@ -0,0 +1,175 @@ +### 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) + name: DigestCache + fullName: DigestCache + langs: + - typeScript + type: class + implements: + - '@microsoft/sp-http!IDigestCache:interface' + 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 + syntax: + content: 'constructor(serviceScope: ServiceScope);' + parameters: + - id: serviceScope + description: '' + 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. + 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 + 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 + 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 + optional: false + - uid: '@microsoft/sp-http!DigestCache#clearAllDigests:member(1)' + summary: Clears all values from the cache. + name: clearAllDigests() + fullName: clearAllDigests() + langs: + - typeScript + type: method + syntax: + content: 'clearAllDigests(): void;' + return: + 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) + 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 + 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. + 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 + 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: + - '@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/graphhttpclient.yml b/SP-Framework/sp-http/graphhttpclient.yml deleted file mode 100644 index 94953c78..00000000 --- a/SP-Framework/sp-http/graphhttpclient.yml +++ /dev/null @@ -1,175 +0,0 @@ -### 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: >- - 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 - 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 superceded by the MSGraphClient class. - name: constructor(serviceScope) - fullName: sp-http.GraphHttpClient.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 superceded by the MSGraphClient class. - isPreview: true - name: configurations - fullName: sp-http.GraphHttpClient.configurations - langs: - - typeScript - type: property - syntax: - content: 'public 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 superceded by the MSGraphClient class. - isPreview: true - name: 'fetch(url, configuration, options)' - fullName: sp-http.GraphHttpClient.fetch - langs: - - typeScript - type: method - syntax: - content: "public fetch(url: string,\r\n configuration: GraphHttpClientConfiguration,\r\n 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 superceded by the MSGraphClient class. - isPreview: true - name: 'get(url, configuration, options)' - fullName: sp-http.GraphHttpClient.get - langs: - - typeScript - type: method - syntax: - content: "public get(url: string, configuration: GraphHttpClientConfiguration,\r\n 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 superceded by the MSGraphClient class. - isPreview: true - name: 'post(url, configuration, options)' - fullName: sp-http.GraphHttpClient.post - langs: - - typeScript - type: method - syntax: - content: "public post(url: string, configuration: GraphHttpClientConfiguration,\r\n 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 superceded by the MSGraphClient class. - isPreview: true - name: serviceKey - fullName: sp-http.GraphHttpClient.serviceKey - langs: - - typeScript - type: property - syntax: - content: 'public static readonly serviceKey: ServiceKey;' - return: - type: - - ServiceKey diff --git a/SP-Framework/sp-http/graphhttpclientconfiguration.yml b/SP-Framework/sp-http/graphhttpclientconfiguration.yml deleted file mode 100644 index ec5d4395..00000000 --- a/SP-Framework/sp-http/graphhttpclientconfiguration.yml +++ /dev/null @@ -1,62 +0,0 @@ -### 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: sp-http.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: sp-http.GraphHttpClientConfiguration.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: sp-http.GraphHttpClientConfiguration.flags - langs: - - typeScript - type: property - syntax: - content: 'protected flags: IGraphHttpClientConfiguration;' - return: - type: - - IGraphHttpClientConfiguration diff --git a/SP-Framework/sp-http/graphhttpclientresponse.yml b/SP-Framework/sp-http/graphhttpclientresponse.yml deleted file mode 100644 index a8c41bfd..00000000 --- a/SP-Framework/sp-http/graphhttpclientresponse.yml +++ /dev/null @@ -1,52 +0,0 @@ -### YamlMime:UniversalReference -items: - - uid: sp-http.GraphHttpClientResponse - summary: The Response subclass returned by methods such as GraphHttpClient.fetch(). - remarks: >- - 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: sp-http.GraphHttpClientResponse - langs: - - typeScript - type: class - extends: - - HttpClientResponse - package: sp-http - children: - - sp-http.GraphHttpClientResponse.constructor - - sp-http.GraphHttpClientResponse.clone - - 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: sp-http.GraphHttpClientResponse.constructor - langs: - - typeScript - type: constructor - syntax: - content: 'public 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: sp-http.GraphHttpClientResponse.clone - langs: - - typeScript - type: method - syntax: - content: '@override public clone(): GraphHttpClientResponse;' - return: - type: - - GraphHttpClientResponse - description: '' diff --git a/SP-Framework/sp-http/graphrequest.yml b/SP-Framework/sp-http/graphrequest.yml new file mode 100644 index 00000000..8496e2c0 --- /dev/null +++ b/SP-Framework/sp-http/graphrequest.yml @@ -0,0 +1,688 @@ +### 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 + langs: + - typeScript + type: property + syntax: + content: |- + _headers: { + [key: string]: string | number; + }; + return: + type: + - |- + { + [key: string]: string | number; + } + - uid: '@microsoft/sp-http!GraphRequest#_responseType:member' + name: _responseType + fullName: _responseType + langs: + - typeScript + type: property + syntax: + content: '_responseType: string;' + return: + type: + - string + - uid: '@microsoft/sp-http!GraphRequest#buildFullUrl:member(1)' + name: buildFullUrl() + fullName: buildFullUrl() + langs: + - typeScript + type: method + syntax: + content: 'buildFullUrl(): string;' + return: + 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)' + fullName: 'constructor(config, path)' + 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: + - '@microsoft/microsoft-graph-client!Options:interface' + optional: false + - id: path + description: '' + type: + - string + optional: false + - uid: '@microsoft/sp-http!GraphRequest#count:member(1)' + name: count(count) + fullName: count(count) + langs: + - typeScript + type: method + syntax: + content: 'count(count: boolean): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' + parameters: + - id: count + description: '' + type: + - boolean + optional: false + - uid: '@microsoft/sp-http!GraphRequest#create:member(1)' + name: 'create(content, callback)' + fullName: 'create(content, callback)' + 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 + optional: false + - id: callback + description: '' + type: + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + optional: true + - uid: '@microsoft/sp-http!GraphRequest#del:member(1)' + name: del(callback) + fullName: del(callback) + 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: + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + optional: true + - uid: '@microsoft/sp-http!GraphRequest#delete:member(1)' + name: delete(callback) + fullName: delete(callback) + 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: + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + optional: true + - uid: '@microsoft/sp-http!GraphRequest#expand:member(1)' + name: expand(properties) + fullName: expand(properties) + 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[]' + optional: false + - uid: '@microsoft/sp-http!GraphRequest#filter:member(1)' + name: filter(filterStr) + fullName: filter(filterStr) + langs: + - typeScript + type: method + syntax: + content: 'filter(filterStr: string): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' + parameters: + - id: filterStr + description: '' + type: + - string + optional: false + - uid: '@microsoft/sp-http!GraphRequest#get:member(1)' + name: get(callback) + fullName: get(callback) + 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: + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + optional: true + - uid: '@microsoft/sp-http!GraphRequest#getStream:member(1)' + name: getStream(callback) + fullName: getStream(callback) + langs: + - typeScript + type: method + syntax: + content: 'getStream(callback: GraphRequestCallback): void;' + return: + type: + - void + description: '' + parameters: + - id: callback + description: '' + 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)' + langs: + - typeScript + type: method + syntax: + content: 'header(headerKey: string, headerValue: string): this;' + return: + type: + - this + description: '' + parameters: + - id: headerKey + description: '' + type: + - string + optional: false + - id: headerValue + description: '' + type: + - string + optional: false + - uid: '@microsoft/sp-http!GraphRequest#headers:member(1)' + name: headers(headers) + fullName: headers(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; + } + optional: false + - uid: '@microsoft/sp-http!GraphRequest#orderby:member(1)' + name: orderby(properties) + fullName: orderby(properties) + 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[]' + optional: false + - uid: '@microsoft/sp-http!GraphRequest#parsePath:member(1)' + name: parsePath(rawPath) + fullName: parsePath(rawPath) + langs: + - typeScript + type: method + syntax: + content: 'parsePath(rawPath: string): void;' + return: + type: + - void + description: '' + parameters: + - id: rawPath + description: '' + type: + - string + optional: false + - uid: '@microsoft/sp-http!GraphRequest#patch:member(1)' + name: 'patch(content, callback)' + fullName: 'patch(content, callback)' + 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 + optional: false + - id: callback + description: '' + 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)' + 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 + optional: false + - id: callback + description: '' + 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)' + 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 + optional: false + - id: callback + description: '' + 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)' + langs: + - typeScript + type: method + syntax: + content: 'putStream(stream: any, callback: GraphRequestCallback): void;' + return: + type: + - void + description: '' + parameters: + - id: stream + description: '' + type: + - any + optional: false + - id: callback + description: '' + type: + - '@microsoft/microsoft-graph-client!GraphRequestCallback:interface' + optional: false + - uid: '@microsoft/sp-http!GraphRequest#query:member(1)' + name: query(queryDictionaryOrString) + fullName: query(queryDictionaryOrString) + 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; + } + optional: false + - uid: '@microsoft/sp-http!GraphRequest#responseType:member(1)' + name: responseType(responseType) + fullName: responseType(responseType) + langs: + - typeScript + type: method + syntax: + content: 'responseType(responseType: string): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' + parameters: + - id: responseType + description: '' + type: + - string + optional: false + - uid: '@microsoft/sp-http!GraphRequest#select:member(1)' + name: select(properties) + fullName: select(properties) + 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[]' + optional: false + - uid: '@microsoft/sp-http!GraphRequest#skip:member(1)' + name: skip(n) + fullName: skip(n) + langs: + - typeScript + type: method + syntax: + content: 'skip(n: number): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' + parameters: + - id: 'n' + description: '' + type: + - number + optional: false + - uid: '@microsoft/sp-http!GraphRequest#skipToken:member(1)' + name: skipToken(token) + fullName: skipToken(token) + langs: + - typeScript + type: method + syntax: + content: 'skipToken(token: string): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' + parameters: + - id: token + description: '' + type: + - string + optional: false + - uid: '@microsoft/sp-http!GraphRequest#top:member(1)' + name: top(n) + fullName: top(n) + langs: + - typeScript + type: method + syntax: + content: 'top(n: number): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' + parameters: + - id: 'n' + description: '' + type: + - number + optional: false + - uid: '@microsoft/sp-http!GraphRequest#update:member(1)' + name: 'update(content, callback)' + fullName: 'update(content, callback)' + 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 + optional: false + - id: callback + description: '' + 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: + - '@microsoft/microsoft-graph-client!URLComponents:interface' + - uid: '@microsoft/sp-http!GraphRequest#version:member(1)' + name: version(v) + fullName: version(v) + langs: + - typeScript + type: method + syntax: + content: 'version(v: string): IGraphRequest;' + return: + type: + - '@microsoft/sp-http!IGraphRequest:interface' + description: '' + parameters: + - id: v + 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 fe3d2351..7b85eeca 100644 --- a/SP-Framework/sp-http/httpclient.yml +++ b/SP-Framework/sp-http/httpclient.yml @@ -1,25 +1,27 @@ ### 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: sp-http.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 - summary: 'Constructs a new instance of the [HttpClient](xref:sp-http.HttpClient) class' - name: constructor(serviceScope) - fullName: 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) langs: - typeScript type: constructor @@ -29,116 +31,209 @@ items: - id: serviceScope description: '' type: - - ServiceScope - - uid: sp-http.HttpClient.configurations + - '@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. name: configurations - fullName: sp-http.HttpClient.configurations + fullName: configurations langs: - typeScript type: property syntax: - content: 'public static readonly configurations: IHttpClientConfigurations;' + content: 'static readonly configurations: IHttpClientConfigurations;' return: type: - - 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 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(url, configuration, options)' langs: - 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 + - '@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 + optional: false - id: configuration description: >- determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations type: - - HttpClientConfiguration + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request type: - - IHttpClientOptions - - uid: sp-http.HttpClient.get + - '@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: sp-http.HttpClient.get + fullName: 'get(url, configuration, options)' langs: - 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 + - '@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. parameters: - id: url description: the URL to fetch type: - string + optional: false - id: configuration description: >- determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations type: - - HttpClientConfiguration + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request type: - - IHttpClientOptions - - uid: sp-http.HttpClient.post + - '@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: sp-http.HttpClient.post + fullName: 'post(url, configuration, options)' langs: - 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 + - '@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. parameters: - id: url description: the URL to fetch type: - string + optional: false - id: configuration description: >- determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations type: - - HttpClientConfiguration + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request type: - - IHttpClientOptions - - uid: sp-http.HttpClient.serviceKey + - '@microsoft/sp-http!IHttpClientOptions:interface' + optional: false + - uid: '@microsoft/sp-http!HttpClient.serviceKey:member' summary: The service key for HttpClient. name: serviceKey - fullName: sp-http.HttpClient.serviceKey + fullName: serviceKey langs: - typeScript type: property syntax: - content: 'public static readonly serviceKey: ServiceKey;' + 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: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 0fe70629..5f80f636 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 @@ -8,24 +8,24 @@ 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 implements: - - 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. - name: 'constructor(flags, overrideFlags)' - fullName: sp-http.HttpClientConfiguration.constructor + name: '(constructor)(flags, overrideFlags)' + fullName: '(constructor)(flags, overrideFlags)' langs: - typeScript type: constructor @@ -35,14 +35,16 @@ items: - id: flags description: '' type: - - IHttpClientConfiguration + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + optional: false - id: overrideFlags description: '' type: - - IHttpClientConfiguration - - uid: sp-http.HttpClientConfiguration.flags + - '@microsoft/sp-http!IHttpClientConfiguration:interface' + optional: true + - uid: '@microsoft/sp-http!HttpClientConfiguration#flags:member' name: flags - fullName: sp-http.HttpClientConfiguration.flags + fullName: flags langs: - typeScript type: property @@ -50,35 +52,45 @@ items: content: 'protected flags: IHttpClientConfiguration;' return: type: - - 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: sp-http.HttpClientConfiguration.initializeFlags + fullName: initializeFlags() langs: - typeScript type: method syntax: - content: '@virtual protected initializeFlags(): void;' + content: |- + /** @virtual */ + protected initializeFlags(): void; return: 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: sp-http.HttpClientConfiguration.overrideWith + fullName: overrideWith(sourceFlags) langs: - typeScript type: method syntax: - content: '@virtual public overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration;' + content: |- + /** @virtual */ + overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration; return: type: - - HttpClientConfiguration + - '@microsoft/sp-http!default:class' description: '' parameters: - id: sourceFlags description: '' type: - - IHttpClientConfiguration + - '@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 bcd06405..2058543e 100644 --- a/SP-Framework/sp-http/httpclientresponse.yml +++ b/SP-Framework/sp-http/httpclientresponse.yml @@ -1,127 +1,130 @@ ### 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: >- - 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: sp-http.HttpClientResponse + fullName: HttpClientResponse langs: - typeScript type: class implements: - - Response - 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 - summary: 'See documentation for whatwg-fetch:Body.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: sp-http.HttpClientResponse.arrayBuffer + fullName: arrayBuffer() langs: - typeScript type: method syntax: - content: 'public arrayBuffer(): Promise;' + content: 'arrayBuffer(): Promise;' return: type: - - Promise + - '@microsoft/sp-http!HttpClientResponse#arrayBuffer~0:complex' description: '' - - uid: sp-http.HttpClientResponse.blob - summary: 'See documentation for whatwg-fetch:Body.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: sp-http.HttpClientResponse.blob + fullName: blob() langs: - typeScript type: method syntax: - content: 'public blob(): Promise;' + content: 'blob(): Promise;' return: type: - - Promise + - '@microsoft/sp-http!HttpClientResponse#blob~0:complex' description: '' - - uid: sp-http.HttpClientResponse.bodyUsed - summary: 'See documentation for whatwg-fetch:Body.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: sp-http.HttpClientResponse.bodyUsed + fullName: bodyUsed langs: - typeScript type: property syntax: - content: 'public readonly bodyUsed: boolean;' + content: 'get bodyUsed(): boolean;' return: type: - boolean - - uid: sp-http.HttpClientResponse.clone + - uid: '@microsoft/sp-http!HttpClientResponse#clone:member(1)' name: clone() - fullName: sp-http.HttpClientResponse.clone + fullName: clone() langs: - typeScript type: method syntax: - content: '@virtual public clone(): HttpClientResponse;' + content: |- + /** @virtual */ + clone(): HttpClientResponse; return: type: - - HttpClientResponse + - '@microsoft/sp-http!default:class' description: '' - - uid: sp-http.HttpClientResponse.formData - summary: 'See documentation for whatwg-fetch:Body.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: sp-http.HttpClientResponse.formData + fullName: formData() langs: - typeScript type: method syntax: - content: 'public formData(): Promise;' + content: 'formData(): Promise;' return: type: - - Promise + - '@microsoft/sp-http!HttpClientResponse#formData~0:complex' description: '' - - uid: sp-http.HttpClientResponse.headers - summary: 'See documentation for whatwg-fetch:Response.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: sp-http.HttpClientResponse.headers + fullName: headers langs: - typeScript type: property syntax: - content: 'public readonly headers: Headers;' + content: 'get headers(): Headers;' return: type: - - Headers - - uid: sp-http.HttpClientResponse.json - summary: 'See documentation for whatwg-fetch:Body.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: sp-http.HttpClientResponse.json + fullName: json() langs: - typeScript type: method syntax: - content: 'public json(): Promise;' + 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: sp-http.HttpClientResponse.nativeResponse + fullName: nativeResponse langs: - typeScript type: property @@ -129,77 +132,148 @@ items: content: 'protected nativeResponse: Response;' return: type: - - Response - - uid: sp-http.HttpClientResponse.ok - summary: 'See documentation for whatwg-fetch:Response.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: sp-http.HttpClientResponse.ok + fullName: ok langs: - typeScript type: property syntax: - content: 'public readonly ok: boolean;' + content: 'get ok(): boolean;' return: type: - boolean - - uid: sp-http.HttpClientResponse.status - summary: 'See documentation for whatwg-fetch:Response.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: sp-http.HttpClientResponse.status + fullName: status langs: - typeScript type: property syntax: - content: 'public readonly status: number;' + content: 'get status(): number;' return: type: - number - - uid: sp-http.HttpClientResponse.statusText - summary: 'See documentation for whatwg-fetch:Response.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: sp-http.HttpClientResponse.statusText + fullName: statusText langs: - typeScript type: property syntax: - content: 'public readonly statusText: string;' + content: 'get statusText(): string;' return: type: - string - - uid: sp-http.HttpClientResponse.text - summary: 'See documentation for whatwg-fetch:Body.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: sp-http.HttpClientResponse.text + fullName: text() langs: - typeScript type: method syntax: - content: 'public text(): Promise;' + content: 'text(): Promise;' return: type: - - Promise + - '@microsoft/sp-http!HttpClientResponse#text~0:complex' description: '' - - uid: sp-http.HttpClientResponse.type - summary: 'See documentation for whatwg-fetch:Response.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: sp-http.HttpClientResponse.type + fullName: type langs: - typeScript type: property syntax: - content: 'public readonly type: ResponseType;' + content: 'get type(): ResponseType;' return: type: - - ResponseType - - uid: sp-http.HttpClientResponse.url - summary: 'See documentation for whatwg-fetch:Response.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: sp-http.HttpClientResponse.url + fullName: url langs: - typeScript type: property syntax: - content: 'public readonly url: string;' + 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 new file mode 100644 index 00000000..d3af564c --- /dev/null +++ b/SP-Framework/sp-http/iaadhttpclientconfiguration.yml @@ -0,0 +1,17 @@ +### 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 new file mode 100644 index 00000000..0fa3e4d1 --- /dev/null +++ b/SP-Framework/sp-http/iaadhttpclientconfigurations.yml @@ -0,0 +1,35 @@ +### 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!' + 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 + syntax: + content: 'readonly v1: AadHttpClientConfiguration;' + return: + 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 new file mode 100644 index 00000000..75b5cb8a --- /dev/null +++ b/SP-Framework/sp-http/iaadhttpclientoptions.yml @@ -0,0 +1,58 @@ +### 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 + langs: + - typeScript + type: property + 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 + fullName: tokenProvider + langs: + - typeScript + type: property + 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 + fullName: useCachedToken + langs: + - typeScript + type: property + syntax: + content: 'useCachedToken?: boolean;' + 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 new file mode 100644 index 00000000..3ac91c64 --- /dev/null +++ b/SP-Framework/sp-http/iaadtokenprovider.yml @@ -0,0 +1,114 @@ +### 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. + name: IAadTokenProvider + fullName: IAadTokenProvider + langs: + - typeScript + type: interface + package: '@microsoft/sp-http!' + 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 + 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 + optional: false + - id: useCachedToken + description: Allows the developer to specify if cached tokens should be returned. + type: + - boolean + optional: true + - uid: '@microsoft/sp-http!IAadTokenProvider#onBeforeRedirectEvent:member' + summary: Notifies the developer before a full page redirect occurs. + name: onBeforeRedirectEvent + fullName: onBeforeRedirectEvent + langs: + - typeScript + type: event + syntax: + content: 'readonly onBeforeRedirectEvent: SPEvent;' + return: + 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. + name: tokenAcquisitionEvent + fullName: tokenAcquisitionEvent + langs: + - typeScript + type: event + syntax: + content: 'readonly tokenAcquisitionEvent: SPEvent;' + 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: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 new file mode 100644 index 00000000..2cefb0c2 --- /dev/null +++ b/SP-Framework/sp-http/iaadtokenproviderconfiguration.yml @@ -0,0 +1,127 @@ +### 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!' + 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. + name: aadInstanceUrl + fullName: aadInstanceUrl + langs: + - typeScript + type: property + syntax: + content: 'aadInstanceUrl: string;' + return: + type: + - string + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadSessionId:member' + summary: The current Azure Active Directory's session id. + isPreview: true + name: aadSessionId + fullName: aadSessionId + langs: + - typeScript + type: property + syntax: + content: 'aadSessionId: string;' + return: + type: + - string + - uid: '@microsoft/sp-http!IAadTokenProviderConfiguration#aadTenantId:member' + summary: The Azure Active Directory's tenant id. + name: aadTenantId + fullName: aadTenantId + langs: + - typeScript + type: property + 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 + fullName: aadUserId + langs: + - typeScript + type: property + 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 + fullName: redirectUri + langs: + - typeScript + type: property + 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 + fullName: servicePrincipalId + langs: + - typeScript + type: property + 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 + fullName: userEmail + langs: + - typeScript + type: property + 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 + fullName: userPrincipalName + langs: + - typeScript + type: property + syntax: + content: 'userPrincipalName?: string;' + return: + type: + - string diff --git a/SP-Framework/sp-http/ibeforeredirecteventargs.yml b/SP-Framework/sp-http/ibeforeredirecteventargs.yml new file mode 100644 index 00000000..34bac608 --- /dev/null +++ b/SP-Framework/sp-http/ibeforeredirecteventargs.yml @@ -0,0 +1,44 @@ +### 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!' + 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. + name: cancel + fullName: cancel + langs: + - typeScript + type: property + syntax: + content: 'cancel: () => void;' + return: + type: + - () => void + - uid: '@microsoft/sp-http!IBeforeRedirectEventArgs#redirectUrl:member' + summary: The url of the page to redirect to if automatic redirect is cancelled + name: redirectUrl + fullName: redirectUrl + langs: + - typeScript + type: property + syntax: + content: 'redirectUrl: string;' + return: + 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 new file mode 100644 index 00000000..936140db --- /dev/null +++ b/SP-Framework/sp-http/idigestcache.yml @@ -0,0 +1,126 @@ +### 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) + name: IDigestCache + fullName: IDigestCache + langs: + - typeScript + type: interface + 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)' + 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(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 + 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 + 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 + optional: false + - uid: '@microsoft/sp-http!IDigestCache#clearAllDigests:member(1)' + summary: Clears all values from the cache. + name: clearAllDigests() + fullName: clearAllDigests() + langs: + - typeScript + type: method + syntax: + content: 'clearAllDigests(): void;' + return: + 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) + 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 + 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. + 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 + 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/igraphhttpclientconfiguration.yml b/SP-Framework/sp-http/igraphhttpclientconfiguration.yml deleted file mode 100644 index 54d39045..00000000 --- a/SP-Framework/sp-http/igraphhttpclientconfiguration.yml +++ /dev/null @@ -1,15 +0,0 @@ -### 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: sp-http.IGraphHttpClientConfiguration - langs: - - typeScript - type: interface - extends: - - IHttpClientConfiguration - package: sp-http diff --git a/SP-Framework/sp-http/igraphhttpclientconfigurations.yml b/SP-Framework/sp-http/igraphhttpclientconfigurations.yml deleted file mode 100644 index ae210738..00000000 --- a/SP-Framework/sp-http/igraphhttpclientconfigurations.yml +++ /dev/null @@ -1,38 +0,0 @@ -### 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: sp-http.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: sp-http.IGraphHttpClientConfigurations.v1 - langs: - - typeScript - type: property - 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 319130f6..00000000 --- a/SP-Framework/sp-http/igraphhttpclientoptions.yml +++ /dev/null @@ -1,16 +0,0 @@ -### 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: sp-http.IGraphHttpClientOptions - langs: - - typeScript - type: interface - extends: - - IHttpClientOptions - package: sp-http diff --git a/SP-Framework/sp-http/ihttpclientconfiguration.yml b/SP-Framework/sp-http/ihttpclientconfiguration.yml index fd9a9bf2..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: sp-http.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 c1ff7660..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 @@ -9,19 +9,19 @@ 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 - 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/ name: v1 - fullName: sp-http.IHttpClientConfigurations.v1 + fullName: v1 langs: - typeScript type: property @@ -29,4 +29,7 @@ items: content: 'readonly v1: HttpClientConfiguration;' return: type: - - 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 58a5db7e..49fc4ffc 100644 --- a/SP-Framework/sp-http/ihttpclientoptions.yml +++ b/SP-Framework/sp-http/ihttpclientoptions.yml @@ -1,15 +1,20 @@ ### 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 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 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 891e21df..fbff5992 100644 --- a/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientbatchconfiguration.yml @@ -1,13 +1,22 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.ISPHttpClientBatchConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' summary: Flags interface for SPHttpClientBatchConfiguration. isPreview: true name: ISPHttpClientBatchConfiguration - fullName: sp-http.ISPHttpClientBatchConfiguration + fullName: ISPHttpClientBatchConfiguration langs: - typeScript type: interface extends: - - 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 5281f9d8..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 @@ -10,18 +10,18 @@ items: the time when it was tested.) isPreview: true name: ISPHttpClientBatchConfigurations - fullName: sp-http.ISPHttpClientBatchConfigurations + fullName: ISPHttpClientBatchConfigurations 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 - fullName: sp-http.ISPHttpClientBatchConfigurations.v1 + fullName: v1 langs: - typeScript type: property @@ -29,4 +29,7 @@ items: content: 'readonly v1: SPHttpClientBatchConfiguration;' return: type: - - 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 5ffcbf05..77834e6d 100644 --- a/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchcreationoptions.yml @@ -1,17 +1,17 @@ ### 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 - fullName: sp-http.ISPHttpClientBatchCreationOptions + fullName: ISPHttpClientBatchCreationOptions 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 @@ -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..422829a6 100644 --- a/SP-Framework/sp-http/isphttpclientbatchoptions.yml +++ b/SP-Framework/sp-http/isphttpclientbatchoptions.yml @@ -1,15 +1,24 @@ ### 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/ isPreview: true name: ISPHttpClientBatchOptions - fullName: sp-http.ISPHttpClientBatchOptions + fullName: ISPHttpClientBatchOptions langs: - typeScript type: interface extends: - - 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 aeabdaee..cff46a69 100644 --- a/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientcommonconfiguration.yml @@ -1,19 +1,21 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.ISPHttpClientCommonConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' summary: Flags interface for SPHttpClientCommonConfiguration name: ISPHttpClientCommonConfiguration - fullName: sp-http.ISPHttpClientCommonConfiguration + fullName: ISPHttpClientCommonConfiguration langs: - typeScript type: interface extends: - - 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: @@ -28,7 +30,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 @@ -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: @@ -48,7 +50,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 @@ -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 85701ccf..769ca429 100644 --- a/SP-Framework/sp-http/isphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/isphttpclientconfiguration.yml @@ -1,20 +1,24 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.ISPHttpClientConfiguration + - uid: '@microsoft/sp-http!ISPHttpClientConfiguration:interface' summary: Flags interface for SPHttpClientConfiguration. name: ISPHttpClientConfiguration - fullName: sp-http.ISPHttpClientConfiguration + fullName: ISPHttpClientConfiguration langs: - typeScript type: interface extends: - - 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 @@ -24,7 +28,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 @@ -32,8 +36,8 @@ items: content: 'defaultODataVersion?: ODataVersion;' return: type: - - 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: @@ -45,7 +49,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 @@ -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: @@ -64,7 +68,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 @@ -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 1e89944f..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. @@ -9,14 +9,14 @@ 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 - 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: @@ -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 @@ -32,4 +32,7 @@ items: content: 'readonly v1: SPHttpClientConfiguration;' return: type: - - 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 f187428d..7766f09b 100644 --- a/SP-Framework/sp-http/isphttpclientoptions.yml +++ b/SP-Framework/sp-http/isphttpclientoptions.yml @@ -1,20 +1,24 @@ ### 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/ name: ISPHttpClientOptions - fullName: sp-http.ISPHttpClientOptions + fullName: ISPHttpClientOptions langs: - typeScript type: interface extends: - - 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 @@ -23,7 +27,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 @@ -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 new file mode 100644 index 00000000..cee1e7da --- /dev/null +++ b/SP-Framework/sp-http/itokenacquisitioneventargs.yml @@ -0,0 +1,44 @@ +### 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!' + 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 + 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 + fullName: redirectUrl + langs: + - typeScript + type: property + syntax: + content: 'redirectUrl?: string;' + 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 new file mode 100644 index 00000000..89ef8020 --- /dev/null +++ b/SP-Framework/sp-http/msgraphclient.yml @@ -0,0 +1,61 @@ +### 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) + + + 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!' + 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 \* + 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 + 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 + optional: false + - id: config + description: Sets the configuration for this request. + 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 new file mode 100644 index 00000000..2ba9c754 --- /dev/null +++ b/SP-Framework/sp-http/msgraphclientfactory.yml @@ -0,0 +1,149 @@ +### 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!' + 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. + 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: + - '@microsoft/sp-http!MSGraphClientFactory#getClient~0:complex' + description: '' + - 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. + 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''' + 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. + 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''' + 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: + - '@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 new file mode 100644 index 00000000..f15e0ddf --- /dev/null +++ b/SP-Framework/sp-http/msgraphclientv3.yml @@ -0,0 +1,54 @@ +### 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) + + + 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!' + 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 \* + 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) + 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 + 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 16b9b2ef..efcdba5b 100644 --- a/SP-Framework/sp-http/odataversion.yml +++ b/SP-Framework/sp-http/odataversion.yml @@ -1,59 +1,88 @@ ### 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: sp-http.ODataVersion + fullName: ODataVersion langs: - typeScript type: class - package: sp-http + package: '@microsoft/sp-http!' children: - - sp-http.ODataVersion.tryParseFromHeaders - - sp-http.ODataVersion.v3 - - sp-http.ODataVersion.v4 - - uid: sp-http.ODataVersion.tryParseFromHeaders + - '@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: sp-http.ODataVersion.tryParseFromHeaders + fullName: tryParseFromHeaders(headers) langs: - typeScript type: method syntax: - content: 'public static tryParseFromHeaders(headers: Headers): ODataVersion | undefined;' + 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' + optional: false + - uid: '@microsoft/sp-http!ODataVersion.v3:member' summary: Represents version 3.0 for the "OData-Version" header name: v3 - fullName: sp-http.ODataVersion.v3 + fullName: v3 langs: - typeScript type: property syntax: - content: 'public static v3: ODataVersion;' + content: 'static v3: ODataVersion;' return: type: - - 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: sp-http.ODataVersion.v4 + fullName: v4 langs: - typeScript type: property syntax: - content: 'public static v4: ODataVersion;' + content: 'static v4: ODataVersion;' return: type: - - 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 b5ba5680..dfc05dd2 100644 --- a/SP-Framework/sp-http/sphttpclient.yml +++ b/SP-Framework/sp-http/sphttpclient.yml @@ -1,29 +1,66 @@ ### 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: '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:@microsoft/sp-http!HttpClient:class) + class. name: SPHttpClient - fullName: sp-http.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 - summary: 'Constructs a new instance of the [SPHttpClient](xref:sp-http.SPHttpClient) class' - name: constructor(serviceScope) - fullName: sp-http.SPHttpClient.constructor + - '@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)' + 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 + optional: false + - id: configuration + description: '' + type: + - '@microsoft/sp-http!default:class' + optional: false + - id: options + description: '' + 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 @@ -33,39 +70,43 @@ items: - id: serviceScope description: '' type: - - ServiceScope - - uid: sp-http.SPHttpClient.beginBatch + - '@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.' isPreview: true name: beginBatch(batchCreationOptions) - fullName: sp-http.SPHttpClient.beginBatch + fullName: beginBatch(batchCreationOptions) langs: - 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 + - '@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: - - ISPHttpClientBatchCreationOptions - - uid: sp-http.SPHttpClient.configurations + - '@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: sp-http.SPHttpClient.configurations + fullName: configurations langs: - typeScript type: property syntax: - content: 'public static readonly configurations: ISPHttpClientConfigurations;' + content: 'static readonly configurations: ISPHttpClientConfigurations;' return: type: - - 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 @@ -86,64 +127,82 @@ 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)' - fullName: sp-http.SPHttpClient.fetch + fullName: 'fetch(url, configuration, options)' langs: - 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 + - '@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 + optional: false - id: configuration description: >- determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations type: - - SPHttpClientConfiguration + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request type: - - ISPHttpClientOptions - - uid: sp-http.SPHttpClient.get + - '@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: sp-http.SPHttpClient.get + fullName: 'get(url, configuration, options)' langs: - 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 + - '@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. parameters: - id: url description: the URL to fetch type: - string + optional: false - id: configuration description: >- determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations type: - - SPHttpClientConfiguration + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request type: - - ISPHttpClientOptions - - uid: sp-http.SPHttpClient.getWebUrlFromRequestUrl + - '@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 @@ -158,12 +217,12 @@ items: If the URL cannot be determined, an exception is thrown. name: getWebUrlFromRequestUrl(requestUrl) - fullName: sp-http.SPHttpClient.getWebUrlFromRequestUrl + fullName: getWebUrlFromRequestUrl(requestUrl) langs: - typeScript type: method syntax: - content: 'public static getWebUrlFromRequestUrl(requestUrl: string): string;' + content: 'static getWebUrlFromRequestUrl(requestUrl: string): string;' return: type: - string @@ -173,43 +232,150 @@ items: description: The URL for a SharePoint REST service type: - string - - uid: sp-http.SPHttpClient.post + 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: + - '!Boolean:interface' + - uid: '@microsoft/sp-http!SPHttpClient#post:member(1)' summary: 'Calls fetch(), but sets the method to "POST".' name: 'post(url, configuration, options)' - fullName: sp-http.SPHttpClient.post + fullName: 'post(url, configuration, options)' langs: - 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 + - '@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 + optional: false - id: configuration description: >- determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations type: - - SPHttpClientConfiguration + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request type: - - ISPHttpClientOptions - - uid: sp-http.SPHttpClient.serviceKey + - '@microsoft/sp-http!ISPHttpClientOptions:interface' + optional: false + - uid: '@microsoft/sp-http!SPHttpClient.serviceKey:member' summary: The service key for SPHttpClient. name: serviceKey - fullName: sp-http.SPHttpClient.serviceKey + fullName: serviceKey langs: - typeScript type: property syntax: - content: 'public static readonly serviceKey: ServiceKey;' + content: 'static readonly serviceKey: ServiceKey;' return: type: - - ServiceKey + - '@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 37cf7588..639e617e 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 @@ -12,52 +12,56 @@ 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: sp-http.SPHttpClientBatch + fullName: SPHttpClientBatch 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 - fullName: sp-http.SPHttpClientBatch.configurations + fullName: configurations langs: - typeScript type: property syntax: - content: 'public static readonly configurations: ISPHttpClientBatchConfigurations;' + content: 'static readonly configurations: ISPHttpClientBatchConfigurations;' return: type: - - 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() - fullName: sp-http.SPHttpClientBatch.execute + fullName: execute() langs: - typeScript type: method syntax: - content: 'public execute(): Promise;' + 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). 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: + + + [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 @@ -70,88 +74,176 @@ items: explicitly. isPreview: true name: 'fetch(url, configuration, options)' - fullName: sp-http.SPHttpClientBatch.fetch + fullName: 'fetch(url, configuration, options)' langs: - typeScript 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 + - '@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 + optional: false - id: configuration description: >- determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations type: - - SPHttpClientBatchConfiguration + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request type: - - ISPHttpClientBatchOptions - - uid: sp-http.SPHttpClientBatch.get + - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + optional: true + - 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: sp-http.SPHttpClientBatch.get + fullName: 'get(url, configuration, options)' langs: - 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 + - '@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 + optional: false - id: configuration description: >- determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations type: - - SPHttpClientBatchConfiguration + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request type: - - ISPHttpClientBatchOptions - - uid: sp-http.SPHttpClientBatch.post + - '@microsoft/sp-http!ISPHttpClientBatchOptions:interface' + optional: true + - 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: sp-http.SPHttpClientBatch.post + fullName: 'post(url, configuration, options)' langs: - 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 + - '@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 + optional: false - id: configuration description: >- determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations type: - - SPHttpClientBatchConfiguration + - '@microsoft/sp-http!default:class' + optional: false - id: options description: additional options that affect the request type: - - ISPHttpClientBatchOptions + - '@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 77e77358..d518eaab 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 @@ -9,26 +9,29 @@ items: changed via the SPHttpClientBatchConfiguration.overrideWith() method. isPreview: true name: SPHttpClientBatchConfiguration - fullName: sp-http.SPHttpClientBatchConfiguration + fullName: SPHttpClientBatchConfiguration langs: - typeScript type: class extends: - - SPHttpClientCommonConfiguration + - '@microsoft/sp-http!default:class' + inheritance: + - type: '@microsoft/sp-http!default:class' implements: - - 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. - name: 'constructor(flags, overrideFlags)' - fullName: sp-http.SPHttpClientBatchConfiguration.constructor + isPreview: true + name: '(constructor)(flags, overrideFlags)' + fullName: '(constructor)(flags, overrideFlags)' langs: - typeScript type: constructor @@ -38,15 +41,17 @@ items: - id: flags description: '' type: - - ISPHttpClientBatchConfiguration + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + optional: false - id: overrideFlags description: '' type: - - ISPHttpClientBatchConfiguration - - uid: sp-http.SPHttpClientBatchConfiguration.flags + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + optional: true + - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#flags:member' isPreview: true name: flags - fullName: sp-http.SPHttpClientBatchConfiguration.flags + fullName: flags langs: - typeScript type: property @@ -54,35 +59,45 @@ items: content: 'protected flags: ISPHttpClientBatchConfiguration;' return: type: - - ISPHttpClientBatchConfiguration - - uid: sp-http.SPHttpClientBatchConfiguration.initializeFlags + - '@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface' + - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#initializeFlags:member(1)' isPreview: true name: initializeFlags() - fullName: sp-http.SPHttpClientBatchConfiguration.initializeFlags + fullName: initializeFlags() langs: - typeScript type: method syntax: - content: '@override protected initializeFlags(): void;' + content: |- + /** @override */ + protected initializeFlags(): void; return: type: - void description: '' - - uid: sp-http.SPHttpClientBatchConfiguration.overrideWith + - uid: '@microsoft/sp-http!SPHttpClientBatchConfiguration#overrideWith:member(1)' isPreview: true name: overrideWith(sourceFlags) - fullName: sp-http.SPHttpClientBatchConfiguration.overrideWith + fullName: overrideWith(sourceFlags) langs: - typeScript type: method syntax: - content: '@override public overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration;' + content: |- + /** @override */ + overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration; return: type: - - SPHttpClientBatchConfiguration + - '@microsoft/sp-http!default:class' description: '' parameters: - id: sourceFlags description: '' type: - - ISPHttpClientBatchConfiguration + - '@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 49818d8b..f946ef6c 100644 --- a/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientcommonconfiguration.yml @@ -1,31 +1,33 @@ ### YamlMime:UniversalReference items: - - uid: sp-http.SPHttpClientCommonConfiguration + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration:class' summary: Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration. name: SPHttpClientCommonConfiguration - fullName: sp-http.SPHttpClientCommonConfiguration + fullName: SPHttpClientCommonConfiguration langs: - typeScript type: class extends: - - HttpClientConfiguration + - '@microsoft/sp-http!default:class' + inheritance: + - type: '@microsoft/sp-http!default:class' implements: - - 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 takes precedence over flags. - name: 'constructor(flags, overrideFlags)' - fullName: sp-http.SPHttpClientCommonConfiguration.constructor + name: '(constructor)(flags, overrideFlags)' + fullName: '(constructor)(flags, overrideFlags)' langs: - typeScript type: constructor @@ -35,14 +37,16 @@ items: - id: flags description: '' type: - - ISPHttpClientCommonConfiguration + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + optional: false - id: overrideFlags description: '' type: - - ISPHttpClientCommonConfiguration - - uid: sp-http.SPHttpClientCommonConfiguration.flags + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + optional: true + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#flags:member' name: flags - fullName: sp-http.SPHttpClientCommonConfiguration.flags + fullName: flags langs: - typeScript type: property @@ -50,20 +54,22 @@ items: content: 'protected flags: ISPHttpClientCommonConfiguration;' return: type: - - ISPHttpClientCommonConfiguration - - uid: sp-http.SPHttpClientCommonConfiguration.initializeFlags + - '@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface' + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#initializeFlags:member(1)' name: initializeFlags() - fullName: sp-http.SPHttpClientCommonConfiguration.initializeFlags + fullName: initializeFlags() langs: - typeScript type: method syntax: - content: '@override protected initializeFlags(): void;' + content: |- + /** @override */ + protected initializeFlags(): void; return: 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: @@ -78,16 +84,16 @@ 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 syntax: - content: 'public readonly jsonRequest: boolean;' + content: 'get jsonRequest(): boolean;' 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: @@ -98,29 +104,37 @@ 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 syntax: - content: 'public readonly jsonResponse: boolean;' + content: 'get jsonResponse(): boolean;' return: type: - boolean - - uid: sp-http.SPHttpClientCommonConfiguration.overrideWith + - uid: '@microsoft/sp-http!SPHttpClientCommonConfiguration#overrideWith:member(1)' name: overrideWith(sourceFlags) - fullName: sp-http.SPHttpClientCommonConfiguration.overrideWith + fullName: overrideWith(sourceFlags) langs: - typeScript type: method syntax: - content: '@override public overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration;' + content: |- + /** @override */ + overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration; return: type: - - SPHttpClientCommonConfiguration + - '@microsoft/sp-http!default:class' description: '' parameters: - id: sourceFlags description: '' type: - - ISPHttpClientCommonConfiguration + - '@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 d3b16968..13130e18 100644 --- a/SP-Framework/sp-http/sphttpclientconfiguration.yml +++ b/SP-Framework/sp-http/sphttpclientconfiguration.yml @@ -1,36 +1,38 @@ ### 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 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 extends: - - SPHttpClientCommonConfiguration + - '@microsoft/sp-http!default:class' + inheritance: + - type: '@microsoft/sp-http!default:class' implements: - - 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. - name: 'constructor(flags, overrideFlags)' - fullName: sp-http.SPHttpClientConfiguration.constructor + name: '(constructor)(flags, overrideFlags)' + fullName: '(constructor)(flags, overrideFlags)' langs: - typeScript type: constructor @@ -40,12 +42,14 @@ items: - id: flags description: '' type: - - ISPHttpClientConfiguration + - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + optional: false - id: overrideFlags description: '' type: - - ISPHttpClientConfiguration - - uid: sp-http.SPHttpClientConfiguration.defaultODataVersion + - '@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 @@ -55,16 +59,16 @@ 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 syntax: - content: 'public readonly defaultODataVersion: ODataVersion;' + content: 'get defaultODataVersion(): ODataVersion;' return: type: - - 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: @@ -76,18 +80,18 @@ 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 syntax: - content: 'public readonly defaultSameOriginCredentials: boolean;' + content: 'get defaultSameOriginCredentials(): boolean;' return: type: - boolean - - uid: sp-http.SPHttpClientConfiguration.flags + - uid: '@microsoft/sp-http!SPHttpClientConfiguration#flags:member' name: flags - fullName: sp-http.SPHttpClientConfiguration.flags + fullName: flags langs: - typeScript type: property @@ -95,37 +99,42 @@ items: content: 'protected flags: ISPHttpClientConfiguration;' return: type: - - ISPHttpClientConfiguration - - uid: sp-http.SPHttpClientConfiguration.initializeFlags + - '@microsoft/sp-http!ISPHttpClientConfiguration:interface' + - uid: '@microsoft/sp-http!SPHttpClientConfiguration#initializeFlags:member(1)' name: initializeFlags() - fullName: sp-http.SPHttpClientConfiguration.initializeFlags + fullName: initializeFlags() langs: - typeScript type: method syntax: - content: '@override protected initializeFlags(): void;' + content: |- + /** @override */ + protected initializeFlags(): void; return: type: - void description: '' - - uid: sp-http.SPHttpClientConfiguration.overrideWith + - uid: '@microsoft/sp-http!SPHttpClientConfiguration#overrideWith:member(1)' name: overrideWith(sourceFlags) - fullName: sp-http.SPHttpClientConfiguration.overrideWith + fullName: overrideWith(sourceFlags) langs: - typeScript type: method syntax: - content: '@override public overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration;' + content: |- + /** @override */ + overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration; return: type: - - SPHttpClientConfiguration + - '@microsoft/sp-http!default:class' description: '' parameters: - id: sourceFlags description: '' type: - - ISPHttpClientConfiguration - - uid: sp-http.SPHttpClientConfiguration.requestDigest + - '@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: @@ -135,12 +144,17 @@ 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 syntax: - content: 'public readonly requestDigest: boolean;' + content: 'get requestDigest(): boolean;' 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 5287c3a7..09d4b387 100644 --- a/SP-Framework/sp-http/sphttpclientresponse.yml +++ b/SP-Framework/sp-http/sphttpclientresponse.yml @@ -1,47 +1,55 @@ ### 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 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 + fullName: SPHttpClientResponse langs: - typeScript type: class extends: - - 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 - summary: 'Constructs a new instance of the [SPHttpClientResponse](xref:sp-http.SPHttpClientResponse) class' - name: constructor(response) - fullName: 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) langs: - typeScript type: constructor syntax: - content: 'public constructor(response: Response);' + content: 'constructor(response: Response);' parameters: - id: response description: '' type: - - Response - - uid: sp-http.SPHttpClientResponse.clone + - '!Response:interface' + optional: false + - uid: '@microsoft/sp-http!SPHttpClientResponse#clone:member(1)' name: clone() - fullName: sp-http.SPHttpClientResponse.clone + fullName: clone() langs: - typeScript type: method syntax: - content: '@override public clone(): SPHttpClientResponse;' + content: |- + /** @override */ + clone(): SPHttpClientResponse; return: type: - - 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, @@ -49,12 +57,26 @@ items: correlation ID as the "sprequestguid" header. isPreview: true name: correlationId - fullName: sp-http.SPHttpClientResponse.correlationId + fullName: correlationId langs: - typeScript type: property syntax: - content: 'public readonly correlationId: Guid | undefined;' + content: 'get 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 bef65fa7..45eb0a18 100644 --- a/SP-Framework/sp-http/sphttpheader.yml +++ b/SP-Framework/sp-http/sphttpheader.yml @@ -1,25 +1,25 @@ ### 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: sp-http.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. Example value: "9417279e-40e1-0000-2465-306ba786bfd7" isPreview: true name: SPRequestGuid - fullName: sp-http.SPHttpHeader.SPRequestGuid + fullName: SPRequestGuid 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..84893cab --- /dev/null +++ b/SP-Framework/sp-http/tokenacquisitioneventargs.yml @@ -0,0 +1,65 @@ +### 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!' + 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 + syntax: + content: 'constructor(message: string, redirectUrl?: string);' + parameters: + - id: message + description: '' + type: + - string + optional: false + - id: redirectUrl + description: '' + 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. + name: message + fullName: message + langs: + - typeScript + type: property + 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 + fullName: redirectUrl + langs: + - typeScript + type: property + syntax: + content: 'redirectUrl?: string;' + return: + 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 new file mode 100644 index 00000000..78bad61a --- /dev/null +++ b/SP-Framework/sp-image-helper.yml @@ -0,0 +1,31 @@ +### 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 new file mode 100644 index 00000000..31437a57 --- /dev/null +++ b/SP-Framework/sp-image-helper/iimagehelperrequest.yml @@ -0,0 +1,55 @@ +### 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!' + 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. + name: height + fullName: height + langs: + - typeScript + type: property + syntax: + content: 'height?: number;' + return: + 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. + name: sourceUrl + fullName: sourceUrl + langs: + - typeScript + type: property + syntax: + content: 'sourceUrl: string;' + return: + 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.' + name: width + fullName: width + langs: + - typeScript + type: property + 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..24ea14bd --- /dev/null +++ b/SP-Framework/sp-image-helper/imagehelper.yml @@ -0,0 +1,41 @@ +### 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!' + 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. + name: convertToImageUrl(request) + fullName: convertToImageUrl(request) + langs: + - typeScript + type: method + syntax: + content: 'static convertToImageUrl(request: IImageHelperRequest): string;' + 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. + 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 new file mode 100644 index 00000000..41ef4b57 --- /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..1617f163 --- /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..6a89fefa --- /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..4e0aa4bb --- /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..cf2c796f --- /dev/null +++ b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml @@ -0,0 +1,90 @@ +### 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' + 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. + 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' + optional: false + - 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' + 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 e0e7fe53..cde7192c 100644 --- a/SP-Framework/sp-listview-extensibility.yml +++ b/SP-Framework/sp-listview-extensibility.yml @@ -1,50 +1,89 @@ ### 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: sp-listview-extensibility + fullName: '@microsoft/sp-listview-extensibility' langs: - 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!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: sp-listview-extensibility.BaseFieldCustomizer + - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer:class' name: BaseFieldCustomizer - - uid: sp-listview-extensibility.BaseListViewCommandSet + - uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer:class' + name: BaseFormCustomizer + - 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!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: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters + - 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: sp-listview-extensibility.IListViewCommandSetListViewUpdatedParameters + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface' name: IListViewCommandSetListViewUpdatedParameters - - uid: sp-listview-extensibility.ListItemAccessor + - 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: sp-listview-extensibility.ListViewAccessor + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor:class' name: ListViewAccessor - - uid: sp-listview-extensibility.ListViewCommandSetContext + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessorStateChanges:enum' + name: ListViewAccessorStateChanges + - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext:class' name: ListViewCommandSetContext - - uid: sp-listview-extensibility.RowAccessor + - uid: '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs:class' + name: ListViewStateChangedEventArgs + - 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 f12e19b8..cd6e7cf6 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. @@ -8,25 +8,29 @@ 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 extends: - - BaseExtension - package: sp-listview-extensibility + - '@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!' 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 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 @@ -34,15 +38,15 @@ items: content: 'protected readonly context: FieldCustomizerContext;' return: type: - - 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: sp-listview-extensibility.BaseFieldCustomizer.onDisposeCell + fullName: onDisposeCell(event) langs: - typeScript type: method syntax: - content: '@virtual public onDisposeCell(event: IFieldCustomizerCellEventParameters): void;' + content: 'onDisposeCell(event: IFieldCustomizerCellEventParameters): void;' return: type: - void @@ -51,15 +55,16 @@ items: - id: event description: '' type: - - IFieldCustomizerCellEventParameters - - uid: sp-listview-extensibility.BaseFieldCustomizer.onRenderCell + - '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' + optional: false + - uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onRenderCell:member(1)' name: onRenderCell(event) - fullName: sp-listview-extensibility.BaseFieldCustomizer.onRenderCell + fullName: onRenderCell(event) langs: - typeScript type: method syntax: - content: '@virtual public onRenderCell(event: IFieldCustomizerCellEventParameters): void;' + content: 'onRenderCell(event: IFieldCustomizerCellEventParameters): void;' return: type: - void @@ -68,4 +73,14 @@ items: - id: event description: '' type: - - IFieldCustomizerCellEventParameters + - '@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 new file mode 100644 index 00000000..7fa88c9f --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml @@ -0,0 +1,134 @@ +### 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!' + 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. + name: context + fullName: context + langs: + - typeScript + type: property + syntax: + content: 'readonly context: FormCustomizerContext;' + return: + 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.' + name: displayMode + fullName: displayMode + langs: + - typeScript + type: property + syntax: + content: 'protected get displayMode(): FormDisplayMode;' + return: + 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.' + name: dispose() + fullName: dispose() + langs: + - typeScript + type: method + syntax: + content: 'dispose(): void;' + return: + type: + - void + description: '' + - 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. + name: formClosed() + fullName: formClosed() + langs: + - typeScript + type: method + syntax: + content: 'protected formClosed(): void;' + return: + type: + - void + description: '' + - 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. + name: formSaved() + fullName: formSaved() + langs: + - typeScript + type: method + syntax: + content: 'protected formSaved(): void;' + return: + type: + - void + description: '' + - 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. + name: render() + fullName: render() + langs: + - typeScript + type: method + syntax: + content: 'protected abstract render(): void;' + return: + type: + - void + description: '' +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 e501348e..03d32eaa 100644 --- a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml +++ b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml @@ -1,53 +1,60 @@ ### 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. remarks: >- - 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: sp-listview-extensibility.BaseListViewCommandSet + fullName: BaseListViewCommandSet langs: - typeScript type: class extends: - - BaseExtension - package: sp-listview-extensibility + - '@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!' 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#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. name: context - fullName: sp-listview-extensibility.BaseListViewCommandSet.context + fullName: context langs: - typeScript type: property syntax: - content: 'public readonly context: ListViewCommandSetContext;' + content: 'readonly context: ListViewCommandSetContext;' return: type: - - 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.' + - '@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 name: onExecute(event) - fullName: sp-listview-extensibility.BaseListViewCommandSet.onExecute + fullName: onExecute(event) langs: - typeScript type: method syntax: - content: '@virtual public onExecute(event: IListViewCommandSetExecuteEventParameters): void;' + content: 'onExecute(event: IListViewCommandSetExecuteEventParameters): void;' return: type: - void @@ -56,19 +63,20 @@ items: - id: event description: '' type: - - 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. + - '@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. + deprecated: + content: Use context.listView.listViewStateChangedEvent instead. name: onListViewUpdated(event) - fullName: sp-listview-extensibility.BaseListViewCommandSet.onListViewUpdated + fullName: onListViewUpdated(event) langs: - typeScript type: method syntax: - content: '@virtual public onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;' + content: 'onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;' return: type: - void @@ -77,22 +85,48 @@ items: - id: event description: '' type: - - IListViewCommandSetListViewUpdatedParameters - - uid: sp-listview-extensibility.BaseListViewCommandSet.tryGetCommand + - '@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. + name: raiseOnChange() + fullName: raiseOnChange() + langs: + - typeScript + type: method + syntax: + content: 'raiseOnChange(): void;' + return: + type: + - void + description: '' + - 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: sp-listview-extensibility.BaseListViewCommandSet.tryGetCommand + fullName: tryGetCommand(id) langs: - typeScript type: method syntax: - content: 'public tryGetCommand(id: string): Command;' + content: 'tryGetCommand(id: string): Command;' return: type: - - Command + - '@microsoft/sp-listview-extensibility!default:class' description: '' parameters: - id: id description: Id of the command 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 141c9338..c800016e 100644 --- a/SP-Framework/sp-listview-extensibility/columnaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/columnaccessor.yml @@ -1,47 +1,50 @@ ### 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: >- - 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: sp-listview-extensibility.ColumnAccessor + fullName: ColumnAccessor 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: sp-listview-extensibility.ColumnAccessor.field + fullName: field langs: - typeScript type: property syntax: - content: 'public readonly field: SPField;' + content: 'abstract get field(): SPField;' return: type: - - 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: sp-listview-extensibility.ColumnAccessor.visible + fullName: visible langs: - typeScript type: property syntax: - content: 'public readonly visible: boolean;' + content: 'abstract get visible(): boolean;' 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 d6394398..c557be36 100644 --- a/SP-Framework/sp-listview-extensibility/command.yml +++ b/SP-Framework/sp-listview-extensibility/command.yml @@ -1,68 +1,81 @@ ### 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 + 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 + [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: sp-listview-extensibility.Command + fullName: Command 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#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." name: ariaLabel - fullName: sp-listview-extensibility.Command.ariaLabel + fullName: ariaLabel langs: - typeScript type: property syntax: - content: 'public ariaLabel: string | undefined;' + content: 'ariaLabel: string | undefined;' return: type: - string | undefined - - uid: sp-listview-extensibility.Command.iconImageUrl + - uid: '@microsoft/sp-listview-extensibility!Command#disabled:member' + summary: Whether the command is currently disabled. + name: disabled + fullName: disabled + langs: + - typeScript + type: property + syntax: + content: 'disabled: boolean | undefined;' + return: + 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. name: iconImageUrl - fullName: sp-listview-extensibility.Command.iconImageUrl + fullName: iconImageUrl langs: - typeScript type: property syntax: - content: 'public iconImageUrl: string | undefined;' + content: 'iconImageUrl: string | undefined;' 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: sp-listview-extensibility.Command.id + fullName: id langs: - typeScript type: property syntax: - content: 'public id: string;' + content: 'id: string;' 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" @@ -73,24 +86,24 @@ 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 syntax: - content: 'public title: string;' + content: 'title: string;' 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: sp-listview-extensibility.Command.visible + fullName: visible langs: - 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..2c8cfde3 100644 --- a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml @@ -1,34 +1,38 @@ ### 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 - create subclasses that extend the FieldCustomizerContext class. + create subclasses that extend the `FieldCustomizerContext` class. name: FieldCustomizerContext - fullName: sp-listview-extensibility.FieldCustomizerContext + fullName: FieldCustomizerContext langs: - typeScript type: class extends: - - 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: sp-listview-extensibility.FieldCustomizerContext.field + fullName: field langs: - typeScript type: property syntax: - content: 'public readonly field: SPField;' + content: 'get field(): SPField;' return: type: - - 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. @@ -36,13 +40,29 @@ 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 syntax: - content: 'public tryGetListView(): ListViewAccessor | undefined;' + 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/formcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml new file mode 100644 index 00000000..b8951e03 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml @@ -0,0 +1,126 @@ +### 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!' + 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 + name: '(constructor)(extensionContextParameters, formCustomizerContextParameters)' + fullName: '(constructor)(extensionContextParameters, formCustomizerContextParameters)' + langs: + - typeScript + type: constructor + syntax: + content: >- + constructor(extensionContextParameters: _IExtensionContextParameters, formCustomizerContextParameters: + IFormCustomizerContextParameters); + parameters: + - id: extensionContextParameters + description: '' + type: + - '@microsoft/sp-extension-base!_IExtensionContextParameters:interface' + optional: false + - id: formCustomizerContextParameters + description: '' + 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. + name: contentType + fullName: contentType + langs: + - typeScript + type: property + syntax: + content: 'get contentType(): IContentType;' + return: + 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. + name: domElement + fullName: domElement + langs: + - typeScript + type: property + syntax: + content: 'get domElement(): HTMLElement;' + return: + type: + - '!HTMLElement:interface' + - uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#folderInfo:member' + summary: The folder information where the item is located/should be created. + name: folderInfo + fullName: folderInfo + langs: + - typeScript + type: property + syntax: + content: 'get folderInfo(): IFolderInfo;' + return: + 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. + name: itemId + fullName: itemId + langs: + - typeScript + type: property + syntax: + content: 'get itemId(): number | undefined;' + return: + type: + - number | undefined + - uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#list:member' + summary: The list associated with the form. + name: list + fullName: list + langs: + - typeScript + type: property + syntax: + content: 'get list(): IList;' + return: + 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 new file mode 100644 index 00000000..55e472f5 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/icolumn.yml @@ -0,0 +1,130 @@ +### 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!' + 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. + name: clientSideComponentId + fullName: clientSideComponentId + langs: + - typeScript + type: property + syntax: + content: 'readonly clientSideComponentId: Guid | undefined;' + return: + 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. + name: clientSideComponentProperties + fullName: clientSideComponentProperties + langs: + - typeScript + type: property + syntax: + content: 'readonly clientSideComponentProperties: string;' + return: + 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. + name: displayName + fullName: displayName + langs: + - typeScript + type: property + syntax: + content: 'readonly displayName: string;' + return: + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IColumn#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-listview-extensibility!IColumn#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-listview-extensibility!IColumn#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-listview-extensibility!IColumn#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 + - uid: '@microsoft/sp-listview-extensibility!IColumn#isVisible:member' + summary: Whether the column is visible in the view + name: isVisible + fullName: isVisible + langs: + - typeScript + type: property + syntax: + content: 'readonly isVisible: boolean;' + return: + 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 new file mode 100644 index 00000000..9d178396 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/icontenttype.yml @@ -0,0 +1,50 @@ +### 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!' + 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 + name: id + fullName: id + langs: + - typeScript + type: property + syntax: + content: 'readonly id: string;' + return: + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IContentType#name:member' + summary: Content type name + name: name + fullName: name + langs: + - typeScript + type: property + syntax: + content: 'readonly name: string;' + return: + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IContentType#schemaXml:member' + summary: Content type schema XML + name: schemaXml + fullName: schemaXml + langs: + - typeScript + type: property + syntax: + content: 'readonly schemaXml: string | undefined;' + return: + type: + - string | undefined diff --git a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml index f7dc7547..259f3c2e 100644 --- a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml @@ -1,24 +1,24 @@ ### YamlMime:UniversalReference items: - - uid: sp-listview-extensibility.IFieldCustomizerCellEventParameters + - uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface' summary: Event parameters for BaseFieldCustomizer.onRenderCell() name: IFieldCustomizerCellEventParameters - fullName: sp-listview-extensibility.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. name: domElement - fullName: sp-listview-extensibility.IFieldCustomizerCellEventParameters.domElement + fullName: domElement langs: - typeScript type: property @@ -26,11 +26,11 @@ 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: sp-listview-extensibility.IFieldCustomizerCellEventParameters.fieldValue + fullName: fieldValue langs: - typeScript type: property @@ -39,10 +39,10 @@ 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: sp-listview-extensibility.IFieldCustomizerCellEventParameters.listItem + fullName: listItem langs: - typeScript type: property @@ -50,15 +50,15 @@ items: content: 'readonly listItem: ListItemAccessor;' return: type: - - 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 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 @@ -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/ifilter.yml b/SP-Framework/sp-listview-extensibility/ifilter.yml new file mode 100644 index 00000000..1aa3c920 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/ifilter.yml @@ -0,0 +1,47 @@ +### 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!' + 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. + name: fieldName + fullName: fieldName + langs: + - typeScript + type: property + syntax: + content: 'readonly fieldName: string;' + return: + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IFilter#values:member' + summary: Values to filter on. + name: values + fullName: values + langs: + - typeScript + type: property + syntax: + content: 'values: ReadonlyArray;' + return: + 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 new file mode 100644 index 00000000..cf7e7f57 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/ifolderinfo.yml @@ -0,0 +1,24 @@ +### 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!' + children: + - '@microsoft/sp-listview-extensibility!IFolderInfo#folderPath:member' + - uid: '@microsoft/sp-listview-extensibility!IFolderInfo#folderPath:member' + summary: Folder path. + name: folderPath + fullName: folderPath + langs: + - typeScript + type: property + syntax: + content: 'readonly folderPath: string;' + return: + type: + - string diff --git a/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml new file mode 100644 index 00000000..272cf27b --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml @@ -0,0 +1,85 @@ +### 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!' + 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. + name: contentType + fullName: contentType + langs: + - typeScript + type: property + syntax: + content: 'readonly contentType: IContentType;' + return: + 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. + name: domElement + fullName: domElement + langs: + - typeScript + type: property + syntax: + content: 'readonly domElement: HTMLElement;' + return: + type: + - '!HTMLElement:interface' + - uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#folderInfo:member' + summary: The folder information where the item is located/should be created. + name: folderInfo + fullName: folderInfo + langs: + - typeScript + type: property + syntax: + content: 'readonly folderInfo: IFolderInfo;' + return: + 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. + name: itemId + fullName: itemId + langs: + - typeScript + type: property + syntax: + content: 'readonly itemId?: number;' + return: + type: + - number + - uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#list:member' + summary: The list associated with the form. + name: list + fullName: list + langs: + - typeScript + type: property + syntax: + content: 'readonly list: IList;' + return: + 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 new file mode 100644 index 00000000..0e41bab3 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/ilist.yml @@ -0,0 +1,53 @@ +### 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!' + 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. + name: guid + fullName: guid + langs: + - typeScript + type: property + syntax: + content: 'readonly guid: Guid;' + return: + type: + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-listview-extensibility!IList#serverRelativeUrl:member' + summary: List server relative url. + name: serverRelativeUrl + fullName: serverRelativeUrl + langs: + - typeScript + type: property + syntax: + content: 'readonly serverRelativeUrl: string;' + return: + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IList#title:member' + summary: List title. + 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 diff --git a/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml b/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml new file mode 100644 index 00000000..cf3b0654 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml @@ -0,0 +1,205 @@ +### 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!' + 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. + name: appliedFilters + fullName: appliedFilters + langs: + - typeScript + type: property + syntax: + content: |- + readonly appliedFilters?: { + [fieldName: string]: IFilter; + }; + return: + type: + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#appliedFilters~0:complex' + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#columns:member' + summary: Columns information. + name: columns + fullName: columns + langs: + - typeScript + type: property + syntax: + content: 'readonly columns: ReadonlyArray;' + return: + type: + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#columns~0:complex' + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#folderInfo:member' + summary: Current folder information. + name: folderInfo + fullName: folderInfo + langs: + - typeScript + type: property + syntax: + content: 'readonly folderInfo?: IFolderInfo;' + return: + type: + - '@microsoft/sp-listview-extensibility!IFolderInfo:interface' + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#list:member' + summary: List information. + name: list + fullName: list + langs: + - typeScript + type: property + syntax: + content: 'readonly list?: IList;' + return: + type: + - '@microsoft/sp-listview-extensibility!IList:interface' + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#rows:member' + summary: Rows information. + name: rows + fullName: rows + langs: + - typeScript + type: property + syntax: + content: 'readonly rows: ReadonlyArray;' + return: + type: + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#rows~0:complex' + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#selectedRows:member' + summary: Selected rows information. + name: selectedRows + fullName: selectedRows + langs: + - typeScript + type: property + syntax: + content: 'readonly selectedRows?: ReadonlyArray;' + return: + type: + - '@microsoft/sp-listview-extensibility!IListViewAccessorState#selectedRows~0:complex' + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#sortAscending:member' + summary: Sort direction. + name: sortAscending + fullName: sortAscending + langs: + - typeScript + type: property + syntax: + content: 'readonly sortAscending?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#sortField:member' + summary: Sort field name. + name: sortField + fullName: sortField + langs: + - typeScript + type: property + syntax: + content: 'readonly sortField?: string;' + return: + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#view:member' + summary: View information. + name: view + fullName: view + langs: + - typeScript + type: property + syntax: + content: 'readonly view?: IView;' + return: + 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 fd869947..f763d95b 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml @@ -1,22 +1,24 @@ ### YamlMime:UniversalReference items: - - uid: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters - summary: 'Parameters for [BaseListViewCommandSet.onExecute](xref:sp-listview-extensibility.BaseListViewCommandSet.onExecute)' + - uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface' + summary: >- + Parameters for + [BaseListViewCommandSet.onExecute()](xref:@microsoft/sp-listview-extensibility!BaseListViewCommandSet%23onExecute:member(1)) name: IListViewCommandSetExecuteEventParameters - fullName: sp-listview-extensibility.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. name: itemId - fullName: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters.itemId + fullName: itemId langs: - typeScript type: property @@ -25,10 +27,10 @@ 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: sp-listview-extensibility.IListViewCommandSetExecuteEventParameters.selectedRows + fullName: selectedRows langs: - typeScript type: property @@ -36,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 56a04b1b..25b29ca8 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml @@ -1,21 +1,21 @@ ### 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%23onListViewUpdated:member(1)) name: IListViewCommandSetListViewUpdatedParameters - fullName: sp-listview-extensibility.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: sp-listview-extensibility.IListViewCommandSetListViewUpdatedParameters.selectedRows + fullName: selectedRows langs: - typeScript type: property @@ -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/irow.yml b/SP-Framework/sp-listview-extensibility/irow.yml new file mode 100644 index 00000000..2a27bc8e --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/irow.yml @@ -0,0 +1,55 @@ +### 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!' + 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. + name: values + fullName: values + langs: + - typeScript + type: property + syntax: + content: |- + readonly values: { + [columnInternalName: string]: Readonly; + }; + return: + 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]: + 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 new file mode 100644 index 00000000..f03265fd --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/iview.yml @@ -0,0 +1,53 @@ +### 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!' + 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. + name: id + fullName: id + langs: + - typeScript + type: property + syntax: + content: 'readonly id: Guid;' + return: + type: + - '@microsoft/sp-core-library!Guid:class' + - uid: '@microsoft/sp-listview-extensibility!IView#title:member' + summary: View title. + name: title + fullName: title + langs: + - typeScript + type: property + syntax: + content: 'readonly title: string;' + return: + type: + - string + - uid: '@microsoft/sp-listview-extensibility!IView#url:member' + summary: View server relative url. + name: url + fullName: url + langs: + - typeScript + type: property + syntax: + content: 'readonly url: string;' + return: + 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 451365be..7f34fba4 100644 --- a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml @@ -1,14 +1,10 @@ ### 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. remarks: >- - 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,43 +13,47 @@ 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: sp-listview-extensibility.ListItemAccessor + fullName: ListItemAccessor 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 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 syntax: - content: 'public readonly fields: ReadonlyArray;' + content: 'abstract get 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. name: getValue(field) - fullName: sp-listview-extensibility.ListItemAccessor.getValue + fullName: getValue(field) langs: - typeScript type: method syntax: - content: 'public abstract getValue(field: SPField): any;' + content: 'abstract getValue(field: SPField): any;' return: type: - any @@ -62,18 +62,19 @@ items: - id: field description: '' type: - - SPField - - uid: sp-listview-extensibility.ListItemAccessor.getValueByName + - '@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. name: getValueByName(internalName) - fullName: sp-listview-extensibility.ListItemAccessor.getValueByName + fullName: getValueByName(internalName) langs: - typeScript type: method syntax: - content: 'public abstract getValueByName(internalName: string): any;' + content: 'abstract getValueByName(internalName: string): any;' return: type: - any @@ -83,3 +84,21 @@ items: 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 c3d9d5f7..2298e1e7 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -1,61 +1,318 @@ ### 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 - create subclasses that extend the ListViewAccessor class. + create subclasses that extend the `ListViewAccessor` class. name: ListViewAccessor - fullName: sp-listview-extensibility.ListViewAccessor + fullName: ListViewAccessor langs: - typeScript type: class - package: sp-listview-extensibility + implements: + - '@microsoft/sp-core-library!IDisposable:interface' + 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#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. + name: appliedFilters + fullName: appliedFilters + langs: + - typeScript + type: property + syntax: + content: |- + abstract get appliedFilters(): { + [fieldName: string]: IFilter; + } | undefined; + return: + 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.' name: columns - fullName: sp-listview-extensibility.ListViewAccessor.columns + fullName: columns + langs: + - typeScript + type: property + syntax: + content: 'abstract get columns(): ReadonlyArray;' + return: + type: + - '@microsoft/sp-listview-extensibility!ListViewAccessor#columns~0:complex' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#folderInfo:member' + summary: Folder information for the list view. + name: folderInfo + fullName: folderInfo + langs: + - typeScript + type: property + syntax: + content: 'abstract get folderInfo(): IFolderInfo | undefined;' + return: + 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. + name: list + fullName: list + langs: + - typeScript + type: property + syntax: + content: 'abstract get list(): IList | undefined;' + return: + 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. + name: rows + fullName: rows langs: - typeScript type: property syntax: - content: 'public readonly columns: ReadonlyArray;' + content: 'abstract get rows(): ReadonlyArray;' return: type: - - ReadonlyArray - - uid: sp-listview-extensibility.ListViewAccessor.selectedRowsChangedEvent + - '@microsoft/sp-listview-extensibility!ListViewAccessor#rows~0:complex' + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRows:member' + summary: Selected rows in the list view. + name: selectedRows + fullName: selectedRows + langs: + - typeScript + type: property + syntax: + content: 'abstract get selectedRows(): ReadonlyArray | undefined;' + return: + 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: sp-listview-extensibility.ListViewAccessor.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. + name: sortAscending + fullName: sortAscending + langs: + - typeScript + type: property + syntax: + content: 'abstract get sortAscending(): boolean | undefined;' + return: + type: + - boolean | undefined + - uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#sortField:member' + summary: Sort field name + name: sortField + fullName: sortField langs: - typeScript type: property syntax: - content: 'public readonly selectedRowsChangedEvent: Event;' + content: 'abstract get sortField(): string | undefined;' return: type: - - Event - - uid: sp-listview-extensibility.ListViewAccessor.tryGetColumnByName + - 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. name: tryGetColumnByName(internalName) - fullName: sp-listview-extensibility.ListViewAccessor.tryGetColumnByName + fullName: tryGetColumnByName(internalName) langs: - typeScript type: method syntax: - content: 'public abstract tryGetColumnByName(internalName: string): ColumnAccessor | undefined;' + 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 + 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: 'abstract get view(): IView | undefined;' + return: + 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 new file mode 100644 index 00000000..513fc82a --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/listviewaccessorstatechanges.yml @@ -0,0 +1,83 @@ +### 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!' + 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 2dad026f..dbcb86e7 100644 --- a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml +++ b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml @@ -1,42 +1,55 @@ ### 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 - create subclasses that extend the ListViewCommandSetContext class. + create subclasses that extend the `ListViewCommandSetContext` class. name: ListViewCommandSetContext - fullName: sp-listview-extensibility.ListViewCommandSetContext + fullName: ListViewCommandSetContext langs: - typeScript type: class extends: - - 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: sp-listview-extensibility.ListViewCommandSetContext.listView + fullName: listView langs: - typeScript type: property syntax: - content: 'public readonly listView: ListViewAccessor;' + content: 'get listView(): ListViewAccessor;' return: type: - - ListViewAccessor - - uid: sp-listview-extensibility.ListViewCommandSetContext.manifest - summary: Manifest for the client side component. + - '@microsoft/sp-listview-extensibility!~ListViewAccessor:class' + - uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#manifest:member' + summary: Manifest for the client-side component. name: manifest - fullName: sp-listview-extensibility.ListViewCommandSetContext.manifest + fullName: manifest langs: - typeScript type: property syntax: - content: 'public readonly manifest: ICommandSetExtensionManifest;' + 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/listviewstatechangedeventargs.yml b/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml new file mode 100644 index 00000000..9e879552 --- /dev/null +++ b/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml @@ -0,0 +1,60 @@ +### 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!' + 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. + name: prevState + fullName: prevState + langs: + - typeScript + type: property + syntax: + content: 'prevState: Readonly;' + return: + 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. + name: stateChanges + fullName: stateChanges + langs: + - typeScript + type: property + syntax: + content: 'stateChanges: ListViewAccessorStateChanges;' + return: + 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 95bee9da..90ecb9b7 100644 --- a/SP-Framework/sp-listview-extensibility/rowaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/rowaccessor.yml @@ -1,23 +1,28 @@ ### 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: >- - 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: sp-listview-extensibility.RowAccessor + fullName: RowAccessor langs: - typeScript type: class extends: - - 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 6211057d..9388761f 100644 --- a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml @@ -1,26 +1,45 @@ ### 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: sp-listview-extensibility.SelectedRowsChangedEventArgs + fullName: SelectedRowsChangedEventArgs langs: - typeScript type: class extends: - - EventArgs - 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: sp-listview-extensibility.SelectedRowsChangedEventArgs.selectedRows + fullName: selectedRows langs: - typeScript type: property syntax: - content: 'public selectedRows: ReadonlyArray;' + 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..5cc39342 --- /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..90b727f9 --- /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..0c67e4b0 --- /dev/null +++ b/SP-Framework/sp-loader/spcomponentloader.yml @@ -0,0 +1,172 @@ +### 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. + 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: + - '@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' + optional: false + 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 + 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 + optional: true + 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 + 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. + 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 + 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: + - '@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 new file mode 100644 index 00000000..9347bef2 --- /dev/null +++ b/SP-Framework/sp-lodash-subset.yml @@ -0,0 +1,16 @@ +### 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 new file mode 100644 index 00000000..26a2fda9 --- /dev/null +++ b/SP-Framework/sp-lodash-subset/cancelable.yml @@ -0,0 +1,17 @@ +### 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 new file mode 100644 index 00000000..5f176720 --- /dev/null +++ b/SP-Framework/sp-lodash-subset/throttlesettings.yml @@ -0,0 +1,17 @@ +### 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 new file mode 100644 index 00000000..233d13c0 --- /dev/null +++ b/SP-Framework/sp-module-interfaces.yml @@ -0,0 +1,79 @@ +### 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 new file mode 100644 index 00000000..8170fb50 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/componenttype.yml @@ -0,0 +1,17 @@ +### 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 new file mode 100644 index 00000000..2a0d7e68 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/extensiontype.yml @@ -0,0 +1,17 @@ +### 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 new file mode 100644 index 00000000..bd779c6d --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml @@ -0,0 +1,221 @@ +### 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!' + 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 + isPreview: true + name: connectedSPFXAppId + fullName: connectedSPFXAppId + langs: + - typeScript + type: property + syntax: + content: 'connectedSPFXAppId?: string;' + return: + 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 + isPreview: true + name: connectedTeamsAppId + fullName: connectedTeamsAppId + langs: + - typeScript + type: property + syntax: + content: 'connectedTeamsAppId?: string;' + return: + type: + - string + - uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#experimentalData:member' + summary: An untyped property bag for experimental flags not ready for production. + isPreview: true + name: experimentalData + fullName: experimentalData + langs: + - typeScript + type: property + syntax: + content: |- + experimentalData?: { + [key: string]: any; + }; + return: + 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 + name: hiddenFromToolbox + fullName: hiddenFromToolbox + langs: + - typeScript + type: property + syntax: + content: 'hiddenFromToolbox?: boolean;' + return: + 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 + 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 + name: preconfiguredEntries + fullName: preconfiguredEntries + langs: + - typeScript + type: property + syntax: + content: 'preconfiguredEntries: IAdaptiveCardExtensionManifestEntry[];' + return: + 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 + name: supportedHosts + fullName: supportedHosts + langs: + - typeScript + type: property + syntax: + content: 'supportedHosts?: ReadonlyArray<''Dashboard''>;' + return: + 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 + name: supportsThemeVariants + fullName: supportsThemeVariants + langs: + - typeScript + type: property + syntax: + content: 'supportsThemeVariants?: boolean;' + return: + 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 + 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 + name: useFallbackWhenPropertiesUpdatedExternally + fullName: useFallbackWhenPropertiesUpdatedExternally + langs: + - typeScript + type: property + syntax: + content: 'useFallbackWhenPropertiesUpdatedExternally?: 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!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 new file mode 100644 index 00000000..d664a2de --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml @@ -0,0 +1,288 @@ +### 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!' + 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. + isPreview: true + name: cardSize + fullName: cardSize + langs: + - typeScript + type: property + syntax: + content: 'cardSize: string;' + return: + 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. + 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 + name: dataVersion + fullName: dataVersion + langs: + - typeScript + type: property + syntax: + content: 'dataVersion?: string;' + return: + 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 + 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 + 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!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 + 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!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). + 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 + name: iconImageUrl + fullName: iconImageUrl + langs: + - typeScript + type: property + syntax: + content: 'iconImageUrl?: string;' + return: + 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. + 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 + name: officeFabricIconFontName + fullName: officeFabricIconFontName + langs: + - typeScript + type: property + syntax: + content: 'officeFabricIconFontName?: string;' + return: + 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 + 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 + name: properties + fullName: properties + langs: + - typeScript + type: property + syntax: + content: 'properties: TProperties;' + return: + 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 + name: tags + fullName: tags + langs: + - typeScript + type: property + syntax: + content: 'tags?: ILocalizedString[];' + return: + 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. + 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 + 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!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 new file mode 100644 index 00000000..6adee7f3 --- /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..80942a6c --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml @@ -0,0 +1,193 @@ +### 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: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 new file mode 100644 index 00000000..02427be6 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml @@ -0,0 +1,192 @@ +### 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. 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"` + 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..1a788a84 --- /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..81336afc --- /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..3f85b038 --- /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..e94f385d --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml @@ -0,0 +1,218 @@ +### 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, + TeamsPersonalApp, or TeamsMeetingApp is added the solution will be available when using teams. TeamsMeetingApp + cannot be used with TeamsTab or TeamsPersonalTab. + name: supportedHosts + fullName: supportedHosts + langs: + - typeScript + type: property + syntax: + content: >- + supportedHosts?: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab' | 'TeamsPersonalApp' | + 'TeamsMeetingApp'>; + 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' | '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 new file mode 100644 index 00000000..0ef6f5dc --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml @@ -0,0 +1,304 @@ +### 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#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. + 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#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 + 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"` + name: fullPageAppIconImageUrl + fullName: fullPageAppIconImageUrl + langs: + - typeScript + type: property + syntax: + content: 'fullPageAppIconImageUrl?: string;' + return: + 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 + 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%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"` + 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%23iconImageUrl: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..7e88f7a6 --- /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..05532fcb --- /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..9229a6b6 --- /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..8e2cea61 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml @@ -0,0 +1,107 @@ +### 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!' + 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` + 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 | IIntegrityPath;' + 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#type:member' + isPreview: true + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''component'';' + return: + 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 + 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!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 new file mode 100644 index 00000000..60547de6 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iintegritypath.yml @@ -0,0 +1,42 @@ +### 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!' + 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). + isPreview: true + name: integrity + fullName: integrity + langs: + - typeScript + type: property + syntax: + content: 'integrity?: string;' + return: + type: + - string + - uid: '@microsoft/sp-module-interfaces!IIntegrityPath#path:member' + summary: The path to the resource. + isPreview: true + name: path + fullName: path + langs: + - typeScript + type: property + 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 new file mode 100644 index 00000000..e2c1e516 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml @@ -0,0 +1,140 @@ +### 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!' + 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. + 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 | IIntegrityPath;' + 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 | IIntegrityPath; + }; + return: + type: + - '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths~0:complex' + - uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#type:member' + isPreview: true + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''localizedPath'';' + return: + 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 new file mode 100644 index 00000000..fee348cf --- /dev/null +++ b/SP-Framework/sp-module-interfaces/ilocalizedstring.yml @@ -0,0 +1,77 @@ +### 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..cf94680b --- /dev/null +++ b/SP-Framework/sp-module-interfaces/imoduleconfiguration.yml @@ -0,0 +1,35 @@ +### 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 new file mode 100644 index 00000000..7582aac2 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml @@ -0,0 +1,61 @@ +### 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!' + 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 + 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!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. + 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..546a6790 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/ipath.yml @@ -0,0 +1,56 @@ +### 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 new file mode 100644 index 00000000..aa190f0d --- /dev/null +++ b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml @@ -0,0 +1,132 @@ +### 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!' + 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. + 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 | IIntegrityPath;' + return: + type: + - '@microsoft/sp-module-interfaces!IPathModuleConfiguration#path~0:complex' + - uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#type:member' + isPreview: true + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ''path'';' + return: + 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 new file mode 100644 index 00000000..edf31797 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/predefinedgroup.yml @@ -0,0 +1,118 @@ +### 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. + 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.Local:member' + summary: |- + Other. + + This group includes local web parts. + 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. + 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 dfadd082..a3af166c 100644 --- a/SP-Framework/sp-odata-types.yml +++ b/SP-Framework/sp-odata-types.yml @@ -1,45 +1,54 @@ ### 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. 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 children: - - 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!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: sp-odata-types.IODataBasePermission + - uid: '@microsoft/sp-odata-types!_IODataUserId:interface' + name: _IODataUserId + - 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!IODataContentType:interface' + name: IODataContentType + - uid: '@microsoft/sp-odata-types!IODataContextWebInformation:interface' name: IODataContextWebInformation - - uid: sp-odata-types.IODataList + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' + name: IODataFormsClientSideConfiguration + - 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 new file mode 100644 index 00000000..446fb384 --- /dev/null +++ b/SP-Framework/sp-odata-types/_iodatauserid.yml @@ -0,0 +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 + 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 + syntax: + content: 'NameId: string;' + return: + type: + - string + - uid: '@microsoft/sp-odata-types!_IODataUserId#NameIdIssuer:member' + 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/iodatabasepermission.yml b/SP-Framework/sp-odata-types/iodatabasepermission.yml index 89e4d8e1..ad3379fd 100644 --- a/SP-Framework/sp-odata-types/iodatabasepermission.yml +++ b/SP-Framework/sp-odata-types/iodatabasepermission.yml @@ -1,19 +1,19 @@ ### 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: sp-odata-types.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: sp-odata-types.IODataBasePermission.High + fullName: High langs: - typeScript type: property @@ -22,9 +22,9 @@ items: return: type: - number - - uid: sp-odata-types.IODataBasePermission.Low + - uid: '@microsoft/sp-odata-types!IODataBasePermission#Low:member' 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 77af5753..c9d15958 100644 --- a/SP-Framework/sp-odata-types/iodatachangetoken.yml +++ b/SP-Framework/sp-odata-types/iodatachangetoken.yml @@ -1,21 +1,21 @@ ### 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) name: IODataChangeToken - fullName: sp-odata-types.IODataChangeToken + fullName: IODataChangeToken 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 - summary: 'Example: { StringValue: "1;3;9fb9199b-65f2-4a4a-b597-11d1a44422c1;635892156279130000;10721" }' + - '@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: sp-odata-types.IODataChangeToken.StringValue + fullName: StringValue langs: - typeScript type: property diff --git a/SP-Framework/sp-odata-types/iodatacontenttype.yml b/SP-Framework/sp-odata-types/iodatacontenttype.yml new file mode 100644 index 00000000..86b56a56 --- /dev/null +++ b/SP-Framework/sp-odata-types/iodatacontenttype.yml @@ -0,0 +1,163 @@ +### 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!' + 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 + name: ClientFormCustomFormatter + fullName: ClientFormCustomFormatter + langs: + - typeScript + type: property + syntax: + content: 'ClientFormCustomFormatter: string;' + return: + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContentType#Description:member' + summary: Content type description + name: Description + fullName: Description + langs: + - typeScript + type: property + syntax: + content: 'Description: string;' + return: + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContentType#DisplayFormUrl:member' + summary: Content type display form URL + name: DisplayFormUrl + fullName: DisplayFormUrl + langs: + - typeScript + type: property + syntax: + content: 'DisplayFormUrl: string;' + return: + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContentType#EditFormUrl:member' + summary: Content type edit form URL + name: EditFormUrl + fullName: EditFormUrl + langs: + - typeScript + type: property + syntax: + content: 'EditFormUrl: string;' + return: + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContentType#Group:member' + summary: Content type group + name: Group + fullName: Group + langs: + - typeScript + type: property + syntax: + content: 'Group: string;' + return: + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContentType#Id:member' + summary: Content type ID + name: Id + fullName: Id + langs: + - typeScript + type: property + syntax: + content: 'Id: IODataContentTypeId;' + return: + type: + - '@microsoft/sp-odata-types!IODataContentTypeId:interface' + - uid: '@microsoft/sp-odata-types!IODataContentType#Name:member' + summary: Content type name + name: Name + fullName: Name + langs: + - typeScript + type: property + syntax: + content: 'Name: string;' + return: + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContentType#NewFormUrl:member' + summary: Content type new form URL + name: NewFormUrl + fullName: NewFormUrl + langs: + - typeScript + type: property + syntax: + content: 'NewFormUrl: string;' + return: + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContentType#ReadOnly:member' + summary: Specifies whether content type is read-only + name: ReadOnly + fullName: ReadOnly + langs: + - typeScript + type: property + syntax: + content: 'ReadOnly: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-odata-types!IODataContentType#SchemaXml:member' + summary: Content type schema XML + name: SchemaXml + fullName: SchemaXml + langs: + - typeScript + type: property + syntax: + content: 'SchemaXml: string;' + return: + type: + - string + - uid: '@microsoft/sp-odata-types!IODataContentType#StringId:member' + summary: Content type string id + name: StringId + fullName: StringId + langs: + - typeScript + type: property + syntax: + content: 'StringId: string;' + return: + 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 c9094cc3..8efafecf 100644 --- a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml +++ b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml @@ -1,50 +1,24 @@ ### 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) name: IODataContextWebInformation - fullName: sp-odata-types.IODataContextWebInformation + fullName: IODataContextWebInformation langs: - typeScript type: interface - package: sp-odata-types + package: '@microsoft/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"' + - '@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: sp-odata-types.IODataContextWebInformation.LibraryVersion + fullName: LibraryVersion langs: - typeScript type: property @@ -53,10 +27,10 @@ items: return: type: - string - - uid: sp-odata-types.IODataContextWebInformation.SiteFullUrl - summary: 'Example: "http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite"' + - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#SiteFullUrl:member' + summary: 'Example: `"http:\u002f\u002fexample.com\u002fsites\u002fPubSite"`' name: SiteFullUrl - fullName: sp-odata-types.IODataContextWebInformation.SiteFullUrl + fullName: SiteFullUrl langs: - typeScript type: property @@ -65,10 +39,10 @@ items: return: type: - string - - uid: sp-odata-types.IODataContextWebInformation.SupportedSchemaVersions - summary: 'Example: \[ "14.0.0.0", "15.0.0.0" \]' + - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#SupportedSchemaVersions:member' + summary: 'Example: `[ "14.0.0.0", "15.0.0.0" ]`' name: SupportedSchemaVersions - fullName: sp-odata-types.IODataContextWebInformation.SupportedSchemaVersions + fullName: SupportedSchemaVersions langs: - typeScript type: property @@ -77,10 +51,10 @@ items: return: type: - 'string[]' - - uid: sp-odata-types.IODataContextWebInformation.WebFullUrl - summary: 'Example: "http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite"' + - uid: '@microsoft/sp-odata-types!IODataContextWebInformation#WebFullUrl:member' + 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/iodataformsclientsideconfiguration.yml b/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml new file mode 100644 index 00000000..d52ab81b --- /dev/null +++ b/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml @@ -0,0 +1,128 @@ +### 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!' + 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)' + name: DislpayFormClientSideDisplayTarget + fullName: DislpayFormClientSideDisplayTarget + langs: + - typeScript + type: property + syntax: + content: 'DislpayFormClientSideDisplayTarget: string | undefined;' + return: + type: + - string | undefined + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#DisplayFormClientSideComponentId:member' + summary: Display Form Customizer component id + name: DisplayFormClientSideComponentId + fullName: DisplayFormClientSideComponentId + langs: + - typeScript + type: property + syntax: + content: 'DisplayFormClientSideComponentId: string | undefined;' + return: + type: + - string | undefined + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#DisplayFormClientSideComponentProperties:member' + summary: Display Form Customizer component properties + name: DisplayFormClientSideComponentProperties + fullName: DisplayFormClientSideComponentProperties + langs: + - typeScript + type: property + syntax: + content: 'DisplayFormClientSideComponentProperties: string | undefined;' + return: + type: + - string | undefined + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#EditFormClientSideComponentId:member' + summary: Edit Form Customizer component id + name: EditFormClientSideComponentId + fullName: EditFormClientSideComponentId + langs: + - typeScript + type: property + syntax: + content: 'EditFormClientSideComponentId: string | undefined;' + return: + type: + - string | undefined + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#EditFormClientSideComponentProperties:member' + summary: Edit Form Customizer component properties + name: EditFormClientSideComponentProperties + fullName: EditFormClientSideComponentProperties + langs: + - typeScript + type: property + syntax: + content: 'EditFormClientSideComponentProperties: string | undefined;' + return: + type: + - string | undefined + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#EditFormClientSideDisplayTarget:member' + summary: 'Edit Form display target (new tab, panel)' + name: EditFormClientSideDisplayTarget + fullName: EditFormClientSideDisplayTarget + langs: + - typeScript + type: property + syntax: + content: 'EditFormClientSideDisplayTarget: string | undefined;' + return: + type: + - string | undefined + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#NewFormClientSideComponentId:member' + summary: New Form Customizer component id + name: NewFormClientSideComponentId + fullName: NewFormClientSideComponentId + langs: + - typeScript + type: property + syntax: + content: 'NewFormClientSideComponentId: string | undefined;' + return: + type: + - string | undefined + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#NewFormClientSideComponentProperties:member' + summary: New Form Customizer component properties + name: NewFormClientSideComponentProperties + fullName: NewFormClientSideComponentProperties + langs: + - typeScript + type: property + syntax: + content: 'NewFormClientSideComponentProperties: string | undefined;' + return: + type: + - string | undefined + - uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#NewFormClientSideDisplayTarget:member' + summary: 'New Form display target (new tab, panel)' + name: NewFormClientSideDisplayTarget + fullName: NewFormClientSideDisplayTarget + langs: + - typeScript + type: property + 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 19027da6..ec7b82e5 100644 --- a/SP-Framework/sp-odata-types/iodatalist.yml +++ b/SP-Framework/sp-odata-types/iodatalist.yml @@ -1,33 +1,37 @@ ### 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](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) name: IODataList - fullName: sp-odata-types.IODataList + fullName: IODataList langs: - typeScript type: interface - package: sp-odata-types + extends: + - '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' + inheritance: + - type: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' + 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: sp-odata-types.IODataList.BaseTemplate + fullName: BaseTemplate langs: - typeScript type: property @@ -36,10 +40,10 @@ items: return: type: - number - - uid: sp-odata-types.IODataList.Created - summary: 'Example: "/Date(1453294804000)/"' + - uid: '@microsoft/sp-odata-types!IODataList#Created:member' + summary: 'Example: `"/Date(1453294804000)/"`' name: Created - fullName: sp-odata-types.IODataList.Created + fullName: Created langs: - typeScript type: property @@ -48,10 +52,10 @@ 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: sp-odata-types.IODataList.CurrentChangeToken + fullName: CurrentChangeToken langs: - typeScript type: property @@ -59,11 +63,11 @@ items: content: 'CurrentChangeToken: IODataChangeToken;' return: type: - - 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: sp-odata-types.IODataList.Description + fullName: Description langs: - typeScript type: property @@ -72,10 +76,10 @@ items: return: type: - string - - uid: sp-odata-types.IODataList.EntityTypeName - summary: 'Example: "MyListTitleList"' + - uid: '@microsoft/sp-odata-types!IODataList#EntityTypeName:member' + summary: 'Example: `"MyListTitleList"`' name: EntityTypeName - fullName: sp-odata-types.IODataList.EntityTypeName + fullName: EntityTypeName langs: - typeScript type: property @@ -84,12 +88,12 @@ 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. name: Hidden - fullName: sp-odata-types.IODataList.Hidden + fullName: Hidden langs: - typeScript type: property @@ -98,10 +102,10 @@ items: return: type: - boolean - - uid: sp-odata-types.IODataList.Id - summary: 'Example: "/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/"' + - uid: '@microsoft/sp-odata-types!IODataList#Id:member' + summary: 'Example: `"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/"`' name: Id - fullName: sp-odata-types.IODataList.Id + fullName: Id langs: - typeScript type: property @@ -110,10 +114,10 @@ items: return: type: - string - - uid: sp-odata-types.IODataList.LastItemDeletedDate - summary: 'Example: "/Date(1453294809000)/"' + - uid: '@microsoft/sp-odata-types!IODataList#LastItemDeletedDate:member' + summary: 'Example: `"/Date(1453294809000)/"`' name: LastItemDeletedDate - fullName: sp-odata-types.IODataList.LastItemDeletedDate + fullName: LastItemDeletedDate langs: - typeScript type: property @@ -122,10 +126,10 @@ items: return: type: - string - - uid: sp-odata-types.IODataList.LastItemModifiedDate - summary: 'Example: "/Date(1453294809000)/"' + - uid: '@microsoft/sp-odata-types!IODataList#LastItemModifiedDate:member' + summary: 'Example: `"/Date(1453294809000)/"`' name: LastItemModifiedDate - fullName: sp-odata-types.IODataList.LastItemModifiedDate + fullName: LastItemModifiedDate langs: - typeScript type: property @@ -134,10 +138,10 @@ items: return: type: - string - - uid: sp-odata-types.IODataList.ListItemEntityTypeFullName - summary: 'Example: "SP.Data.MyListTitleListItem"' + - uid: '@microsoft/sp-odata-types!IODataList#ListItemEntityTypeFullName:member' + summary: 'Example: `"SP.Data.MyListTitleListItem"`' name: ListItemEntityTypeFullName - fullName: sp-odata-types.IODataList.ListItemEntityTypeFullName + fullName: ListItemEntityTypeFullName langs: - typeScript type: property @@ -146,10 +150,10 @@ items: return: type: - string - - uid: sp-odata-types.IODataList.ParentWebUrl - summary: 'Example: "/sites/PubSite"' + - uid: '@microsoft/sp-odata-types!IODataList#ParentWebUrl:member' + summary: 'Example: `"/sites/PubSite"`' name: ParentWebUrl - fullName: sp-odata-types.IODataList.ParentWebUrl + fullName: ParentWebUrl langs: - typeScript type: property @@ -158,10 +162,10 @@ items: return: type: - string - - uid: sp-odata-types.IODataList.TemplateFeatureId - summary: 'Example: "/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/"' + - uid: '@microsoft/sp-odata-types!IODataList#TemplateFeatureId:member' + summary: 'Example: `"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/"`' name: TemplateFeatureId - fullName: sp-odata-types.IODataList.TemplateFeatureId + fullName: TemplateFeatureId langs: - typeScript type: property @@ -170,10 +174,10 @@ items: return: type: - string - - uid: sp-odata-types.IODataList.Title - summary: 'Example: "Pages"' + - uid: '@microsoft/sp-odata-types!IODataList#Title:member' + summary: 'Example: `"Pages"`' name: Title - fullName: sp-odata-types.IODataList.Title + fullName: Title langs: - typeScript type: property @@ -182,3 +186,8 @@ items: return: 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 ed71bb26..3579d6a0 100644 --- a/SP-Framework/sp-odata-types/iodatalistitem.yml +++ b/SP-Framework/sp-odata-types/iodatalistitem.yml @@ -1,35 +1,41 @@ ### 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](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) name: IODataListItem - fullName: sp-odata-types.IODataListItem + fullName: IODataListItem 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 - summary: 'Example: { StringValue: "0x010100C5..." }' + - '@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: sp-odata-types.IODataListItem.ContentTypeId + fullName: ContentTypeId langs: - typeScript type: property syntax: - content: 'ContentTypeId:' + content: |- + ContentTypeId: { + StringValue: string; + }; return: type: - - '{ StringValue: string }' - - uid: sp-odata-types.IODataListItem.ID + - |- + { + StringValue: string; + } + - uid: '@microsoft/sp-odata-types!IODataListItem#ID:member' name: ID - fullName: sp-odata-types.IODataListItem.ID + fullName: ID langs: - typeScript type: property @@ -38,10 +44,10 @@ 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: sp-odata-types.IODataListItem.Title + fullName: Title langs: - typeScript type: property @@ -50,10 +56,10 @@ items: return: type: - string - - uid: sp-odata-types.IODataListItem.UniqueId - summary: 'Example: "/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"' + - uid: '@microsoft/sp-odata-types!IODataListItem#UniqueId:member' + 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 47708890..bfe4eb27 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnode.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnode.yml @@ -1,25 +1,27 @@ ### 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' + - 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: sp-odata-types.IODataNavigationNode + fullName: IODataNavigationNode 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: sp-odata-types.IODataNavigationNode.Children + fullName: Children langs: - typeScript type: property @@ -27,11 +29,11 @@ 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: sp-odata-types.IODataNavigationNode.Id + fullName: Id langs: - typeScript type: property @@ -40,9 +42,9 @@ items: return: type: - number - - uid: sp-odata-types.IODataNavigationNode.IsDocLib + - uid: '@microsoft/sp-odata-types!IODataNavigationNode#IsDocLib:member' name: IsDocLib - fullName: sp-odata-types.IODataNavigationNode.IsDocLib + fullName: IsDocLib langs: - typeScript type: property @@ -51,12 +53,12 @@ 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. name: IsExternal - fullName: sp-odata-types.IODataNavigationNode.IsExternal + fullName: IsExternal langs: - typeScript type: property @@ -65,10 +67,10 @@ 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: sp-odata-types.IODataNavigationNode.IsVisible + fullName: IsVisible langs: - typeScript type: property @@ -77,10 +79,10 @@ 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: sp-odata-types.IODataNavigationNode.Title + fullName: Title langs: - typeScript type: property @@ -89,12 +91,12 @@ 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. name: Url - fullName: sp-odata-types.IODataNavigationNode.Url + fullName: Url langs: - typeScript type: property @@ -103,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 f44f0c2c..1a73ca6b 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml @@ -1,22 +1,22 @@ ### 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](https://msdn.microsoft.com/en-us/library/office/ee557907.aspx) name: IODataNavigationNodeCollection - fullName: sp-odata-types.IODataNavigationNodeCollection + fullName: IODataNavigationNodeCollection 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: sp-odata-types.IODataNavigationNodeCollection.quickLaunch + fullName: quickLaunch langs: - typeScript type: property @@ -24,11 +24,11 @@ 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: sp-odata-types.IODataNavigationNodeCollection.topNav + fullName: topNav langs: - typeScript type: property @@ -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 15fc641e..b906f692 100644 --- a/SP-Framework/sp-odata-types/iodatauser.yml +++ b/SP-Framework/sp-odata-types/iodatauser.yml @@ -1,27 +1,27 @@ ### 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](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) name: IODataUser - fullName: sp-odata-types.IODataUser + fullName: IODataUser 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 - summary: 'Example: "someone@example.com"' + - '@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: sp-odata-types.IODataUser.Email + fullName: Email langs: - typeScript type: property @@ -30,9 +30,9 @@ items: return: type: - string - - uid: sp-odata-types.IODataUser.Id + - uid: '@microsoft/sp-odata-types!IODataUser#Id:member' name: Id - fullName: sp-odata-types.IODataUser.Id + fullName: Id langs: - typeScript type: property @@ -41,10 +41,10 @@ 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: sp-odata-types.IODataUser.IsSiteAdmin + fullName: IsSiteAdmin langs: - typeScript type: property @@ -53,10 +53,10 @@ items: return: type: - boolean - - uid: sp-odata-types.IODataUser.LoginName - summary: 'Example: "i:0\#.w\|domain\\user"' + - uid: '@microsoft/sp-odata-types!IODataUser#LoginName:member' + summary: 'Example: `"i:0#.w|domain\user"`' name: LoginName - fullName: sp-odata-types.IODataUser.LoginName + fullName: LoginName langs: - typeScript type: property @@ -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: @@ -82,7 +82,7 @@ items: All: 15 name: PrincipalType - fullName: sp-odata-types.IODataUser.PrincipalType + fullName: PrincipalType langs: - typeScript type: property @@ -91,10 +91,10 @@ items: return: type: - number - - uid: sp-odata-types.IODataUser.Title - summary: 'Example: "DOMAIN\\user"' + - uid: '@microsoft/sp-odata-types!IODataUser#Title:member' + summary: 'Example: `"DOMAIN\user"`' name: Title - fullName: sp-odata-types.IODataUser.Title + fullName: Title langs: - typeScript type: property @@ -103,12 +103,12 @@ 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. name: UserId - fullName: sp-odata-types.IODataUser.UserId + fullName: UserId langs: - typeScript type: property @@ -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 6a5bb538..74421167 100644 --- a/SP-Framework/sp-odata-types/iodatausercustomaction.yml +++ b/SP-Framework/sp-odata-types/iodatausercustomaction.yml @@ -1,39 +1,40 @@ ### 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: 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 + fullName: IODataUserCustomAction 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"' + remarks: 'Example: `"359af2a7-b73c-4aac-874c-60a865da0be7"`' name: ClientSideComponentId - fullName: sp-odata-types.IODataUserCustomAction.ClientSideComponentId + fullName: ClientSideComponentId langs: - typeScript type: property @@ -42,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 @@ -50,9 +51,9 @@ items: client-side component. - Example: "{ \\"maxItemsToShow\\": 123 }" + Example: `"{ \"maxItemsToShow\": 123 }"` name: ClientSideComponentProperties - fullName: sp-odata-types.IODataUserCustomAction.ClientSideComponentProperties + fullName: ClientSideComponentProperties langs: - typeScript type: property @@ -61,12 +62,12 @@ 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. name: CommandUIExtension - fullName: sp-odata-types.IODataUserCustomAction.CommandUIExtension + fullName: CommandUIExtension langs: - typeScript type: property @@ -75,10 +76,10 @@ 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: sp-odata-types.IODataUserCustomAction.Description + fullName: Description langs: - typeScript type: property @@ -87,12 +88,12 @@ 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. name: Group - fullName: sp-odata-types.IODataUserCustomAction.Group + fullName: Group langs: - typeScript type: property @@ -101,12 +102,12 @@ 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" + `"48309f28-53aa-43ed-b113-625120e5af6f"` name: Id - fullName: sp-odata-types.IODataUserCustomAction.Id + fullName: Id langs: - typeScript type: property @@ -115,10 +116,10 @@ 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: sp-odata-types.IODataUserCustomAction.ImageUrl + fullName: ImageUrl langs: - typeScript type: property @@ -127,11 +128,11 @@ 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"' + remarks: 'Example: `"ClientSide.Application"`' name: Location - fullName: sp-odata-types.IODataUserCustomAction.Location + fullName: Location langs: - typeScript type: property @@ -140,10 +141,10 @@ 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: sp-odata-types.IODataUserCustomAction.RegistrationId + fullName: RegistrationId langs: - typeScript type: property @@ -152,13 +153,13 @@ 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 = 4. name: RegistrationType - fullName: sp-odata-types.IODataUserCustomAction.RegistrationType + fullName: RegistrationType langs: - typeScript type: property @@ -167,10 +168,10 @@ 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: sp-odata-types.IODataUserCustomAction.Rights + fullName: Rights langs: - typeScript type: property @@ -178,11 +179,11 @@ items: content: 'Rights: IODataBasePermission;' return: type: - - 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: sp-odata-types.IODataUserCustomAction.Scope + fullName: Scope langs: - typeScript type: property @@ -191,10 +192,10 @@ 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: sp-odata-types.IODataUserCustomAction.ScriptBlock + fullName: ScriptBlock langs: - typeScript type: property @@ -203,10 +204,10 @@ 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: sp-odata-types.IODataUserCustomAction.ScriptSrc + fullName: ScriptSrc langs: - typeScript type: property @@ -215,12 +216,12 @@ 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. name: Sequence - fullName: sp-odata-types.IODataUserCustomAction.Sequence + fullName: Sequence langs: - typeScript type: property @@ -229,10 +230,10 @@ 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: sp-odata-types.IODataUserCustomAction.Title + fullName: Title langs: - typeScript type: property @@ -241,10 +242,10 @@ 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: sp-odata-types.IODataUserCustomAction.Url + fullName: Url langs: - typeScript type: property @@ -253,11 +254,11 @@ 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"' + remarks: 'Example: `"16.0.1.0"`' name: VersionOfUserCustomAction - fullName: sp-odata-types.IODataUserCustomAction.VersionOfUserCustomAction + fullName: VersionOfUserCustomAction langs: - typeScript type: property @@ -266,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 8b5a873b..e6352b65 100644 --- a/SP-Framework/sp-odata-types/iodataweb.yml +++ b/SP-Framework/sp-odata-types/iodataweb.yml @@ -1,38 +1,41 @@ ### 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](https://msdn.microsoft.com/en-us/library/office/jj860569.aspx) name: IODataWeb - fullName: sp-odata-types.IODataWeb + fullName: IODataWeb 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 - summary: 'Gets a value that specifies when the site was created. Example: "/Date(2016,0,20,12,58,7,0)/"' + - '@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: sp-odata-types.IODataWeb.Created + fullName: Created langs: - typeScript type: property @@ -41,10 +44,10 @@ 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: sp-odata-types.IODataWeb.CurrentChangeToken + fullName: CurrentChangeToken langs: - typeScript type: property @@ -52,13 +55,14 @@ items: content: 'CurrentChangeToken?: IODataChangeToken;' return: 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" + - '@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: sp-odata-types.IODataWeb.CustomMasterUrl + fullName: CustomMasterUrl langs: - typeScript type: property @@ -67,10 +71,10 @@ 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: sp-odata-types.IODataWeb.Description + fullName: Description langs: - typeScript type: property @@ -79,12 +83,13 @@ items: return: 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)/" + - 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: sp-odata-types.IODataWeb.Id + fullName: Id langs: - typeScript type: property @@ -93,10 +98,10 @@ 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: sp-odata-types.IODataWeb.IsMultilingual + fullName: IsMultilingual langs: - typeScript type: property @@ -105,10 +110,13 @@ items: return: 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' + - 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: sp-odata-types.IODataWeb.Language + fullName: Language langs: - typeScript type: property @@ -117,10 +125,13 @@ items: return: 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)/"' + - 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: sp-odata-types.IODataWeb.LastItemModifiedDate + fullName: LastItemModifiedDate langs: - typeScript type: property @@ -129,12 +140,13 @@ items: return: 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" + - 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: sp-odata-types.IODataWeb.MasterUrl + fullName: MasterUrl langs: - typeScript type: property @@ -143,10 +155,10 @@ 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: sp-odata-types.IODataWeb.NoCrawl + fullName: NoCrawl langs: - typeScript type: property @@ -155,10 +167,10 @@ 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: sp-odata-types.IODataWeb.QuickLaunchEnabled + fullName: QuickLaunchEnabled langs: - typeScript type: property @@ -167,10 +179,10 @@ 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: sp-odata-types.IODataWeb.RecycleBinEnabled + fullName: RecycleBinEnabled langs: - typeScript type: property @@ -179,10 +191,13 @@ items: return: type: - boolean - - uid: sp-odata-types.IODataWeb.ServerRelativeUrl - summary: 'Gets or sets the server-relative URL for the Web site. Example: "/sites/PubSite"' + - 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: sp-odata-types.IODataWeb.ServerRelativeUrl + fullName: ServerRelativeUrl langs: - typeScript type: property @@ -191,10 +206,10 @@ 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: sp-odata-types.IODataWeb.SiteLogoUrl + fullName: SiteLogoUrl langs: - typeScript type: property @@ -203,10 +218,10 @@ 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: sp-odata-types.IODataWeb.Title + fullName: Title langs: - typeScript type: property @@ -215,10 +230,13 @@ items: return: type: - string - - uid: sp-odata-types.IODataWeb.UIVersion - summary: 'Gets or sets the user interface (UI) version of the Web site. Example: 15' + - 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: sp-odata-types.IODataWeb.UIVersion + fullName: UIVersion langs: - typeScript type: property @@ -227,10 +245,13 @@ items: return: type: - number - - uid: sp-odata-types.IODataWeb.Url - summary: 'Gets the absolute URL for the website. Example: "http://example.com/sites/PubSite"' + - 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: sp-odata-types.IODataWeb.Url + fullName: Url langs: - typeScript type: property @@ -239,10 +260,13 @@ items: return: 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"' + - 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: sp-odata-types.IODataWeb.WebTemplate + fullName: WebTemplate langs: - typeScript type: property @@ -251,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 f45a2de0..dc8a9fc8 100644 --- a/SP-Framework/sp-page-context.yml +++ b/SP-Framework/sp-page-context.yml @@ -1,41 +1,85 @@ ### 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 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 children: - - sp-page-context.CultureInfo - - sp-page-context.PageContext - - sp-page-context.SPField - - sp-page-context.SPList - - sp-page-context.SPListItem - - sp-page-context.SPPermission - - sp-page-context.SPSite - - 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: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: sp-page-context.CultureInfo + - uid: '@microsoft/sp-page-context!CultureInfo:class' name: CultureInfo - - uid: sp-page-context.PageContext + - 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: sp-page-context.SPField + - uid: '@microsoft/sp-page-context!SPDayOfWeek:type' + name: SPDayOfWeek + - 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.SPUser + - uid: '@microsoft/sp-page-context!SPTimeZone:class' + name: SPTimeZone + - 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 1aa7b7b4..76ac90ca 100644 --- a/SP-Framework/sp-page-context/cultureinfo.yml +++ b/SP-Framework/sp-page-context/cultureinfo.yml @@ -1,23 +1,23 @@ ### 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 + 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. + create subclasses that extend the `CultureInfo` class. name: CultureInfo - fullName: sp-page-context.CultureInfo + fullName: CultureInfo 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. @@ -25,45 +25,45 @@ 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 + fullName: currentCultureName langs: - typeScript type: property syntax: - content: 'public readonly currentCultureName: string;' + content: 'readonly currentCultureName: string;' 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. - 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 + fullName: currentUICultureName langs: - typeScript type: property syntax: - content: 'public readonly currentUICultureName: string;' + content: 'readonly currentUICultureName: string;' 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: sp-page-context.CultureInfo.isRightToLeft + fullName: isRightToLeft langs: - typeScript type: property syntax: - content: 'public readonly isRightToLeft: boolean;' + 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 new file mode 100644 index 00000000..183402af --- /dev/null +++ b/SP-Framework/sp-page-context/ispsystemtime.yml @@ -0,0 +1,116 @@ +### 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!' + 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 + syntax: + content: 'Day: number;' + return: + type: + - number + - uid: '@microsoft/sp-page-context!ISPSystemTime#DayOfWeek:member' + isPreview: true + name: DayOfWeek + fullName: DayOfWeek + langs: + - typeScript + type: property + syntax: + content: 'DayOfWeek: number;' + return: + type: + - number + - uid: '@microsoft/sp-page-context!ISPSystemTime#Hour:member' + isPreview: true + name: Hour + fullName: Hour + langs: + - typeScript + type: property + syntax: + content: 'Hour: number;' + return: + type: + - number + - uid: '@microsoft/sp-page-context!ISPSystemTime#Milliseconds:member' + isPreview: true + name: Milliseconds + fullName: Milliseconds + langs: + - typeScript + type: property + syntax: + content: 'Milliseconds: number;' + return: + type: + - number + - uid: '@microsoft/sp-page-context!ISPSystemTime#Minute:member' + isPreview: true + name: Minute + fullName: Minute + langs: + - typeScript + type: property + syntax: + content: 'Minute: number;' + return: + type: + - number + - uid: '@microsoft/sp-page-context!ISPSystemTime#Month:member' + isPreview: true + name: Month + fullName: Month + langs: + - typeScript + type: property + syntax: + content: 'Month: number;' + return: + type: + - number + - uid: '@microsoft/sp-page-context!ISPSystemTime#Second:member' + isPreview: true + name: Second + fullName: Second + langs: + - typeScript + type: property + syntax: + content: 'Second: number;' + return: + type: + - number + - uid: '@microsoft/sp-page-context!ISPSystemTime#Year:member' + isPreview: true + name: Year + fullName: 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..d59a6b37 --- /dev/null +++ b/SP-Framework/sp-page-context/isptimezonedata.yml @@ -0,0 +1,106 @@ +### 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!' + 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 + syntax: + content: 'daylightDate: ISPSystemTime;' + return: + type: + - '@microsoft/sp-page-context!ISPSystemTime:interface' + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#daylightOffset:member' + isPreview: true + name: daylightOffset + fullName: daylightOffset + langs: + - typeScript + type: property + syntax: + content: 'daylightOffset: number;' + return: + type: + - number + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#description:member' + isPreview: true + name: description + fullName: description + langs: + - typeScript + type: property + syntax: + content: 'description: string;' + return: + type: + - string + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#id:member' + isPreview: true + name: id + fullName: id + langs: + - typeScript + type: property + syntax: + content: 'id: number;' + return: + type: + - number + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#offset:member' + isPreview: true + name: offset + fullName: offset + langs: + - typeScript + type: property + syntax: + content: 'offset: number;' + return: + type: + - number + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardDate:member' + isPreview: true + name: standardDate + fullName: standardDate + langs: + - typeScript + type: property + syntax: + content: 'standardDate: ISPSystemTime;' + return: + type: + - '@microsoft/sp-page-context!ISPSystemTime:interface' + - uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardOffset:member' + isPreview: true + name: standardOffset + fullName: standardOffset + langs: + - typeScript + type: property + syntax: + content: 'standardOffset: number;' + 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 dfbd40d3..dc00db07 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -1,32 +1,34 @@ ### YamlMime:UniversalReference items: - - uid: sp-page-context.PageContext - summary: >- + - 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: sp-page-context.PageContext + fullName: PageContext langs: - typeScript type: class - package: sp-page-context + package: '@microsoft/sp-page-context!' children: - - sp-page-context.PageContext.constructor - - 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 - summary: 'Constructs a new instance of the [PageContext](xref:sp-page-context.PageContext) class' - name: constructor(serviceScope) - fullName: 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) langs: - typeScript type: constructor @@ -36,131 +38,192 @@ items: - id: serviceScope description: '' type: - - ServiceScope - - uid: sp-page-context.PageContext.cultureInfo + - '@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. + name: aadInfo + fullName: aadInfo + langs: + - typeScript + type: property + syntax: + content: 'get 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. + `PageContext` class. name: cultureInfo - fullName: sp-page-context.PageContext.cultureInfo + fullName: cultureInfo langs: - typeScript type: property syntax: - content: 'public readonly cultureInfo: CultureInfo;' + content: 'get cultureInfo(): CultureInfo;' return: type: - - CultureInfo - - uid: sp-page-context.PageContext.isInitialized - summary: Returns whether the PageContext has been initialized. + - '@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: sp-page-context.PageContext.isInitialized + fullName: isInitialized langs: - typeScript type: property syntax: - content: 'public readonly isInitialized: boolean;' + content: 'get isInitialized(): boolean;' 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 - 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 + fullName: legacyPageContext langs: - typeScript type: property syntax: - content: 'public readonly legacyPageContext: any;' + content: 'get legacyPageContext(): any;' 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. name: list - fullName: sp-page-context.PageContext.list + fullName: list langs: - typeScript type: property syntax: - content: 'public readonly list: SPList | undefined;' + content: 'get 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. name: listItem - fullName: sp-page-context.PageContext.listItem + fullName: listItem langs: - typeScript type: property syntax: - content: 'public readonly listItem: SPListItem | undefined;' + content: 'get 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: sp-page-context.PageContext.serviceKey + fullName: serviceKey langs: - typeScript type: property syntax: - content: 'public static readonly serviceKey: ServiceKey;' + content: 'static readonly serviceKey: ServiceKey;' return: type: - - ServiceKey - - uid: sp-page-context.PageContext.site - summary: Contextual information for the SharePoint site collection ("site") that is hosting the page. + - '@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: sp-page-context.PageContext.site + fullName: site langs: - typeScript type: property syntax: - content: 'public readonly site: SPSite;' + content: 'get site(): SPSite;' return: type: - - 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. + used with the `PageContext` class. name: user - fullName: sp-page-context.PageContext.user + fullName: user langs: - typeScript type: property syntax: - content: 'public readonly user: SPUser;' + content: 'get user(): SPUser;' return: type: - - SPUser - - uid: sp-page-context.PageContext.web - summary: Contextual information for the SharePoint site ("web") that is hosting the page. + - '@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: sp-page-context.PageContext.web + fullName: web langs: - typeScript type: property syntax: - content: 'public readonly web: SPWeb;' + content: 'get web(): SPWeb;' return: type: - - 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-typealias.yml b/SP-Framework/sp-page-context/spdayofweek-typealias.yml new file mode 100644 index 00000000..0e73aadd --- /dev/null +++ b/SP-Framework/sp-page-context/spdayofweek-typealias.yml @@ -0,0 +1,33 @@ +### 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/spdayofweek.yml b/SP-Framework/sp-page-context/spdayofweek.yml new file mode 100644 index 00000000..3f31e238 --- /dev/null +++ b/SP-Framework/sp-page-context/spdayofweek.yml @@ -0,0 +1,45 @@ +### 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!' + summary: '' + numericValue: 5 + - name: Monday + uid: '@microsoft/sp-page-context!SPDayOfWeek.Monday:member' + package: '@microsoft/sp-page-context!' + summary: '' + numericValue: 1 + - name: Saturday + uid: '@microsoft/sp-page-context!SPDayOfWeek.Saturday:member' + package: '@microsoft/sp-page-context!' + summary: '' + numericValue: 6 + - name: Sunday + uid: '@microsoft/sp-page-context!SPDayOfWeek.Sunday:member' + package: '@microsoft/sp-page-context!' + summary: '' + numericValue: 0 + - name: Thursday + uid: '@microsoft/sp-page-context!SPDayOfWeek.Thursday:member' + package: '@microsoft/sp-page-context!' + summary: '' + numericValue: 4 + - name: Tuesday + uid: '@microsoft/sp-page-context!SPDayOfWeek.Tuesday:member' + package: '@microsoft/sp-page-context!' + summary: '' + numericValue: 2 + - 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 9d71e90f..2bfb06ba 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -1,110 +1,124 @@ ### 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. + - 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. + create subclasses that extend the `SPField` class. name: SPField - fullName: sp-page-context.SPField + fullName: SPField 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: sp-page-context.SPField.clientSideComponentId + fullName: clientSideComponentId langs: - typeScript type: property syntax: - content: 'public readonly clientSideComponentId: Guid | undefined;' + content: 'readonly clientSideComponentId: Guid | undefined;' return: 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. + - '@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: sp-page-context.SPField.clientSideComponentProperties + fullName: clientSideComponentProperties langs: - typeScript type: property syntax: - content: 'public readonly clientSideComponentProperties: string;' + content: 'readonly clientSideComponentProperties: string;' 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: sp-page-context.SPField.displayName + fullName: displayName langs: - typeScript type: property syntax: - content: 'public readonly displayName: string;' + content: 'readonly displayName: string;' 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: sp-page-context.SPField.fieldType + fullName: fieldType langs: - typeScript type: property syntax: - content: 'public readonly fieldType: string;' + content: 'readonly fieldType: string;' 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: sp-page-context.SPField.id + fullName: id langs: - typeScript type: property syntax: - content: 'public readonly id: Guid;' + content: 'readonly id: Guid;' return: type: - - 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: sp-page-context.SPField.internalName + fullName: internalName langs: - typeScript type: property syntax: - content: 'public readonly internalName: string;' + content: 'readonly internalName: string;' 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: sp-page-context.SPField.isRequired + fullName: isRequired langs: - typeScript type: property syntax: - content: 'public readonly isRequired: boolean;' + 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 diff --git a/SP-Framework/sp-page-context/splist.yml b/SP-Framework/sp-page-context/splist.yml index 708c1fe5..7902dcfc 100644 --- a/SP-Framework/sp-page-context/splist.yml +++ b/SP-Framework/sp-page-context/splist.yml @@ -1,73 +1,78 @@ ### 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 + 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. + create subclasses that extend the `SPList` class. name: SPList - fullName: sp-page-context.SPList + fullName: SPList 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. name: id - fullName: sp-page-context.SPList.id + fullName: id langs: - typeScript type: property syntax: - content: 'public readonly id: Guid;' + content: 'readonly id: Guid;' return: type: - - 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. name: permissions - fullName: sp-page-context.SPList.permissions + fullName: permissions langs: - typeScript type: property syntax: - content: 'public readonly permissions: SPPermission;' + content: 'readonly permissions: SPPermission;' return: type: - - SPPermission - - uid: sp-page-context.SPList.serverRelativeUrl - summary: Returns the server-relative URL for this SPList. + - '@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: sp-page-context.SPList.serverRelativeUrl + fullName: serverRelativeUrl langs: - typeScript type: property syntax: - content: 'public readonly serverRelativeUrl: string;' + content: 'readonly serverRelativeUrl: string;' return: type: - string - - uid: sp-page-context.SPList.title - summary: Returns the title for this SPList. + - uid: '@microsoft/sp-page-context!SPList#title:member' + summary: Returns the title for this `SPList`. name: title - fullName: sp-page-context.SPList.title + fullName: title langs: - typeScript type: property syntax: - content: 'public readonly title: string;' + 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 diff --git a/SP-Framework/sp-page-context/splistitem.yml b/SP-Framework/sp-page-context/splistitem.yml index 59d21dda..dd81f8eb 100644 --- a/SP-Framework/sp-page-context/splistitem.yml +++ b/SP-Framework/sp-page-context/splistitem.yml @@ -1,29 +1,29 @@ ### 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 + 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. + create subclasses that extend the `SPListItem` class. name: SPListItem - fullName: sp-page-context.SPListItem + fullName: SPListItem 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 - summary: The number that identifies the SPListItem on the server. + - '@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: sp-page-context.SPListItem.id + fullName: id langs: - 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..4ff58c7a 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -1,63 +1,65 @@ ### 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: |- + 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 + fullName: SPPermission 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 - summary: 'Constructs a new instance of the [SPPermission](xref:sp-page-context.SPPermission) class' - name: constructor(value) - fullName: 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) langs: - typeScript type: constructor @@ -67,248 +69,249 @@ items: - id: value description: '' type: - - IODataBasePermission - - uid: sp-page-context.SPPermission.addAndCustomizePages + - '@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. + Foundation-compatible editor. name: addAndCustomizePages - fullName: sp-page-context.SPPermission.addAndCustomizePages + fullName: addAndCustomizePages langs: - typeScript type: property syntax: - content: 'public static readonly addAndCustomizePages: SPPermission;' + content: 'static readonly addAndCustomizePages: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.addDelPrivateWebParts + fullName: addDelPrivateWebParts langs: - typeScript type: property syntax: - content: 'public static readonly addDelPrivateWebParts: SPPermission;' + content: 'static readonly addDelPrivateWebParts: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.addListItems + fullName: addListItems langs: - typeScript type: property syntax: - content: 'public static readonly addListItems: SPPermission;' + content: 'static readonly addListItems: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.applyStyleSheets + fullName: applyStyleSheets langs: - typeScript type: property syntax: - content: 'public static readonly applyStyleSheets: SPPermission;' + content: 'static readonly applyStyleSheets: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.applyThemeAndBorder + fullName: applyThemeAndBorder langs: - typeScript type: property syntax: - content: 'public static readonly applyThemeAndBorder: SPPermission;' + content: 'static readonly applyThemeAndBorder: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.approveItems + fullName: approveItems langs: - typeScript type: property syntax: - content: 'public static readonly approveItems: SPPermission;' + content: 'static readonly approveItems: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.browseDirectories + fullName: browseDirectories langs: - typeScript type: property syntax: - content: 'public static readonly browseDirectories: SPPermission;' + content: 'static readonly browseDirectories: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.browserUserInfo + fullName: browserUserInfo langs: - typeScript type: property syntax: - content: 'public static readonly browserUserInfo: SPPermission;' + content: 'static readonly browserUserInfo: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.cancelCheckout + fullName: cancelCheckout langs: - typeScript type: property syntax: - content: 'public static readonly cancelCheckout: SPPermission;' + content: 'static readonly cancelCheckout: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.createAlerts + fullName: createAlerts langs: - typeScript type: property syntax: - content: 'public static readonly createAlerts: SPPermission;' + content: 'static readonly createAlerts: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.createGroups + fullName: createGroups langs: - typeScript type: property syntax: - content: 'public static readonly createGroups: SPPermission;' + content: 'static readonly createGroups: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.createSSCSite + fullName: createSSCSite langs: - typeScript type: property syntax: - content: 'public static readonly createSSCSite: SPPermission;' + content: 'static readonly createSSCSite: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.deleteListItems + fullName: deleteListItems langs: - typeScript type: property syntax: - content: 'public static readonly deleteListItems: SPPermission;' + content: 'static readonly deleteListItems: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.deleteVersions + fullName: deleteVersions langs: - typeScript type: property syntax: - content: 'public static readonly deleteVersions: SPPermission;' + content: 'static readonly deleteVersions: SPPermission;' return: type: - - 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. name: editListItems - fullName: sp-page-context.SPPermission.editListItems + fullName: editListItems langs: - typeScript type: property syntax: - content: 'public static readonly editListItems: SPPermission;' + content: 'static readonly editListItems: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.editMyUserInfo + fullName: editMyUserInfo langs: - typeScript type: property syntax: - content: 'public static readonly editMyUserInfo: SPPermission;' + content: 'static readonly editMyUserInfo: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.emptyMask + fullName: emptyMask langs: - typeScript type: property syntax: - content: 'public static readonly emptyMask: SPPermission;' + content: 'static readonly emptyMask: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.enumeratePermissions + fullName: enumeratePermissions langs: - typeScript type: property syntax: - content: 'public static readonly enumeratePermissions: SPPermission;' + content: 'static readonly enumeratePermissions: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.fullMask + fullName: fullMask langs: - typeScript type: property syntax: - content: 'public static readonly fullMask: SPPermission;' + content: 'static readonly fullMask: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.hasAllPermissions + fullName: hasAllPermissions(requestedPerms) langs: - typeScript type: method syntax: - content: 'public hasAllPermissions(...requestedPerms: SPPermission[]): boolean;' + content: 'hasAllPermissions(...requestedPerms: SPPermission[]): boolean;' return: type: - boolean @@ -317,16 +320,17 @@ 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' + 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: sp-page-context.SPPermission.hasAnyPermissions + fullName: hasAnyPermissions(requestedPerms) langs: - typeScript type: method syntax: - content: 'public hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;' + content: 'hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;' return: type: - boolean @@ -335,16 +339,17 @@ 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' + 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: sp-page-context.SPPermission.hasPermission + fullName: hasPermission(requestedPerm) langs: - typeScript type: method syntax: - content: 'public hasPermission(requestedPerm: SPPermission): boolean;' + content: 'hasPermission(requestedPerm: SPPermission): boolean;' return: type: - boolean @@ -353,80 +358,81 @@ items: - id: requestedPerm description: The SPPermission object to be compared against the original type: - - SPPermission - - uid: sp-page-context.SPPermission.layoutsPage + - '@microsoft/sp-page-context!default:class' + optional: false + - uid: '@microsoft/sp-page-context!SPPermission.layoutsPage:member' summary: View the layouts page? name: layoutsPage - fullName: sp-page-context.SPPermission.layoutsPage + fullName: layoutsPage langs: - typeScript type: property syntax: - content: 'public static readonly layoutsPage: SPPermission;' + content: 'static readonly layoutsPage: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.manageAlerts + fullName: manageAlerts langs: - typeScript type: property syntax: - content: 'public static readonly manageAlerts: SPPermission;' + content: 'static readonly manageAlerts: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.manageLists + fullName: manageLists langs: - typeScript type: property syntax: - content: 'public static readonly manageLists: SPPermission;' + content: 'static readonly manageLists: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.managePermissions + fullName: managePermissions langs: - typeScript type: property syntax: - content: 'public static readonly managePermissions: SPPermission;' + content: 'static readonly managePermissions: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.managePersonalViews + fullName: managePersonalViews langs: - typeScript type: property syntax: - content: 'public static readonly managePersonalViews: SPPermission;' + content: 'static readonly managePersonalViews: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.manageSubwebs + fullName: manageSubwebs langs: - typeScript type: property syntax: - content: 'public static readonly manageSubwebs: SPPermission;' + content: 'static readonly manageSubwebs: SPPermission;' return: type: - - 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 @@ -435,144 +441,167 @@ 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 syntax: - content: 'public static readonly manageWeb: SPPermission;' + content: 'static readonly manageWeb: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.open + fullName: open langs: - typeScript type: property syntax: - content: 'public static readonly open: SPPermission;' + content: 'static readonly open: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.openItems + fullName: openItems langs: - typeScript type: property syntax: - content: 'public static readonly openItems: SPPermission;' + content: 'static readonly openItems: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.updatePersonalWebParts + fullName: updatePersonalWebParts langs: - typeScript type: property syntax: - content: 'public static readonly updatePersonalWebParts: SPPermission;' + content: 'static readonly updatePersonalWebParts: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.useClientIntegration + fullName: useClientIntegration langs: - typeScript type: property syntax: - content: 'public static readonly useClientIntegration: SPPermission;' + content: 'static readonly useClientIntegration: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.useRemoteAPIs + fullName: useRemoteAPIs langs: - typeScript type: property syntax: - content: 'public static readonly useRemoteAPIs: SPPermission;' + content: 'static readonly useRemoteAPIs: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.value + fullName: value langs: - typeScript type: property syntax: - content: 'public readonly value: IODataBasePermission;' + content: 'get value(): IODataBasePermission;' return: type: - - 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: sp-page-context.SPPermission.viewFormPages + fullName: viewFormPages langs: - typeScript type: property syntax: - content: 'public static readonly viewFormPages: SPPermission;' + content: 'static readonly viewFormPages: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.viewListItems + fullName: viewListItems langs: - typeScript type: property syntax: - content: 'public static readonly viewListItems: SPPermission;' + content: 'static readonly viewListItems: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.viewPages + fullName: viewPages langs: - typeScript type: property syntax: - content: 'public static readonly viewPages: SPPermission;' + content: 'static readonly viewPages: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.viewUsageData + fullName: viewUsageData langs: - typeScript type: property syntax: - content: 'public static readonly viewUsageData: SPPermission;' + content: 'static readonly viewUsageData: SPPermission;' return: type: - - 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: sp-page-context.SPPermission.viewVersions + fullName: viewVersions langs: - typeScript type: property syntax: - content: 'public static readonly viewVersions: SPPermission;' + content: 'static readonly viewVersions: SPPermission;' return: type: - - 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 134332e6..d59fabc0 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -1,164 +1,176 @@ ### 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 ("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. + create subclasses that extend the `SPSite` class. name: SPSite - fullName: sp-page-context.SPSite + fullName: SPSite 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 - fullName: sp-page-context.SPSite.absoluteUrl + fullName: absoluteUrl langs: - typeScript type: property syntax: - content: 'public readonly absoluteUrl: string;' + content: 'readonly absoluteUrl: string;' 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: sp-page-context.SPSite.cdnPrefix + fullName: cdnPrefix langs: - typeScript type: property syntax: - content: 'public readonly cdnPrefix: string;' + content: 'readonly cdnPrefix: string;' 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: sp-page-context.SPSite.classification + fullName: classification langs: - typeScript type: property syntax: - content: 'public readonly classification: string;' + content: 'readonly classification: string;' 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: sp-page-context.SPSite.correlationId + fullName: correlationId langs: - typeScript type: property syntax: - content: 'public readonly correlationId: Guid;' + content: 'readonly correlationId: Guid;' return: type: - - 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. name: group - fullName: sp-page-context.SPSite.group + fullName: group langs: - typeScript type: property syntax: - content: 'public readonly group: O365GroupAssociation | undefined;' + 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: sp-page-context.SPSite.id + fullName: id langs: - typeScript type: property syntax: - content: 'public readonly id: Guid;' + content: 'readonly id: Guid;' return: type: - - 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: sp-page-context.SPSite.isNoScriptEnabled + fullName: isNoScriptEnabled langs: - 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. + - uid: '@microsoft/sp-page-context!SPSite#recycleBinItemCount:member' + summary: The amount of items in the recycle bin. name: recycleBinItemCount - fullName: sp-page-context.SPSite.recycleBinItemCount + fullName: recycleBinItemCount langs: - typeScript type: property syntax: - content: 'public readonly recycleBinItemCount: number;' + content: 'readonly recycleBinItemCount: number;' 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 - fullName: sp-page-context.SPSite.serverRelativeUrl + fullName: serverRelativeUrl langs: - typeScript type: property syntax: - content: 'public readonly serverRelativeUrl: string;' + content: 'readonly serverRelativeUrl: string;' 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 - fullName: sp-page-context.SPSite.serverRequestPath + fullName: serverRequestPath langs: - typeScript type: property syntax: - content: 'public readonly serverRequestPath: string;' + content: 'readonly serverRequestPath: string;' 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: sp-page-context.SPSite.sitePagesEnabled + fullName: sitePagesEnabled langs: - typeScript type: property syntax: - content: 'public readonly sitePagesEnabled: boolean;' + 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' diff --git a/SP-Framework/sp-page-context/sptimezone.yml b/SP-Framework/sp-page-context/sptimezone.yml new file mode 100644 index 00000000..3eb4babb --- /dev/null +++ b/SP-Framework/sp-page-context/sptimezone.yml @@ -0,0 +1,132 @@ +### 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: >- + ``` + + 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 + name: SPTimeZone + fullName: SPTimeZone + langs: + - typeScript + type: class + 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' + summary: Gets the date on which daylight time begins for the time zone. + isPreview: true + name: daylightDate + fullName: daylightDate + langs: + - typeScript + type: property + syntax: + content: 'readonly daylightDate: ISPSystemTime;' + return: + 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). + isPreview: true + name: daylightOffset + fullName: daylightOffset + langs: + - typeScript + type: property + syntax: + content: 'readonly daylightOffset: number;' + return: + type: + - number + - uid: '@microsoft/sp-page-context!SPTimeZone#description:member' + summary: Gets the description for the time zone. + isPreview: true + name: description + fullName: description + langs: + - typeScript + type: property + syntax: + content: 'readonly description: string;' + return: + type: + - string + - uid: '@microsoft/sp-page-context!SPTimeZone#id:member' + summary: Gets the ID of the time zone. + isPreview: true + name: id + fullName: id + langs: + - typeScript + type: property + 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 + fullName: offset + langs: + - typeScript + type: property + syntax: + content: 'readonly offset: number;' + return: + type: + - number + - 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 + fullName: standardDate + langs: + - typeScript + type: property + syntax: + content: 'readonly standardDate: ISPSystemTime;' + return: + 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). + isPreview: true + name: standardOffset + fullName: standardOffset + langs: + - typeScript + type: property + syntax: + content: 'readonly standardOffset: number;' + 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 74097c0c..f7174626 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -1,97 +1,144 @@ ### 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 + 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. + create subclasses that extend the `SPUser` class. name: SPUser - fullName: sp-page-context.SPUser + fullName: SPUser 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.isAnonymousGuestUser - - sp-page-context.SPUser.isExternalGuestUser - - sp-page-context.SPUser.loginName - - sp-page-context.SPUser.preferUserTimeZone - - 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"' + remarks: 'Example: `"John Doe"`' name: displayName - fullName: sp-page-context.SPUser.displayName + fullName: displayName langs: - typeScript type: property syntax: - content: 'public readonly displayName: string;' + content: 'readonly displayName: string;' 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"' + remarks: 'Example: `"example@contoso.com"`' name: email - fullName: sp-page-context.SPUser.email + fullName: email langs: - typeScript type: property syntax: - content: 'public readonly email: string;' + content: 'readonly email: string;' return: type: - string - - uid: sp-page-context.SPUser.isAnonymousGuestUser + - 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: sp-page-context.SPUser.isAnonymousGuestUser + fullName: isAnonymousGuestUser langs: - typeScript type: property syntax: - content: 'public readonly isAnonymousGuestUser: boolean;' + content: 'readonly isAnonymousGuestUser: boolean;' 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: sp-page-context.SPUser.isExternalGuestUser + fullName: isExternalGuestUser langs: - typeScript type: property syntax: - content: 'public readonly isExternalGuestUser: boolean;' + content: 'readonly isExternalGuestUser: boolean;' 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: "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 + fullName: loginName langs: - typeScript type: property syntax: - content: 'public readonly loginName: string;' + content: 'readonly loginName: string;' 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: sp-page-context.SPUser.preferUserTimeZone + fullName: preferUserTimeZone langs: - typeScript type: property syntax: - content: 'public readonly preferUserTimeZone: boolean;' + 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: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 3989b577..00c4ce9b 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -1,154 +1,219 @@ ### 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 ("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. + create subclasses that extend the `SPWeb` class. name: SPWeb - fullName: sp-page-context.SPWeb + fullName: SPWeb 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.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.title - - uid: sp-page-context.SPWeb.absoluteUrl - summary: 'Returns the absolute URL for this SPWeb. Example: "https://example.com/sites/PubSite/SubWeb"' + - '@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: sp-page-context.SPWeb.absoluteUrl + fullName: absoluteUrl langs: - typeScript type: property syntax: - content: 'public readonly absoluteUrl: string;' + content: 'readonly absoluteUrl: string;' 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: sp-page-context.SPWeb.description + fullName: description langs: - typeScript type: property syntax: - content: 'public readonly description: string;' + content: 'readonly description: string;' return: type: - string - - uid: sp-page-context.SPWeb.id + - 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: sp-page-context.SPWeb.id + fullName: id langs: - typeScript type: property syntax: - content: 'public readonly id: Guid;' + content: 'readonly id: Guid;' return: type: - - Guid - - uid: sp-page-context.SPWeb.isAppWeb - summary: Returns true if this SPWeb the container web for an SPApp. + - '@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: sp-page-context.SPWeb.isAppWeb + fullName: isAppWeb langs: - typeScript type: property syntax: - content: 'public readonly isAppWeb: boolean;' + content: 'readonly isAppWeb: boolean;' 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 - fullName: sp-page-context.SPWeb.language + fullName: language langs: - typeScript type: property syntax: - content: 'public readonly language: number;' + content: 'readonly language: number;' 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' + remarks: 'Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`' name: logoUrl - fullName: sp-page-context.SPWeb.logoUrl + fullName: logoUrl langs: - typeScript type: property syntax: - content: 'public readonly logoUrl: string;' + content: 'readonly logoUrl: string;' 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. name: permissions - fullName: sp-page-context.SPWeb.permissions + fullName: permissions langs: - typeScript type: property syntax: - content: 'public readonly permissions: SPPermission;' + content: 'readonly permissions: SPPermission;' return: type: - - 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"' + remarks: 'Example: `"/sites/PubSite/SubWeb"`' name: serverRelativeUrl - fullName: sp-page-context.SPWeb.serverRelativeUrl + fullName: serverRelativeUrl langs: - typeScript type: property syntax: - content: 'public readonly serverRelativeUrl: string;' + content: 'readonly serverRelativeUrl: string;' 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. - 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 + fullName: templateName langs: - typeScript type: property syntax: - content: 'public readonly templateName: string;' + content: 'readonly templateName: string;' return: type: - string - - uid: sp-page-context.SPWeb.title + - 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: sp-page-context.SPWeb.title + fullName: title langs: - typeScript type: property syntax: - content: 'public readonly title: string;' + 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: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 new file mode 100644 index 00000000..3bcc9f0d --- /dev/null +++ b/SP-Framework/sp-property-pane.yml @@ -0,0 +1,791 @@ +### 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. + 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 + optional: false + - id: properties + description: Strongly typed Button properties. + 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. + 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 + optional: false + - id: properties + description: Strongly typed Checkbox properties. + 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. + 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 + optional: false + - id: properties + description: Strongly typed Choice Group properties. + 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 + 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' + optional: false + - 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 + optional: false + - id: properties + description: Strongly typed Dropdown properties. + 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. + 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 + optional: false + - id: properties + description: '' + 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. + 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' + optional: false + - 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 + optional: false + - id: properties + description: Properties of the PropertyPaneDynamicTextField. + 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. + 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!PropertyPaneIconPicker:function(1)' + summary: Helper method to create an IconPicker on the PropertyPane. + isPreview: true + 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 + optional: false + - id: properties + description: Strongly typed IconPicker properties. + 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. + 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 + optional: false + - id: properties + description: Strongly typed Label properties. + 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. + 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 + optional: false + - id: properties + description: Strongly typed Link properties. + 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. + 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 + optional: false + - id: properties + description: Strongly typed Slider properties. + 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. + 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 + optional: false + - id: properties + description: Strongly typed TextField properties. + 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. + isPreview: true + 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 + optional: false + - id: properties + description: Strongly typed ThumbnailPicker properties. + 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. + 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 + optional: false + - id: properties + description: Strongly typed Toggle properties. + 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 new file mode 100644 index 00000000..92cacf04 --- /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..a168e0b3 --- /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..066337f5 --- /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..45375a47 --- /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..6bbdb6a7 --- /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/iguidset.yml b/SP-Framework/sp-property-pane/iguidset.yml new file mode 100644 index 00000000..16668f95 --- /dev/null +++ b/SP-Framework/sp-property-pane/iguidset.yml @@ -0,0 +1,68 @@ +### 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!' + 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 + isPreview: true + name: listId + fullName: listId + langs: + - typeScript + type: property + syntax: + content: 'listId: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IGuidSet#siteId:member' + summary: Site ID + isPreview: true + name: siteId + fullName: siteId + langs: + - typeScript + type: property + syntax: + content: 'siteId: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IGuidSet#uniqueId:member' + summary: Unique ID within the list + isPreview: true + name: uniqueId + fullName: uniqueId + langs: + - typeScript + type: property + syntax: + content: 'uniqueId: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IGuidSet#webId:member' + summary: Web ID + isPreview: true + name: webId + fullName: webId + langs: + - typeScript + type: property + 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..bdf1f892 --- /dev/null +++ b/SP-Framework/sp-property-pane/imagefit.yml @@ -0,0 +1,86 @@ +### 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. + 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. + 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. + 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. + 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. + 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. + 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 new file mode 100644 index 00000000..e2680ac5 --- /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..8d825701 --- /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..10d3a43f --- /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..af6823bc --- /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..e8eafbbb --- /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..acd2d54a --- /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..3d926779 --- /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..e529d07f --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml @@ -0,0 +1,124 @@ +### 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#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. + 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#disableFocusTrap:member' + summary: Whether to disable trapping focus inside property pane. + isPreview: true + name: disableFocusTrap + fullName: disableFocusTrap + langs: + - typeScript + type: property + syntax: + content: 'disableFocusTrap?: boolean;' + return: + 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. + 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..c22de94d --- /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..595ba5a3 --- /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..fc142f0d --- /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..0ed49e01 --- /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..670dc03a --- /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/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml new file mode 100644 index 00000000..bf5a2173 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldfilters.yml @@ -0,0 +1,30 @@ +### 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 new file mode 100644 index 00000000..fa38bd1d --- /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..7d1e0737 --- /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..31b12ecb --- /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: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 new file mode 100644 index 00000000..4ff2ea23 --- /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..440c85de --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanegroup.yml @@ -0,0 +1,80 @@ +### 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' + - '@microsoft/sp-property-pane!IPropertyPaneGroup#isGroupNameHidden: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. If left + empty, the group header will not render (not recommended for accordions). + 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 + - 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. + name: isGroupNameHidden + fullName: isGroupNameHidden + langs: + - typeScript + type: property + syntax: + content: 'isGroupNameHidden?: 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/ipropertypaneiconpickerprops.yml b/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml new file mode 100644 index 00000000..954491b9 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml @@ -0,0 +1,171 @@ +### 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!' + 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. + isPreview: true + name: callerName + fullName: callerName + langs: + - typeScript + type: property + syntax: + content: 'callerName?: string;' + return: + 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. + isPreview: true + name: customIconSet + fullName: customIconSet + langs: + - typeScript + type: property + syntax: + content: 'customIconSet?: Map;' + return: + 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.' + isPreview: true + name: customSelectedIconName + fullName: customSelectedIconName + langs: + - typeScript + type: property + syntax: + content: 'customSelectedIconName?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#onItemChanged:member' + summary: Callback function for when an icon is selected. + isPreview: true + name: onItemChanged + fullName: onItemChanged + langs: + - typeScript + type: property + syntax: + content: 'onItemChanged?: (iconName: string) => void;' + return: + type: + - '(iconName: string) => void' + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#onItemDeleted:member' + summary: Callback function for when the Delete button is clicked. + isPreview: true + name: onItemDeleted + fullName: onItemDeleted + langs: + - typeScript + type: property + syntax: + content: 'onItemDeleted?: () => void;' + return: + 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. + isPreview: true + name: previewFullWidth + fullName: previewFullWidth + langs: + - typeScript + type: property + syntax: + content: 'previewFullWidth?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#previewGrayBackground:member' + summary: Whether to render the icon with a gray background. + isPreview: true + name: previewGrayBackground + fullName: previewGrayBackground + langs: + - typeScript + type: property + syntax: + content: 'previewGrayBackground?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#thumbnail:member' + summary: Thumbnail metadata of the currently selected icon. + isPreview: true + name: thumbnail + fullName: thumbnail + langs: + - typeScript + type: property + syntax: + content: 'thumbnail?: IThumbnail;' + return: + 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. + isPreview: true + name: thumbnailRendererIconClassName + fullName: thumbnailRendererIconClassName + langs: + - typeScript + type: property + syntax: + content: 'thumbnailRendererIconClassName?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#thumbnailRendererWrapperClassName:member' + summary: Optional CSS class name to apply to the icon preview wrapper. + isPreview: true + name: thumbnailRendererWrapperClassName + fullName: thumbnailRendererWrapperClassName + langs: + - typeScript + type: property + syntax: + content: 'thumbnailRendererWrapperClassName?: string;' + return: + 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 new file mode 100644 index 00000000..16817056 --- /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..2115b190 --- /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..6ba4ef12 --- /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..333a240e --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanepageheader.yml @@ -0,0 +1,39 @@ +### 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. + deprecated: + content: This property is not used. + 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..5b79e72f --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml @@ -0,0 +1,139 @@ +### 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..cf4d64b9 --- /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: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 new file mode 100644 index 00000000..43fcf523 --- /dev/null +++ b/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml @@ -0,0 +1,170 @@ +### 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!' + 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. + isPreview: true + name: callerName + fullName: callerName + langs: + - typeScript + type: property + syntax: + content: 'callerName?: string;' + return: + 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. + isPreview: true + name: forceFullUrl + fullName: forceFullUrl + langs: + - typeScript + type: property + syntax: + content: 'forceFullUrl?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#onItemChanged:member' + summary: Callback function for when an image has been selected. + isPreview: true + name: onItemChanged + fullName: onItemChanged + langs: + - typeScript + type: property + syntax: + content: 'onItemChanged: (url: string, guidSet: IGuidSet | undefined) => void;' + return: + 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. + isPreview: true + name: onItemDeleted + fullName: onItemDeleted + langs: + - typeScript + type: property + syntax: + content: 'onItemDeleted?: () => void;' + return: + 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.' + isPreview: true + name: previewFullWidth + fullName: previewFullWidth + langs: + - typeScript + type: property + syntax: + content: 'previewFullWidth?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#previewGrayBackground:member' + summary: Whether to display a gray background when rendering an icon. + isPreview: true + name: previewGrayBackground + fullName: previewGrayBackground + langs: + - typeScript + type: property + syntax: + content: 'previewGrayBackground?: boolean;' + return: + type: + - boolean + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#serviceScope:member' + summary: Service scope. + isPreview: true + name: serviceScope + fullName: serviceScope + langs: + - typeScript + type: property + syntax: + content: 'serviceScope: ServiceScope;' + return: + type: + - '@microsoft/sp-core-library!ServiceScope:class' + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#thumbnail:member' + summary: Thumbnail metadata of the currently selected thumbnail. + isPreview: true + name: thumbnail + fullName: thumbnail + langs: + - typeScript + type: property + syntax: + content: 'thumbnail?: IThumbnail;' + return: + 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. + isPreview: true + name: thumbnailRendererIconClassName + fullName: thumbnailRendererIconClassName + langs: + - typeScript + type: property + syntax: + content: 'thumbnailRendererIconClassName?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#thumbnailRendererWrapperClassName:member' + summary: Optional CSS class name to apply to the wrapper of the thumbnail preview. + isPreview: true + name: thumbnailRendererWrapperClassName + fullName: thumbnailRendererWrapperClassName + langs: + - typeScript + type: property + syntax: + content: 'thumbnailRendererWrapperClassName?: string;' + return: + 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 new file mode 100644 index 00000000..5a9bccf1 --- /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 | React.ReactElement;' + 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 | 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 new file mode 100644 index 00000000..6bfdbff5 --- /dev/null +++ b/SP-Framework/sp-property-pane/ithumbnail.yml @@ -0,0 +1,34 @@ +### 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 new file mode 100644 index 00000000..76d0affc --- /dev/null +++ b/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml @@ -0,0 +1,71 @@ +### 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!' + 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. + isPreview: true + name: altText + fullName: altText + langs: + - typeScript + type: property + syntax: + content: 'altText: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#iconColor:member' + summary: The background color for the icon. + isPreview: true + name: iconColor + fullName: iconColor + langs: + - typeScript + type: property + syntax: + content: 'iconColor?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#iconName:member' + summary: The name of the icon to render. + isPreview: true + name: iconName + fullName: iconName + langs: + - typeScript + type: property + syntax: + content: 'iconName: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IThumbnailFabricReactIcon#type:member' + summary: Fabric icon type. + isPreview: true + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ThumbnailType.FabricReactIcon;' + return: + 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 new file mode 100644 index 00000000..ed985555 --- /dev/null +++ b/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml @@ -0,0 +1,71 @@ +### 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!' + 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. + isPreview: true + name: altText + fullName: altText + langs: + - typeScript + type: property + syntax: + content: 'altText: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage#iconColor:member' + summary: Background color to use for the icon. + isPreview: true + name: iconColor + fullName: iconColor + langs: + - typeScript + type: property + syntax: + content: 'iconColor?: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage#iconUrl:member' + summary: URL pointing to the icon-size image. + isPreview: true + name: iconUrl + fullName: iconUrl + langs: + - typeScript + type: property + syntax: + content: 'iconUrl: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IThumbnailIconSizeImage#type:member' + summary: Image type. + isPreview: true + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ThumbnailType.IconSizeImage;' + return: + 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 new file mode 100644 index 00000000..2d3f30e0 --- /dev/null +++ b/SP-Framework/sp-property-pane/ithumbnailimage.yml @@ -0,0 +1,94 @@ +### 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!' + 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. + isPreview: true + name: altText + fullName: altText + langs: + - typeScript + type: property + syntax: + content: 'altText: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IThumbnailImage#backupImageUrl:member' + summary: Optional backup image URL if the original image URL fails to load. + isPreview: true + name: backupImageUrl + fullName: backupImageUrl + langs: + - typeScript + type: property + syntax: + content: 'backupImageUrl: string | undefined;' + return: + type: + - string | undefined + - uid: '@microsoft/sp-property-pane!IThumbnailImage#imageFit:member' + summary: How the image should fit. + isPreview: true + name: imageFit + fullName: imageFit + langs: + - typeScript + type: property + syntax: + content: 'imageFit: ImageFit | undefined;' + return: + type: + - '@microsoft/sp-property-pane!IThumbnailImage#imageFit~0:complex' + - uid: '@microsoft/sp-property-pane!IThumbnailImage#imageUrl:member' + summary: URL pointing to the image. + isPreview: true + name: imageUrl + fullName: imageUrl + langs: + - typeScript + type: property + syntax: + content: 'imageUrl: string;' + return: + type: + - string + - uid: '@microsoft/sp-property-pane!IThumbnailImage#type:member' + summary: Image type. + isPreview: true + name: type + fullName: type + langs: + - typeScript + type: property + syntax: + content: 'type: ThumbnailType.Image;' + return: + 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 new file mode 100644 index 00000000..44974485 --- /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..7d986c07 --- /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..95db7051 --- /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..47c1a751 --- /dev/null +++ b/SP-Framework/sp-property-pane/propertypanefieldtype.yml @@ -0,0 +1,172 @@ +### 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.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. + 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.IconPicker:member' + summary: Icon picker field. + isPreview: true + name: IconPicker + fullName: IconPicker + langs: + - typeScript + type: field + numericValue: '19' + - 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.ThumbnailPicker:member' + summary: Thumbnail picker field. + isPreview: true + name: ThumbnailPicker + fullName: ThumbnailPicker + langs: + - typeScript + type: field + numericValue: '18' + - 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-property-pane/thumbnailtype.yml b/SP-Framework/sp-property-pane/thumbnailtype.yml new file mode 100644 index 00000000..afad828c --- /dev/null +++ b/SP-Framework/sp-property-pane/thumbnailtype.yml @@ -0,0 +1,42 @@ +### 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. + 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. + 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. + 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 new file mode 100644 index 00000000..27501759 --- /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..64124a37 --- /dev/null +++ b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml @@ -0,0 +1,112 @@ +### 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-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!' + 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' + optional: false + - id: scenario + description: Search scenario. + 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: + - 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 new file mode 100644 index 00000000..b8e69c1f --- /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..28df1f14 --- /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..c85b8db6 --- /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 2531378d..6907382f 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -1,356 +1,770 @@ ### 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 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 children: - - sp-webpart-base.BaseClientSideWebPart - - sp-webpart-base.IClientSideWebPartStatusRenderer - - sp-webpart-base.IPlaceholderSpinnerProps - - 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.IPropertyPaneConfiguration - - sp-webpart-base.IPropertyPaneCustomFieldProps - - sp-webpart-base.IPropertyPaneDropdownOption - - sp-webpart-base.IPropertyPaneDropdownProps - - 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.ISerializedServerProcessedData - - sp-webpart-base.ISerializedWebPartData - - sp-webpart-base.IWebPartContext - - sp-webpart-base.IWebPartData - - sp-webpart-base.IWebPartPropertiesMetadata - - 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.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 - - 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!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. + 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: sp-webpart-base.PropertyPaneButton + fullName: 'PropertyPaneButton(targetProperty, properties)' langs: - typeScript type: function syntax: - content: "export function PropertyPaneButton(targetProperty: string,\r\n properties: IPropertyPaneButtonProps): IPropertyPaneField;" + content: >- + export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): + IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneButton~0:complex' description: '' parameters: - id: targetProperty description: Target property the Button is associated to. type: - string + optional: false - id: properties description: Strongly typed Button properties. type: - - IPropertyPaneButtonProps - - uid: sp-webpart-base.PropertyPaneCheckbox + - '@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. + 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: sp-webpart-base.PropertyPaneCheckbox + fullName: 'PropertyPaneCheckbox(targetProperty, properties)' langs: - typeScript type: function syntax: - content: "export function PropertyPaneCheckbox(targetProperty: string,\r\n properties: IPropertyPaneCheckboxProps): IPropertyPaneField;" + content: >- + export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): + IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneCheckbox~0:complex' description: '' parameters: - id: targetProperty description: Target property the checkbox is associated to. type: - string + optional: false - id: properties description: Strongly typed Checkbox properties. type: - - IPropertyPaneCheckboxProps - - uid: sp-webpart-base.PropertyPaneChoiceGroup + - '@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. + 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: sp-webpart-base.PropertyPaneChoiceGroup + fullName: 'PropertyPaneChoiceGroup(targetProperty, properties)' langs: - typeScript type: function syntax: - content: "export function PropertyPaneChoiceGroup(targetProperty: string,\r\n properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField;" + content: >- + export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: + IPropertyPaneChoiceGroupProps): IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup~0:complex' description: '' parameters: - id: targetProperty description: Target property the choice group is associated to. type: - string + optional: false - id: properties description: Strongly typed Choice Group properties. type: - - IPropertyPaneChoiceGroupProps - - uid: sp-webpart-base.PropertyPaneCustomField + - '@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 name: PropertyPaneCustomField(properties) - fullName: sp-webpart-base.PropertyPaneCustomField + fullName: PropertyPaneCustomField(properties) langs: - typeScript type: function syntax: content: >- - export function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): + export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneCustomField~0:complex' description: '' parameters: - id: properties description: Strongly typed Custom field properties. type: - - IPropertyPaneCustomFieldProps - - uid: sp-webpart-base.PropertyPaneDropdown + - '@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. + 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: sp-webpart-base.PropertyPaneDropdown + fullName: 'PropertyPaneDropdown(targetProperty, properties)' langs: - typeScript type: function syntax: - content: "export function PropertyPaneDropdown(targetProperty: string,\r\n properties: IPropertyPaneDropdownProps): IPropertyPaneField;" + content: >- + export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): + IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneDropdown~0:complex' description: '' parameters: - id: targetProperty description: Target property the dropdown is associated to. type: - string + optional: false - id: properties description: Strongly typed Dropdown properties. type: - - IPropertyPaneDropdownProps - - uid: sp-webpart-base.PropertyPaneHorizontalRule + - '@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. + 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 + optional: false + - id: properties + description: '' + 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. + 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' + optional: false + - 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 + optional: false + - id: properties + description: Properties of the PropertyPaneDynamicTextField. + 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. + deprecated: + content: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: PropertyPaneHorizontalRule() - fullName: sp-webpart-base.PropertyPaneHorizontalRule + fullName: PropertyPaneHorizontalRule() langs: - typeScript type: function syntax: - content: 'export function PropertyPaneHorizontalRule(): IPropertyPaneField;' + 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: >- + This is obsolete now. This function has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: 'PropertyPaneLabel(targetProperty, properties)' - fullName: sp-webpart-base.PropertyPaneLabel + fullName: 'PropertyPaneLabel(targetProperty, properties)' langs: - typeScript type: function syntax: - content: "export function PropertyPaneLabel(targetProperty: string,\r\n properties: IPropertyPaneLabelProps): IPropertyPaneField;" + content: >- + export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): + IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneLabel~0:complex' description: '' parameters: - id: targetProperty description: Target property the label is associated to. type: - string + optional: false - id: properties description: Strongly typed Label properties. type: - - IPropertyPaneLabelProps - - uid: sp-webpart-base.PropertyPaneLink + - '@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. + 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: sp-webpart-base.PropertyPaneLink + fullName: 'PropertyPaneLink(targetProperty, properties)' langs: - typeScript type: function syntax: - content: "export function PropertyPaneLink(targetProperty: string,\r\n properties: IPropertyPaneLinkProps): IPropertyPaneField;" + content: >- + export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): + IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneLink~0:complex' description: '' parameters: - id: targetProperty description: Target property the Link is associated to. type: - string + optional: false - id: properties description: Strongly typed Link properties. type: - - IPropertyPaneLinkProps - - uid: sp-webpart-base.PropertyPaneSlider + - '@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. + 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: sp-webpart-base.PropertyPaneSlider + fullName: 'PropertyPaneSlider(targetProperty, properties)' langs: - typeScript type: function syntax: - content: "export function PropertyPaneSlider(targetProperty: string,\r\n properties: IPropertyPaneSliderProps): IPropertyPaneField;" + content: >- + export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): + IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneSlider~0:complex' description: '' parameters: - id: targetProperty description: Target property the slider is associated to. type: - string + optional: false - id: properties description: Strongly typed Slider properties. type: - - IPropertyPaneSliderProps - - uid: sp-webpart-base.PropertyPaneTextField + - '@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. + 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: sp-webpart-base.PropertyPaneTextField + fullName: 'PropertyPaneTextField(targetProperty, properties)' langs: - typeScript type: function syntax: - content: "export function PropertyPaneTextField(targetProperty: string,\r\n properties: IPropertyPaneTextFieldProps): IPropertyPaneField;" + content: >- + export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): + IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneTextField~0:complex' description: '' parameters: - id: targetProperty description: Target property the textfield is associated to. type: - string + optional: false - id: properties description: Strongly typed TextField properties. type: - - IPropertyPaneTextFieldProps - - uid: sp-webpart-base.PropertyPaneToggle + - '@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. + 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: sp-webpart-base.PropertyPaneToggle + fullName: 'PropertyPaneToggle(targetProperty, properties)' langs: - typeScript type: function syntax: - content: "export function PropertyPaneToggle(targetProperty: string,\r\n properties: IPropertyPaneToggleProps): IPropertyPaneField;" + content: >- + export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): + IPropertyPaneField; return: type: - - IPropertyPaneField + - '@microsoft/sp-webpart-base!PropertyPaneToggle~0:complex' description: '' parameters: - id: targetProperty description: Target property the toggle is associated to. type: - string + optional: false - id: properties description: Strongly typed Toggle properties. type: - - IPropertyPaneToggleProps + - '@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface' + optional: false references: - - uid: sp-webpart-base.BaseClientSideWebPart + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart:class' name: BaseClientSideWebPart - - uid: sp-webpart-base.IClientSideWebPartStatusRenderer + - 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: sp-webpart-base.IPlaceholderSpinnerProps - name: IPlaceholderSpinnerProps - - uid: sp-webpart-base.IPropertyPaneAccessor + - 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: 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.IPropertyPaneConfiguration + - uid: '@microsoft/sp-webpart-base!IPropertyPaneConditionalGroup:interface' + name: IPropertyPaneConditionalGroup + - 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.IPropertyPaneDropdownOption + - uid: '@microsoft/sp-webpart-base!IPropertyPaneDropdownCalloutProps:interface' + name: IPropertyPaneDropdownCalloutProps + - 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.IPropertyPaneField + - 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: 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.ISerializedServerProcessedData - name: ISerializedServerProcessedData - - uid: sp-webpart-base.ISerializedWebPartData + - uid: '@microsoft/sp-webpart-base!ISDKs:interface' + name: ISDKs + - 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.PropertyPaneButtonType + - 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: 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: '@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 cf59ecdb..58c4230e 100644 --- a/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml +++ b/SP-Framework/sp-webpart-base/baseclientsidewebpart.yml @@ -1,8 +1,8 @@ ### 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 + 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 @@ -18,100 +18,71 @@ 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 extends: - - BaseComponent - 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.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.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 + - '@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: >- - 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.BaseClientSideWebPart.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. + name: (constructor)() + fullName: (constructor)() langs: - typeScript 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 + - 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 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 + fullName: canOpenPopupOnRender langs: - typeScript type: property syntax: - content: 'protected readonly canOpenPopupOnRender: boolean;' + content: 'protected get canOpenPopupOnRender(): boolean;' 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: sp-webpart-base.BaseClientSideWebPart.clearError + fullName: clearError() langs: - typeScript type: method @@ -121,216 +92,101 @@ 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 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 syntax: - content: 'protected readonly context: WebPartContext;' + content: 'readonly context: WebPartContext;' 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 + - '@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: sp-webpart-base.BaseClientSideWebPart.domElement + fullName: domElement langs: - typeScript type: property syntax: - content: 'protected readonly domElement: HTMLElement;' + content: 'protected get domElement(): HTMLElement;' 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. + - '!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. - 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: '@virtual 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 - 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 + fullName: isRenderAsync langs: - typeScript type: property syntax: - content: 'protected readonly isRenderAsync: boolean;' + content: |- + /** @virtual */ + protected get isRenderAsync(): boolean; 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: '@virtual 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 + - uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#onAfterResize: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() - fullName: sp-webpart-base.BaseClientSideWebPart.onAfterPropertyPaneChangesApplied - langs: - - typeScript - type: method - syntax: - content: '@virtual 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. + 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: >- - 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 + 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. + name: onAfterResize(newWidth) + fullName: onAfterResize(newWidth) langs: - typeScript type: method syntax: - content: '@virtual protected onBeforeSerialize(): void;' + content: |- + /** @virtual */ + protected onAfterResize(newWidth: number): void; return: type: - void description: '' - - uid: sp-webpart-base.BaseClientSideWebPart.onDisplayModeChanged + parameters: + - id: newWidth + description: Width (in pixels) of the container for the web part after the resize event. + 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 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. name: onDisplayModeChanged(oldDisplayMode) - fullName: sp-webpart-base.BaseClientSideWebPart.onDisplayModeChanged + fullName: onDisplayModeChanged(oldDisplayMode) langs: - typeScript type: method syntax: - content: '@virtual protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;' + content: |- + /** @virtual */ + protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void; return: type: - void @@ -339,8 +195,9 @@ items: - id: oldDisplayMode description: The old display mode. type: - - DisplayMode - - uid: sp-webpart-base.BaseClientSideWebPart.onDispose + - '@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 @@ -348,166 +205,48 @@ 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 - langs: - - typeScript - type: method - syntax: - content: '@virtual protected onDispose(): void;' - return: - 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: '@virtual 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: '@virtual 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 + fullName: onDispose() langs: - typeScript type: method syntax: - content: '@virtual protected onPropertyPaneConfigurationStart(): void;' + content: |- + /** @virtual */ + protected onDispose(): 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 + - 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. + name: onThemeChanged(theme) + fullName: onThemeChanged(theme) langs: - typeScript type: method syntax: - content: '@virtual protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;' + content: |- + /** @virtual */ + protected onThemeChanged(theme: IReadonlyTheme | undefined): 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. + - id: theme + description: New theme for the page or section 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: '@virtual 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.render + - '@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. name: render() - fullName: sp-webpart-base.BaseClientSideWebPart.render + fullName: render() langs: - typeScript type: method @@ -517,58 +256,64 @@ 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 - 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 + name: renderCompleted(error) + fullName: renderCompleted(error) langs: - typeScript type: method syntax: - content: 'protected renderCompleted(): void;' + content: 'protected renderCompleted(error?: Error): void;' return: type: - void description: '' - - uid: sp-webpart-base.BaseClientSideWebPart.renderedFromPersistedData + parameters: + - id: error + description: '' + 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: sp-webpart-base.BaseClientSideWebPart.renderedFromPersistedData + fullName: renderedFromPersistedData langs: - typeScript type: property syntax: - content: 'protected readonly renderedFromPersistedData: boolean;' + content: 'protected get renderedFromPersistedData(): boolean;' 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. 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 + fullName: renderedOnce langs: - typeScript type: property syntax: - content: 'protected readonly renderedOnce: boolean;' + content: 'protected get renderedOnce(): boolean;' 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. name: renderError(error) - fullName: sp-webpart-base.BaseClientSideWebPart.renderError + fullName: renderError(error) langs: - typeScript type: method @@ -582,16 +327,38 @@ items: - id: error 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 + - '!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 readonly title: string;' + content: 'protected get width(): number;' return: type: - - string + - 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 new file mode 100644 index 00000000..056705f1 --- /dev/null +++ b/SP-Framework/sp-webpart-base/basewebpart.yml @@ -0,0 +1,519 @@ +### 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!' + 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. + name: (constructor)() + fullName: (constructor)() + langs: + - typeScript + type: constructor + syntax: + content: constructor(); + - 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 + name: accessibleTitle + fullName: accessibleTitle + langs: + - typeScript + type: property + syntax: + content: 'protected get 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 + fullName: context + langs: + - typeScript + type: property + 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 + fullName: dataVersion + langs: + - typeScript + type: property + syntax: + content: 'protected get 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 + fullName: description + langs: + - typeScript + type: property + syntax: + content: 'protected get 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. 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. + name: disableReactivePropertyChanges + fullName: disableReactivePropertyChanges + langs: + - typeScript + type: property + syntax: + content: 'protected get 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 + fullName: displayMode + langs: + - typeScript + type: property + syntax: + content: 'get displayMode(): DisplayMode;' + return: + 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 + 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 + name: getPropertyPaneConfiguration() + fullName: getPropertyPaneConfiguration() + langs: + - typeScript + type: method + syntax: + content: 'protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;' + return: + type: + - '@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface' + description: '' + - 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. + + + 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. + name: loadPropertyPaneResources() + fullName: loadPropertyPaneResources() + langs: + - typeScript + type: method + syntax: + content: |- + /** @virtual */ + protected loadPropertyPaneResources(): Promise; + return: + type: + - '@microsoft/sp-webpart-base!BaseWebPart#loadPropertyPaneResources~0:complex' + 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. + 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. + 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 + 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: + - '@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 + name: onAfterPropertyPaneChangesApplied() + fullName: onAfterPropertyPaneChangesApplied() + langs: + - typeScript + type: method + syntax: + content: 'protected onAfterPropertyPaneChangesApplied(): void;' + return: + type: + - void + description: '' + - 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. + 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 + syntax: + content: 'protected onBeforeSerialize(): void;' + return: + 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. 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 when switching to a different display mode then this lifecycle + method is not called. Example: SharePoint Site Page. + 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: + - '@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. + name: onDispose() + fullName: onDispose() + langs: + - typeScript + type: method + syntax: + content: 'protected onDispose(): void;' + return: + type: + - void + description: '' + - 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. + name: onInit() + fullName: onInit() + langs: + - typeScript + type: method + syntax: + content: 'protected onInit(): Promise;' + return: + type: + - '@microsoft/sp-webpart-base!BaseWebPart#onInit~0:complex' + description: '' + - 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: + + - 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. + name: onPropertyPaneConfigurationComplete() + fullName: onPropertyPaneConfigurationComplete() + langs: + - typeScript + type: method + syntax: + content: 'protected onPropertyPaneConfigurationComplete(): void;' + return: + 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. 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. + name: onPropertyPaneConfigurationStart() + fullName: onPropertyPaneConfigurationStart() + langs: + - typeScript + type: method + syntax: + content: 'protected onPropertyPaneConfigurationStart(): void;' + return: + 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. virtual + 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 + optional: false + - id: oldValue + description: Old value of the property. This value could be undefined/empty in the case of custom field. + 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 + optional: false + - uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneRendered:member(1)' + summary: This API is invoked when the PropertyPane is rendered. virtual + name: onPropertyPaneRendered() + fullName: onPropertyPaneRendered() + langs: + - typeScript + type: method + syntax: + content: 'protected onPropertyPaneRendered(): void;' + return: + 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. 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 new file mode 100644 index 00000000..5f259127 --- /dev/null +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -0,0 +1,95 @@ +### 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. + 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!' + 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 + name: formFactor + fullName: formFactor + langs: + - typeScript + type: property + syntax: + content: 'get 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 + fullName: manifest + langs: + - typeScript + type: property + 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 + fullName: propertyPane + langs: + - typeScript + type: property + syntax: + content: 'get 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 + fullName: webPartTag + langs: + - typeScript + type: property + syntax: + content: 'get 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 diff --git a/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml new file mode 100644 index 00000000..a5e042ed --- /dev/null +++ b/SP-Framework/sp-webpart-base/dynamicdatashareddepth.yml @@ -0,0 +1,42 @@ +### 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. + 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. + 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. + 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 1d69c198..a25a2774 100644 --- a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml +++ b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml @@ -1,24 +1,24 @@ ### 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. name: IClientSideWebPartStatusRenderer - fullName: sp-webpart-base.IClientSideWebPartStatusRenderer + fullName: IClientSideWebPartStatusRenderer 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: sp-webpart-base.IClientSideWebPartStatusRenderer.clearError + fullName: clearError(domElement) langs: - typeScript type: method @@ -32,11 +32,12 @@ items: - id: domElement description: the web part container div. type: - - HTMLElement - - uid: sp-webpart-base.IClientSideWebPartStatusRenderer.clearLoadingIndicator + - '!HTMLElement:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#clearLoadingIndicator:member(1)' summary: Clear the loading indicator. name: clearLoadingIndicator(domElement) - fullName: sp-webpart-base.IClientSideWebPartStatusRenderer.clearLoadingIndicator + fullName: clearLoadingIndicator(domElement) langs: - typeScript type: method @@ -50,42 +51,57 @@ items: - id: domElement description: the web part container div. type: - - Element - - uid: sp-webpart-base.IClientSideWebPartStatusRenderer.displayLoadingIndicator + - '!Element:interface' + optional: false + - uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#displayLoadingIndicator:member(1)' summary: Display a loading spinner. - name: 'displayLoadingIndicator(domElement, loadingMessage, timeout)' - fullName: sp-webpart-base.IClientSideWebPartStatusRenderer.displayLoadingIndicator + 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): void;' + content: >- + displayLoadingIndicator(domElement: Element, loadingMessage: string, timeout?: number, clearDomElementCallback?: + ClearDomElementCallback): void; return: type: - void description: '' parameters: - id: domElement - description: the webpart container div. + description: the web part container div. type: - - Element + - '!Element:interface' + optional: false - id: loadingMessage description: the message to be displayed when the loading spinner id displayed. type: - string + optional: false - 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 + 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: + - '@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. - name: 'renderError(domElement, error)' - fullName: sp-webpart-base.IClientSideWebPartStatusRenderer.renderError + name: 'renderError(domElement, error, clearDomElementCallback)' + fullName: 'renderError(domElement, error, clearDomElementCallback)' langs: - typeScript type: method syntax: - content: 'renderError(domElement: HTMLElement, error: Error | string): void;' + content: >- + renderError(domElement: HTMLElement, error: Error | string, clearDomElementCallback?: ClearDomElementCallback): + void; return: type: - void @@ -94,8 +110,33 @@ items: - id: domElement description: the web part container div. type: - - HTMLElement + - '!HTMLElement:interface' + optional: false - id: error description: the error message. type: - - Error | string + - '@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: + - '@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 new file mode 100644 index 00000000..4ef2b1c9 --- /dev/null +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml @@ -0,0 +1,37 @@ +### 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 new file mode 100644 index 00000000..fae699e2 --- /dev/null +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml @@ -0,0 +1,37 @@ +### 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 new file mode 100644 index 00000000..1d990123 --- /dev/null +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml @@ -0,0 +1,37 @@ +### 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 new file mode 100644 index 00000000..2ba51835 --- /dev/null +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml @@ -0,0 +1,37 @@ +### 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 new file mode 100644 index 00000000..1e6f218b --- /dev/null +++ b/SP-Framework/sp-webpart-base/imicrosoftteams.yml @@ -0,0 +1,52 @@ +### 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!' + 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) + name: context + fullName: context + langs: + - typeScript + type: property + syntax: + content: 'context: microsoftTeams.Context;' + return: + type: + - '!microsoftTeams.Context:interface' + - uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member' + summary: Microsoft Teams SDK. + name: teamsJs + fullName: teamsJs + langs: + - typeScript + type: property + syntax: + content: 'teamsJs: typeof microsoftTeams;' + return: + 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/iplaceholderspinnerprops.yml b/SP-Framework/sp-webpart-base/iplaceholderspinnerprops.yml index 0fbae79b..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: sp-webpart-base.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: sp-webpart-base.IPlaceholderSpinnerProps.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: sp-webpart-base.IPlaceholderSpinnerProps.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 474a7a23..a0e445fc 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml @@ -1,24 +1,39 @@ ### 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. name: IPropertyPaneAccessor - fullName: sp-webpart-base.IPropertyPaneAccessor + fullName: IPropertyPaneAccessor langs: - typeScript type: interface - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' children: - - 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.isPropertyPaneOpen + - '@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: sp-webpart-base.IPropertyPaneAccessor.isPropertyPaneOpen + fullName: isPropertyPaneOpen() langs: - typeScript type: method @@ -28,13 +43,13 @@ 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 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 @@ -44,10 +59,10 @@ 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: sp-webpart-base.IPropertyPaneAccessor.open + fullName: open() langs: - typeScript type: method @@ -57,13 +72,33 @@ 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 + 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. 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..5dc9e106 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml @@ -1,121 +1,37 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneButtonProps + - 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: sp-webpart-base.IPropertyPaneButtonProps + fullName: IPropertyPaneButtonProps langs: - typeScript type: interface - 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: sp-webpart-base.IPropertyPaneButtonProps.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: sp-webpart-base.IPropertyPaneButtonProps.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: sp-webpart-base.IPropertyPaneButtonProps.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: sp-webpart-base.IPropertyPaneButtonProps.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: sp-webpart-base.IPropertyPaneButtonProps.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: sp-webpart-base.IPropertyPaneButtonProps.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: sp-webpart-base.IPropertyPaneButtonProps.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: sp-webpart-base.IPropertyPaneButtonProps.text - langs: - - typeScript - type: property - syntax: - content: 'text: string;' - return: - type: - - string + 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 39e03aea..b033ef96 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml @@ -1,51 +1,37 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneCheckboxProps + - 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: sp-webpart-base.IPropertyPaneCheckboxProps + fullName: IPropertyPaneCheckboxProps langs: - typeScript type: interface - 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: sp-webpart-base.IPropertyPaneCheckboxProps.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: sp-webpart-base.IPropertyPaneCheckboxProps.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: sp-webpart-base.IPropertyPaneCheckboxProps.text - langs: - - typeScript - type: property - syntax: - content: 'text?: string;' - return: - type: - - string + 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 d32246fc..017aa245 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml @@ -1,118 +1,37 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneChoiceGroupOption + - 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: sp-webpart-base.IPropertyPaneChoiceGroupOption + fullName: IPropertyPaneChoiceGroupOption langs: - typeScript type: interface - 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: sp-webpart-base.IPropertyPaneChoiceGroupOption.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: sp-webpart-base.IPropertyPaneChoiceGroupOption.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: sp-webpart-base.IPropertyPaneChoiceGroupOption.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: sp-webpart-base.IPropertyPaneChoiceGroupOption.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: sp-webpart-base.IPropertyPaneChoiceGroupOption.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: sp-webpart-base.IPropertyPaneChoiceGroupOption.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: sp-webpart-base.IPropertyPaneChoiceGroupOption.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: sp-webpart-base.IPropertyPaneChoiceGroupOption.text - langs: - - typeScript - type: property - syntax: - content: 'text: string;' - return: - type: - - string + 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 b45e14f0..4d8e935b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml @@ -1,24 +1,37 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps + - 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: sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps + fullName: IPropertyPaneChoiceGroupOptionIconProps langs: - typeScript type: interface - 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: sp-webpart-base.IPropertyPaneChoiceGroupOptionIconProps.officeFabricIconFontName - langs: - - typeScript - type: property - syntax: - content: 'officeFabricIconFontName?: string | null;' - return: - type: - - string | null + 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 13e128b6..67219ec4 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml @@ -1,37 +1,37 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneChoiceGroupProps + - 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: sp-webpart-base.IPropertyPaneChoiceGroupProps + fullName: IPropertyPaneChoiceGroupProps langs: - typeScript type: interface - 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: sp-webpart-base.IPropertyPaneChoiceGroupProps.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: sp-webpart-base.IPropertyPaneChoiceGroupProps.options - langs: - - typeScript - type: property - syntax: - content: 'options: IPropertyPaneChoiceGroupOption[];' - return: - type: - - 'IPropertyPaneChoiceGroupOption[]' + 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 new file mode 100644 index 00000000..a016b7df --- /dev/null +++ b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml @@ -0,0 +1,37 @@ +### 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 1dc9c8a6..afd5af58 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml @@ -1,72 +1,37 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneConfiguration + - 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: sp-webpart-base.IPropertyPaneConfiguration + fullName: IPropertyPaneConfiguration langs: - typeScript type: interface - 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: sp-webpart-base.IPropertyPaneConfiguration.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: sp-webpart-base.IPropertyPaneConfiguration.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: sp-webpart-base.IPropertyPaneConfiguration.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: sp-webpart-base.IPropertyPaneConfiguration.showLoadingIndicator - langs: - - typeScript - type: property - syntax: - content: 'showLoadingIndicator?: boolean;' - return: - type: - - boolean + 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 aecbbc79..f72ac2a1 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml @@ -1,75 +1,37 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneCustomFieldProps + - 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: sp-webpart-base.IPropertyPaneCustomFieldProps + fullName: IPropertyPaneCustomFieldProps langs: - typeScript type: interface - 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: sp-webpart-base.IPropertyPaneCustomFieldProps.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: sp-webpart-base.IPropertyPaneCustomFieldProps.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: sp-webpart-base.IPropertyPaneCustomFieldProps.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: sp-webpart-base.IPropertyPaneCustomFieldProps.onRender - langs: - - typeScript - type: property - syntax: - content: "onRender: (\r\n domElement: HTMLElement,\r\n context?: any,\r\n 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" + 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 new file mode 100644 index 00000000..77cc5300 --- /dev/null +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml @@ -0,0 +1,37 @@ +### 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 1eef5152..e805a06b 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml @@ -1,63 +1,37 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneDropdownOption + - 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: sp-webpart-base.IPropertyPaneDropdownOption + fullName: IPropertyPaneDropdownOption langs: - typeScript type: interface - 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: sp-webpart-base.IPropertyPaneDropdownOption.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: sp-webpart-base.IPropertyPaneDropdownOption.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: sp-webpart-base.IPropertyPaneDropdownOption.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: sp-webpart-base.IPropertyPaneDropdownOption.type - langs: - - typeScript - type: property - syntax: - content: 'type?: PropertyPaneDropdownOptionType;' - return: - type: - - PropertyPaneDropdownOptionType + 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 3717b9b6..2e643bb7 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml @@ -1,76 +1,37 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneDropdownProps + - 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: sp-webpart-base.IPropertyPaneDropdownProps + fullName: IPropertyPaneDropdownProps langs: - typeScript type: interface - package: sp-webpart-base - children: - - sp-webpart-base.IPropertyPaneDropdownProps.ariaLabel - - 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: sp-webpart-base.IPropertyPaneDropdownProps.ariaLabel - langs: - - typeScript - type: property - syntax: - content: 'ariaLabel?: string;' - return: - type: - - string - - 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 - 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: sp-webpart-base.IPropertyPaneDropdownProps.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: sp-webpart-base.IPropertyPaneDropdownProps.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: sp-webpart-base.IPropertyPaneDropdownProps.selectedKey - langs: - - typeScript - type: property - syntax: - content: 'selectedKey?: string | number;' - return: - type: - - string | number + 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 new file mode 100644 index 00000000..5b01c226 --- /dev/null +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml @@ -0,0 +1,37 @@ +### 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 new file mode 100644 index 00000000..d55d8df8 --- /dev/null +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml @@ -0,0 +1,37 @@ +### 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 new file mode 100644 index 00000000..d6ca7df8 --- /dev/null +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml @@ -0,0 +1,37 @@ +### 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 new file mode 100644 index 00000000..8e78b03b --- /dev/null +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml @@ -0,0 +1,36 @@ +### 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 81b7fe82..8a6e174e 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanefield.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanefield.yml @@ -1,65 +1,40 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneField + - 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: sp-webpart-base.IPropertyPaneField + fullName: IPropertyPaneField langs: - typeScript type: interface - 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: sp-webpart-base.IPropertyPaneField.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: sp-webpart-base.IPropertyPaneField.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: sp-webpart-base.IPropertyPaneField.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: sp-webpart-base.IPropertyPaneField.type - langs: - - typeScript - type: property + extends: + - '@microsoft/sp-webpart-base!IPropertyPaneField~0:complex' + inheritance: + - type: '@microsoft/sp-webpart-base!IPropertyPaneField~1:complex' syntax: - content: 'type: PropertyPaneFieldType;' - return: - type: - - PropertyPaneFieldType + 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 b4e6efeb..b985779f 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml @@ -1,52 +1,37 @@ ### 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: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPaneGroup - fullName: sp-webpart-base.IPropertyPaneGroup + fullName: IPropertyPaneGroup langs: - typeScript type: interface - 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: sp-webpart-base.IPropertyPaneGroup.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: sp-webpart-base.IPropertyPaneGroup.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: sp-webpart-base.IPropertyPaneGroup.isCollapsed - langs: - - typeScript - type: property - syntax: - content: 'isCollapsed?: boolean;' - return: - type: - - boolean + 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 a9bc4e3c..18f19d3e 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml @@ -1,38 +1,37 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneLabelProps + - 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: sp-webpart-base.IPropertyPaneLabelProps + fullName: IPropertyPaneLabelProps langs: - typeScript type: interface - 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: sp-webpart-base.IPropertyPaneLabelProps.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: sp-webpart-base.IPropertyPaneLabelProps.text - langs: - - typeScript - type: property - syntax: - content: 'text: string;' - return: - type: - - string + 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 a948ea37..c67f348e 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml @@ -1,91 +1,37 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneLinkProps + - 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: sp-webpart-base.IPropertyPaneLinkProps + fullName: IPropertyPaneLinkProps langs: - typeScript type: interface - 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: sp-webpart-base.IPropertyPaneLinkProps.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: sp-webpart-base.IPropertyPaneLinkProps.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: sp-webpart-base.IPropertyPaneLinkProps.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: sp-webpart-base.IPropertyPaneLinkProps.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: sp-webpart-base.IPropertyPaneLinkProps.text - langs: - - typeScript - type: property - syntax: - content: 'text: string;' - return: - type: - - string + 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 269d00b1..cb73d7e8 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepage.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepage.yml @@ -1,50 +1,37 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPanePage + - 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: sp-webpart-base.IPropertyPanePage + fullName: IPropertyPanePage langs: - typeScript type: interface - 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: sp-webpart-base.IPropertyPanePage.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: sp-webpart-base.IPropertyPanePage.groups - langs: - - typeScript - type: property - syntax: - content: 'groups: IPropertyPaneGroup[];' - return: - type: - - 'IPropertyPaneGroup[]' - - uid: sp-webpart-base.IPropertyPanePage.header - summary: PropertyPane page header. - name: header - fullName: sp-webpart-base.IPropertyPanePage.header - langs: - - typeScript - type: property - syntax: - content: 'header?: IPropertyPanePageHeader;' - return: - type: - - IPropertyPanePageHeader + 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 d938de44..e498c3aa 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml @@ -1,37 +1,37 @@ ### 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: >- + This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it + from there. name: IPropertyPanePageHeader - fullName: sp-webpart-base.IPropertyPanePageHeader + fullName: IPropertyPanePageHeader langs: - typeScript type: interface - 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: sp-webpart-base.IPropertyPanePageHeader.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: sp-webpart-base.IPropertyPanePageHeader.image - langs: - - typeScript - type: property - syntax: - content: 'image?: string;' - return: - type: - - string + 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 f0e2c8ab..d73275cf 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml @@ -1,119 +1,37 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneSliderProps + - 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: sp-webpart-base.IPropertyPaneSliderProps + fullName: IPropertyPaneSliderProps langs: - typeScript type: interface - 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: sp-webpart-base.IPropertyPaneSliderProps.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: sp-webpart-base.IPropertyPaneSliderProps.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: sp-webpart-base.IPropertyPaneSliderProps.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: sp-webpart-base.IPropertyPaneSliderProps.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: sp-webpart-base.IPropertyPaneSliderProps.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: sp-webpart-base.IPropertyPaneSliderProps.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: sp-webpart-base.IPropertyPaneSliderProps.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: sp-webpart-base.IPropertyPaneSliderProps.value - langs: - - typeScript - type: property - syntax: - content: 'value?: number;' - return: - type: - - number + 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 544a0d10..7a252708 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml @@ -1,247 +1,37 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneTextFieldProps + - 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: sp-webpart-base.IPropertyPaneTextFieldProps + fullName: IPropertyPaneTextFieldProps langs: - typeScript type: interface - 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.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: sp-webpart-base.IPropertyPaneTextFieldProps.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: sp-webpart-base.IPropertyPaneTextFieldProps.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: sp-webpart-base.IPropertyPaneTextFieldProps.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: sp-webpart-base.IPropertyPaneTextFieldProps.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: sp-webpart-base.IPropertyPaneTextFieldProps.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: sp-webpart-base.IPropertyPaneTextFieldProps.label - langs: - - typeScript - type: property - syntax: - content: 'label?: string;' - return: - type: - - 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: sp-webpart-base.IPropertyPaneTextFieldProps.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: sp-webpart-base.IPropertyPaneTextFieldProps.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<string>: - - - The resolved value is display as error message. - - - The rejected, the value is thrown away. - name: onGetErrorMessage - fullName: sp-webpart-base.IPropertyPaneTextFieldProps.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: sp-webpart-base.IPropertyPaneTextFieldProps.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: sp-webpart-base.IPropertyPaneTextFieldProps.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: sp-webpart-base.IPropertyPaneTextFieldProps.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: sp-webpart-base.IPropertyPaneTextFieldProps.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: sp-webpart-base.IPropertyPaneTextFieldProps.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: sp-webpart-base.IPropertyPaneTextFieldProps.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: sp-webpart-base.IPropertyPaneTextFieldProps.value - langs: - - typeScript - type: property - syntax: - content: 'value?: string;' - return: - type: - - string + 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 d4918fe9..e6445ba8 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml @@ -1,116 +1,37 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.IPropertyPaneToggleProps + - 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: sp-webpart-base.IPropertyPaneToggleProps + fullName: IPropertyPaneToggleProps langs: - typeScript type: interface - 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: sp-webpart-base.IPropertyPaneToggleProps.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: sp-webpart-base.IPropertyPaneToggleProps.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: sp-webpart-base.IPropertyPaneToggleProps.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: sp-webpart-base.IPropertyPaneToggleProps.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: sp-webpart-base.IPropertyPaneToggleProps.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: sp-webpart-base.IPropertyPaneToggleProps.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: sp-webpart-base.IPropertyPaneToggleProps.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: sp-webpart-base.IPropertyPaneToggleProps.onText - langs: - - typeScript - type: property - syntax: - content: 'onText?: string;' - return: - type: - - string + 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 new file mode 100644 index 00000000..fcb1585a --- /dev/null +++ b/SP-Framework/sp-webpart-base/isdks.yml @@ -0,0 +1,32 @@ +### 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!' + 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) + name: microsoftTeams + fullName: microsoftTeams + langs: + - typeScript + type: property + syntax: + content: 'microsoftTeams?: IMicrosoftTeams;' + return: + 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/iserializedserverprocesseddata.yml b/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml index b5a38569..3eb0dd0f 100644 --- a/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml +++ b/SP-Framework/sp-webpart-base/iserializedserverprocesseddata.yml @@ -1,86 +1,159 @@ -### YamlMime:UniversalReference -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 - langs: - - typeScript - type: interface - package: 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 - 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': '<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> } - name: htmlStrings - fullName: sp-webpart-base.ISerializedServerProcessedData.htmlStrings - langs: - - typeScript - type: property - syntax: - content: 'htmlStrings?:' - return: - type: - - '{ [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: |- - 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: sp-webpart-base.ISerializedServerProcessedData.imageSources - langs: - - typeScript - type: property - syntax: - content: 'imageSources?:' - return: - type: - - '{ [key: string]: string }' - - uid: sp-webpart-base.ISerializedServerProcessedData.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' } - name: links - fullName: sp-webpart-base.ISerializedServerProcessedData.links - langs: - - typeScript - type: property - syntax: - content: 'links?:' - return: - type: - - '{ [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: >- - 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 <any> characters here: - "<>&\\'' } - name: searchablePlainTexts - fullName: sp-webpart-base.ISerializedServerProcessedData.searchablePlainTexts - langs: - - typeScript - type: property - syntax: - content: 'searchablePlainTexts?:' - 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 df675c45..0fe906f3 100644 --- a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml @@ -1,20 +1,22 @@ ### 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. name: ISerializedWebPartData - fullName: sp-webpart-base.ISerializedWebPartData + fullName: ISerializedWebPartData langs: - typeScript type: interface - package: sp-webpart-base + package: '@microsoft/sp-webpart-base!' children: - - sp-webpart-base.ISerializedWebPartData.dataVersion - - 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 @@ -22,10 +24,12 @@ 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 + fullName: dataVersion langs: - typeScript type: property @@ -33,15 +37,84 @@ items: content: 'dataVersion: Version;' return: type: - - Version - - uid: sp-webpart-base.ISerializedWebPartData.properties + - '@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: >- - 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 + fullName: properties langs: - typeScript type: property @@ -50,10 +123,10 @@ 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: sp-webpart-base.ISerializedWebPartData.serverProcessedContent + fullName: serverProcessedContent langs: - typeScript type: property @@ -61,4 +134,9 @@ items: content: 'serverProcessedContent?: ISerializedServerProcessedData;' return: type: - - ISerializedServerProcessedData + - '@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 0cc8d103..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,33 +8,28 @@ 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: sp-webpart-base.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 - 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. + - '@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: sp-webpart-base.IWebPartContext.domElement + fullName: domElement langs: - typeScript type: property @@ -42,32 +37,11 @@ items: content: 'readonly domElement: HTMLElement;' return: type: - - 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: sp-webpart-base.IWebPartContext.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. - deprecated: - content: >- - 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 @@ -75,15 +49,11 @@ items: content: 'readonly httpClient: HttpClient;' return: type: - - 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. - deprecated: - content: >- - 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 @@ -92,14 +62,10 @@ items: return: type: - 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. + - uid: '@microsoft/sp-webpart-base!IWebPartContext#manifest:member' + summary: Manifest for the client-side web part. name: manifest - fullName: sp-webpart-base.IWebPartContext.manifest + fullName: manifest langs: - typeScript type: property @@ -107,15 +73,11 @@ 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. - deprecated: - content: >- - 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 @@ -123,15 +85,11 @@ items: content: 'readonly pageContext: PageContext;' return: type: - - 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. - deprecated: - content: >- - 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 @@ -139,15 +97,11 @@ items: content: 'readonly propertyPane: IPropertyPaneAccessor;' return: type: - - 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. - deprecated: - content: >- - 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 @@ -155,15 +109,11 @@ items: content: 'readonly spHttpClient: SPHttpClient;' return: type: - - 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. - deprecated: - content: >- - 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 @@ -171,15 +121,11 @@ items: content: 'readonly statusRenderer: IClientSideWebPartStatusRenderer;' return: type: - - 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. - deprecated: - content: >- - 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 @@ -188,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 f7f2fc9c..67dce34d 100644 --- a/SP-Framework/sp-webpart-base/iwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartdata.yml @@ -1,25 +1,28 @@ ### 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. + - 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: sp-webpart-base.IWebPartData + fullName: IWebPartData 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.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 @@ -27,10 +30,12 @@ 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 + fullName: dataVersion langs: - typeScript type: property @@ -39,13 +44,16 @@ items: return: type: - string - - uid: sp-webpart-base.IWebPartData.description + - uid: '@microsoft/sp-webpart-base!IWebPartData#description:member' 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 + fullName: description langs: - typeScript type: property @@ -54,13 +62,80 @@ items: return: type: - string - - uid: sp-webpart-base.IWebPartData.id - summary: Universally unique web part Type id. + - uid: '@microsoft/sp-webpart-base!IWebPartData#dynamicDataPaths:member' + summary: Paths for the dynamic data. remarks: >- - Usage: uniquely identify a web part. Required: yes Type: GUID Supported values: any GUID Example: - "dbef608d-3ad5-4f8f-b139-d916f2f0a294" + 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: sp-webpart-base.IWebPartData.id + fullName: id langs: - typeScript type: property @@ -69,16 +144,16 @@ 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. - 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 + fullName: instanceId langs: - typeScript type: property @@ -87,14 +162,19 @@ 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: >- - 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 + fullName: properties langs: - typeScript type: property @@ -103,12 +183,10 @@ items: return: 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 + - 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: sp-webpart-base.IWebPartData.serverProcessedContent + fullName: serverProcessedContent langs: - typeScript type: property @@ -116,14 +194,17 @@ items: content: 'serverProcessedContent?: ISerializedServerProcessedData;' return: type: - - ISerializedServerProcessedData - - uid: sp-webpart-base.IWebPartData.title + - '@microsoft/sp-component-base!ISerializedServerProcessedData:interface' + - uid: '@microsoft/sp-webpart-base!IWebPartData#title:member' 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 + fullName: title langs: - typeScript type: property @@ -132,3 +213,6 @@ items: return: 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 7d6ea7ad..71e029f2 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertiesmetadata.yml @@ -1,58 +1,63 @@ ### 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 + - 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 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 fix-up, the web part property bag is automatically updated. name: IWebPartPropertiesMetadata - fullName: sp-webpart-base.IWebPartPropertiesMetadata + fullName: IWebPartPropertiesMetadata langs: - typeScript type: interface - package: sp-webpart-base - children: - - sp-webpart-base.IWebPartPropertiesMetadata.__index - - uid: sp-webpart-base.IWebPartPropertiesMetadata.__index - name: __index(key) - fullName: sp-webpart-base.IWebPartPropertiesMetadata.__index - langs: - - typeScript - type: method - syntax: - content: '[ key: string ]: IWebPartPropertyMetadata;' - return: - type: - - IWebPartPropertyMetadata - description: '' - parameters: - - id: key - description: '' - type: - - string + package: '@microsoft/sp-webpart-base!' diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml new file mode 100644 index 00000000..11577621 --- /dev/null +++ b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml @@ -0,0 +1,45 @@ +### 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!' + 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 + 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 + syntax: + content: 'dynamicPropertyType?: ''boolean'' | ''number'' | ''string'' | ''array'' | ''object'';' + return: + 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 73071316..aeda8e30 100644 --- a/SP-Framework/sp-webpart-base/propertypanebuttontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanebuttontype.yml @@ -1,48 +1,55 @@ ### 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: >- + This is obsolete now. This enum has been moved to `@microsoft/sp-property-pane`. Please consume it from + there. name: PropertyPaneButtonType - fullName: sp-webpart-base.PropertyPaneButtonType + fullName: PropertyPaneButtonType 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 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 - - uid: sp-webpart-base.PropertyPaneButtonType.Compound + 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: sp-webpart-base.PropertyPaneButtonType.Compound + fullName: Compound langs: - typeScript type: field - - uid: sp-webpart-base.PropertyPaneButtonType.Hero + numericValue: '3' + - uid: '@microsoft/sp-webpart-base!PropertyPaneButtonType.Hero:member' summary: Hero button. name: Hero - fullName: sp-webpart-base.PropertyPaneButtonType.Hero + fullName: Hero langs: - typeScript type: field - - uid: sp-webpart-base.PropertyPaneButtonType.Icon + 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. @@ -53,26 +60,29 @@ 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 - - uid: sp-webpart-base.PropertyPaneButtonType.Normal + 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: sp-webpart-base.PropertyPaneButtonType.Normal + fullName: Normal langs: - typeScript type: field - - uid: sp-webpart-base.PropertyPaneButtonType.Primary + 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: sp-webpart-base.PropertyPaneButtonType.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 9019252e..5c32748a 100644 --- a/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml +++ b/SP-Framework/sp-webpart-base/propertypanedropdownoptiontype.yml @@ -1,39 +1,43 @@ ### 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 + there. name: PropertyPaneDropdownOptionType - fullName: sp-webpart-base.PropertyPaneDropdownOptionType + fullName: PropertyPaneDropdownOptionType 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: sp-webpart-base.PropertyPaneDropdownOptionType.Divider + fullName: Divider langs: - 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: sp-webpart-base.PropertyPaneDropdownOptionType.Header + fullName: Header langs: - 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: 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 17fb21aa..9fc87148 100644 --- a/SP-Framework/sp-webpart-base/propertypanefieldtype.yml +++ b/SP-Framework/sp-webpart-base/propertypanefieldtype.yml @@ -1,121 +1,175 @@ ### YamlMime:UniversalReference items: - - uid: sp-webpart-base.PropertyPaneFieldType + - 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: sp-webpart-base.PropertyPaneFieldType + fullName: PropertyPaneFieldType 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.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.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. name: Button - fullName: sp-webpart-base.PropertyPaneFieldType.Button + fullName: Button langs: - 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: sp-webpart-base.PropertyPaneFieldType.CheckBox + fullName: CheckBox langs: - 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: sp-webpart-base.PropertyPaneFieldType.ChoiceGroup + fullName: ChoiceGroup langs: - 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: sp-webpart-base.PropertyPaneFieldType.Custom + fullName: Custom langs: - 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: sp-webpart-base.PropertyPaneFieldType.Dropdown + fullName: Dropdown langs: - typeScript type: field numericValue: '6' - - uid: sp-webpart-base.PropertyPaneFieldType.Heading + - 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: sp-webpart-base.PropertyPaneFieldType.Heading + fullName: Heading langs: - 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: sp-webpart-base.PropertyPaneFieldType.HorizontalRule + fullName: HorizontalRule langs: - typeScript type: field numericValue: '12' - - uid: sp-webpart-base.PropertyPaneFieldType.Label + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.IconPicker:member' + summary: Icon picker field. + isPreview: true + name: IconPicker + fullName: IconPicker + langs: + - typeScript + type: field + numericValue: '19' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Label:member' summary: Label field. name: Label - fullName: sp-webpart-base.PropertyPaneFieldType.Label + fullName: Label langs: - 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: sp-webpart-base.PropertyPaneFieldType.Link + fullName: Link langs: - 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: sp-webpart-base.PropertyPaneFieldType.Slider + fullName: Slider langs: - 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: sp-webpart-base.PropertyPaneFieldType.TextField + fullName: TextField langs: - typeScript type: field numericValue: '3' - - uid: sp-webpart-base.PropertyPaneFieldType.Toggle + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.ThumbnailPicker:member' + summary: Thumbnail picker field. + isPreview: true + name: ThumbnailPicker + fullName: ThumbnailPicker + langs: + - typeScript + type: field + numericValue: '18' + - uid: '@microsoft/sp-webpart-base!PropertyPaneFieldType.Toggle:member' 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 be0f00e4..0cbd38a3 100644 --- a/SP-Framework/sp-webpart-base/webpartcontext.yml +++ b/SP-Framework/sp-webpart-base/webpartcontext.yml @@ -1,123 +1,114 @@ ### 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. remarks: >- 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: sp-webpart-base.WebPartContext + fullName: WebPartContext langs: - typeScript type: class extends: - - BaseComponentContext - 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.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 - summary: Reference to the DOM element that hosts this client side component. + - '@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. name: domElement - fullName: sp-webpart-base.WebPartContext.domElement + fullName: domElement langs: - typeScript type: property syntax: - content: 'public readonly domElement: HTMLElement;' + content: 'get 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 - fullName: sp-webpart-base.WebPartContext.manifest - langs: - - typeScript - type: property - syntax: - content: 'public 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 + - '!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: 'public readonly propertyPane: IPropertyPaneAccessor;' + content: 'get microsoftTeams(): typeof microsoftTeams | undefined;' 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 + - '@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. + name: sdks + fullName: sdks langs: - typeScript type: property syntax: - content: 'public readonly spHttpClient: SPHttpClient;' + content: 'get sdks(): ISDKs;' return: type: - - SPHttpClient - - 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: sp-webpart-base.WebPartContext.statusRenderer + fullName: statusRenderer langs: - typeScript type: property syntax: - content: 'public readonly statusRenderer: IClientSideWebPartStatusRenderer;' + content: 'get statusRenderer(): IClientSideWebPartStatusRenderer;' 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 + - '@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. + name: widthCacheKey + fullName: widthCacheKey langs: - typeScript type: property syntax: - content: 'public readonly webPartTag: string;' + content: 'get widthCacheKey(): string | undefined;' return: type: - - string + - 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 new file mode 100644 index 00000000..9002fa19 --- /dev/null +++ b/SP-Framework/sp-webpart-base/webpartformfactor.yml @@ -0,0 +1,39 @@ +### 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.' + 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. + isPreview: true + name: Standard + fullName: Standard + langs: + - typeScript + type: field + numericValue: '0' diff --git a/SP-Framework/spfx-toc/toc.yml b/SP-Framework/spfx-toc/toc.yml index b905966b..07cdb15b 100644 --- a/SP-Framework/spfx-toc/toc.yml +++ b/SP-Framework/spfx-toc/toc.yml @@ -1,295 +1,648 @@ -- 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: 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: 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: 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: 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-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: SecondaryDialogProvider - uid: sp-dialog.SecondaryDialogProvider - - 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: GraphHttpClient - uid: sp-http.GraphHttpClient - - name: GraphHttpClientConfiguration - uid: sp-http.GraphHttpClientConfiguration - - name: GraphHttpClientResponse - uid: sp-http.GraphHttpClientResponse - - name: HttpClient - uid: sp-http.HttpClient - - name: HttpClientConfiguration - uid: sp-http.HttpClientConfiguration - - name: HttpClientResponse - uid: sp-http.HttpClientResponse - - 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: 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: 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: PageContext - uid: sp-page-context.PageContext - - 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: 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: IClientSideWebPartStatusRenderer - uid: sp-webpart-base.IClientSideWebPartStatusRenderer - - 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: IPropertyPaneConfiguration - uid: sp-webpart-base.IPropertyPaneConfiguration - - name: IPropertyPaneCustomFieldProps - uid: sp-webpart-base.IPropertyPaneCustomFieldProps - - name: IPropertyPaneDropdownOption - uid: sp-webpart-base.IPropertyPaneDropdownOption - - name: IPropertyPaneDropdownProps - uid: sp-webpart-base.IPropertyPaneDropdownProps - - 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: 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 +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: 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: + - 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: 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: 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: 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: 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' diff --git a/SP-Framework/toc.yml b/SP-Framework/toc.yml new file mode 100644 index 00000000..45e0301f --- /dev/null +++ b/SP-Framework/toc.yml @@ -0,0 +1,745 @@ +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: 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 + 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: ICardAction + uid: '@microsoft/sp-adaptive-card-extension-base!ICardAction:type' + - 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: 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 + 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: IReadonlyRawStyle + uid: '@microsoft/sp-component-base!IReadonlyRawStyle:type' + - 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: FormDisplayMode + uid: '@microsoft/sp-core-library!FormDisplayMode: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: ServiceCreator + uid: '@microsoft/sp-core-library!ServiceCreator:type' + - 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: MSGraphClientV3 + uid: '@microsoft/sp-http!MSGraphClientV3: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: BaseFormCustomizer + uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer: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: 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 + 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!' + 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 + 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: 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:type' + - name: IModuleConfigurationBase + uid: '@microsoft/sp-module-interfaces!IModuleConfigurationBase: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: 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 + 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 (TypeAlias) + uid: '@microsoft/sp-page-context!SPDayOfWeek:type' + - 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: 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 + 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: IPropertyPaneDynamicFieldFilters + uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type' + - 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: IPropertyPaneIconPickerProps + uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps: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: 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 + 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: ThumbnailType + uid: '@microsoft/sp-property-pane!ThumbnailType: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' diff --git a/generate-docs/json/decorators.api.json b/generate-docs/json/decorators.api.json index 3124965f..e72dbc6b 100644 --- a/generate-docs/json/decorators.api.json +++ b/generate-docs/json/decorators.api.json @@ -1,124 +1,223 @@ -{ - "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,\r\n 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,\r\n 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 - } - } -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "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", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/decorators!", + "name": "", + "members": [ + { + "kind": "Function", + "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 override(target: " + }, + { + "kind": "Reference", + "text": "Object", + "canonicalReference": "!Object:interface" + }, + { + "kind": "Content", + "text": ", propertyKey: " + }, + { + "kind": "Content", + "text": "string | symbol" + }, + { + "kind": "Content", + "text": ", descriptor: " + }, + { + "kind": "Reference", + "text": "TypedPropertyDescriptor", + "canonicalReference": "!TypedPropertyDescriptor:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "target", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "propertyKey", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "descriptor", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + } + } + ], + "name": "override" + }, + { + "kind": "Function", + "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 sealed(target: " + }, + { + "kind": "Reference", + "text": "Function", + "canonicalReference": "!Function:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "target", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "sealed" + }, + { + "kind": "Function", + "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 virtual(target: " + }, + { + "kind": "Reference", + "text": "Object", + "canonicalReference": "!Object:interface" + }, + { + "kind": "Content", + "text": ", propertyKey: " + }, + { + "kind": "Content", + "text": "string | symbol" + }, + { + "kind": "Content", + "text": ", descriptor: " + }, + { + "kind": "Reference", + "text": "TypedPropertyDescriptor", + "canonicalReference": "!TypedPropertyDescriptor:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "target", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "propertyKey", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "descriptor", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + } + } + ], + "name": "virtual" + } + ] + } + ] +} diff --git a/generate-docs/json/recopy.bat b/generate-docs/json/recopy.bat index aa60b521..3ff1ff55 100644 --- a/generate-docs/json/recopy.bat +++ b/generate-docs/json/recopy.bat @@ -1,15 +1,23 @@ @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 ..\..\..\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\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 diff --git a/generate-docs/json/sp-application-base.api.json b/generate-docs/json/sp-application-base.api.json index e7fad6d9..bacbf049 100644 --- a/generate-docs/json/sp-application-base.api.json +++ b/generate-docs/json/sp-application-base.api.json @@ -1,744 +1,862 @@ -{ - "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, - "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": "public readonly navigatedEvent: Event;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Event", - "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 - } - } - }, - "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, - "members": { - "application": { - "kind": "property", - "signature": "public 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 - }, - "placeholderProvider": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "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 - } - } - }, - "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, - "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 - } - } - }, - "PlaceholderContent": { - "kind": "class", - "extends": "", - "implements": "", - "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, - "members": { - "dispose": { - "kind": "method", - "signature": "public dispose(): void;", - "accessModifier": "public", - "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 - }, - "domElement": { - "kind": "property", - "signature": "public 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 - }, - "name": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "members": { - "changedEvent": { - "kind": "property", - "signature": "public readonly changedEvent: Event;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Event", - "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 - }, - "placeholderNames": { - "kind": "property", - "signature": "public 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 - }, - "tryCreateContent": { - "kind": "method", - "signature": "public tryCreateContent(name: PlaceholderName,\r\n options?: IPlaceholderCreateContentOptions): PlaceholderContent | undefined;", - "accessModifier": "public", - "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 - } - } - } - } -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "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", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-application-base!", + "name": "", + "members": [ + { + "kind": "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 ApplicationAccessor " + } + ], + "releaseTag": "Public", + "name": "ApplicationAccessor", + "members": [ + { + "kind": "Constructor", + "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(serviceScope: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Property", + "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 navigatedEvent: " + }, + { + "kind": "Reference", + "text": "SPEvent", + "canonicalReference": "@microsoft/sp-core-library!SPEvent:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPEventArgs", + "canonicalReference": "@microsoft/sp-core-library!SPEventArgs:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "navigatedEvent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 ApplicationCustomizerContext extends " + }, + { + "kind": "Reference", + "text": "ExtensionContext", + "canonicalReference": "@microsoft/sp-extension-base!ExtensionContext:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "ApplicationCustomizerContext", + "members": [ + { + "kind": "Property", + "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 application: " + }, + { + "kind": "Reference", + "text": "ApplicationAccessor", + "canonicalReference": "@microsoft/sp-application-base!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "application", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-application-base!ApplicationCustomizerContext#dispose:member(1)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dispose(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "dispose" + }, + { + "kind": "Property", + "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 placeholderProvider: " + }, + { + "kind": "Reference", + "text": "PlaceholderProvider", + "canonicalReference": "@microsoft/sp-application-base!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "placeholderProvider", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "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 BaseApplicationCustomizer extends " + }, + { + "kind": "Reference", + "text": "BaseExtension", + "canonicalReference": "@microsoft/sp-extension-base!BaseExtension:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "BaseApplicationCustomizer", + "members": [ + { + "kind": "Property", + "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 context: " + }, + { + "kind": "Reference", + "text": "ApplicationCustomizerContext", + "canonicalReference": "@microsoft/sp-application-base!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-application-base!BaseApplicationCustomizer#dispose:member(1)", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponent.dispose}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dispose(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "dispose" + }, + { + "kind": "Method", + "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 onPlaceholdersChanged(placeholderProvider: " + }, + { + "kind": "Reference", + "text": "PlaceholderProvider", + "canonicalReference": "@microsoft/sp-application-base!default:class" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "placeholderProvider", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "onPlaceholdersChanged" + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "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 IPlaceholderCreateContentOptions " + } + ], + "releaseTag": "Public", + "name": "IPlaceholderCreateContentOptions", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "onDispose?: " + }, + { + "kind": "Content", + "text": "(placeholderContent: " + }, + { + "kind": "Reference", + "text": "PlaceholderContent", + "canonicalReference": "@microsoft/sp-application-base!default:class" + }, + { + "kind": "Content", + "text": ") => void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "onDispose", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 PlaceholderContent implements " + }, + { + "kind": "Reference", + "text": "IDisposable", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "PlaceholderContent", + "members": [ + { + "kind": "Method", + "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": "Content", + "text": "dispose(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "dispose" + }, + { + "kind": "Property", + "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 domElement: " + }, + { + "kind": "Reference", + "text": "HTMLDivElement", + "canonicalReference": "!HTMLDivElement:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "domElement", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderContent#isDisposed:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly isDisposed: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isDisposed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 isVisible: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isVisible", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 name: " + }, + { + "kind": "Reference", + "text": "PlaceholderName", + "canonicalReference": "@microsoft/sp-application-base!~PlaceholderName:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 PlaceholderName " + } + ], + "releaseTag": "Public", + "name": "PlaceholderName", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderName.Bottom:member", + "docComment": "/**\n * A region at the bottom of the page.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Bottom = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "releaseTag": "Public", + "name": "Bottom", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderName.Top:member", + "docComment": "/**\n * A region at the top of the page.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Top = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Public", + "name": "Top", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "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 PlaceholderProvider implements " + }, + { + "kind": "Reference", + "text": "IDisposable", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "PlaceholderProvider", + "members": [ + { + "kind": "Property", + "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 changedEvent: " + }, + { + "kind": "Reference", + "text": "SPEvent", + "canonicalReference": "@microsoft/sp-core-library!SPEvent:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPEventArgs", + "canonicalReference": "@microsoft/sp-core-library!SPEventArgs:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "changedEvent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderProvider#dispose:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "dispose(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "dispose" + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-application-base!PlaceholderProvider#isDisposed:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly isDisposed: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isDisposed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 placeholderNames: " + }, + { + "kind": "Reference", + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "PlaceholderName", + "canonicalReference": "@microsoft/sp-application-base!~PlaceholderName:enum" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "placeholderNames", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": false + }, + { + "kind": "Method", + "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": "Content", + "text": "tryCreateContent(name: " + }, + { + "kind": "Reference", + "text": "PlaceholderName", + "canonicalReference": "@microsoft/sp-application-base!~PlaceholderName:enum" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "IPlaceholderCreateContentOptions", + "canonicalReference": "@microsoft/sp-application-base!IPlaceholderCreateContentOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "PlaceholderContent", + "canonicalReference": "@microsoft/sp-application-base!default:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "tryCreateContent" + } + ], + "implementsTokenRanges": [ + { + "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 ddb21460..f7c1e511 100644 --- a/generate-docs/json/sp-component-base.api.json +++ b/generate-docs/json/sp-component-base.api.json @@ -1,340 +1,6528 @@ -{ - "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": "IEventObserver", - "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, - "members": { - "componentId": { - "kind": "property", - "signature": "public 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 - }, - "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 - }, - "dispose": { - "kind": "method", - "signature": "public dispose(): void;", - "accessModifier": "public", - "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 - }, - "instanceId": { - "kind": "property", - "signature": "public 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 - }, - "isDisposed": { - "kind": "property", - "signature": "public 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 - }, - "manifest": { - "kind": "property", - "signature": "public 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 - }, - "onDispose": { - "kind": "method", - "signature": "@virtual 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 - } - } - }, - "BaseComponentContext": { - "kind": "class", - "extends": "", - "implements": "", - "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, - "members": { - "instanceId": { - "kind": "property", - "signature": "public 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 - }, - "manifest": { - "kind": "property", - "signature": "public 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 - }, - "pageContext": { - "kind": "property", - "signature": "public 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 - }, - "serviceScope": { - "kind": "property", - "signature": "public 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 - } - } - } - } -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "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", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-component-base!", + "name": "", + "members": [ + { + "kind": "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 BaseComponent implements " + }, + { + "kind": "Reference", + "text": "ISPEventObserver", + "canonicalReference": "@microsoft/sp-core-library!ISPEventObserver:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "BaseComponent", + "members": [ + { + "kind": "Property", + "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 componentId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "componentId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 context: " + }, + { + "kind": "Reference", + "text": "BaseComponentContext", + "canonicalReference": "@microsoft/sp-component-base!~BaseComponentContext:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "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 | onDispose()} method.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dispose(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "dispose" + }, + { + "kind": "Property", + "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 instanceId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "instanceId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 isDisposed: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isDisposed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 manifest: " + }, + { + "kind": "Reference", + "text": "IClientSideComponentManifest", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manifest", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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 onDispose(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "onDispose" + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 BaseComponentContext implements " + }, + { + "kind": "Reference", + "text": "IDisposable", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "BaseComponentContext", + "members": [ + { + "kind": "Property", + "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 aadHttpClientFactory: " + }, + { + "kind": "Reference", + "text": "AadHttpClientFactory", + "canonicalReference": "@microsoft/sp-http!AadHttpClientFactory:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "aadHttpClientFactory", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 aadTokenProviderFactory: " + }, + { + "kind": "Reference", + "text": "AadTokenProviderFactory", + "canonicalReference": "@microsoft/sp-http!AadTokenProviderFactory:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "aadTokenProviderFactory", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext#dispose:member(1)", + "docComment": "/**\n * Disposes the base component context.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dispose(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "dispose" + }, + { + "kind": "Property", + "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 dynamicDataProvider: " + }, + { + "kind": "Reference", + "text": "DynamicDataProvider", + "canonicalReference": "@microsoft/sp-component-base!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "dynamicDataProvider", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 dynamicDataSourceManager: " + }, + { + "kind": "Reference", + "text": "DynamicDataSourceManager", + "canonicalReference": "@microsoft/sp-component-base!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "dynamicDataSourceManager", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 httpClient: " + }, + { + "kind": "Reference", + "text": "HttpClient", + "canonicalReference": "@microsoft/sp-http!HttpClient:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "httpClient", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 instanceId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "instanceId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext#isDisposed:member", + "docComment": "/**\n * Returns true if the context is disposed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly isDisposed: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isDisposed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext#manifest:member", + "docComment": "/**\n * Manifest for the client-side component.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly manifest: " + }, + { + "kind": "Reference", + "text": "IClientSideComponentManifest", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideComponentManifest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manifest", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 msGraphClientFactory: " + }, + { + "kind": "Reference", + "text": "MSGraphClientFactory", + "canonicalReference": "@microsoft/sp-http!MSGraphClientFactory:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "msGraphClientFactory", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 pageContext: " + }, + { + "kind": "Reference", + "text": "PageContext", + "canonicalReference": "@microsoft/sp-page-context!PageContext:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "pageContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 serviceScope: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceScope", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 spHttpClient: " + }, + { + "kind": "Reference", + "text": "SPHttpClient", + "canonicalReference": "@microsoft/sp-http!SPHttpClient:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "spHttpClient", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 DynamicDataProvider implements " + }, + { + "kind": "Reference", + "text": "IDisposable", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "DynamicDataProvider", + "members": [ + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataProvider#dispose:member(1)", + "docComment": "/**\n * Disposes the Dynamic Data Provider.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dispose(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "dispose" + }, + { + "kind": "Method", + "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": "Content", + "text": "getAvailableSources(): " + }, + { + "kind": "Reference", + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDynamicDataSource", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getAvailableSources" + }, + { + "kind": "Property", + "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 isDisposed: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isDisposed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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": "Content", + "text": "registerAvailableSourcesChanged(callback: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "registerAvailableSourcesChanged" + }, + { + "kind": "Method", + "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": "Content", + "text": "registerPropertyChanged(sourceId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", propertyId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", callback: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sourceId", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "propertyId", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "registerPropertyChanged" + }, + { + "kind": "Method", + "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": "Content", + "text": "registerSourceChanged(sourceId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", callback: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sourceId", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "registerSourceChanged" + }, + { + "kind": "Method", + "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": "Content", + "text": "tryGetSource(id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IDynamicDataSource", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "id", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "tryGetSource" + }, + { + "kind": "Method", + "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": "Content", + "text": "unregisterAvailableSourcesChanged(callback: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "unregisterAvailableSourcesChanged" + }, + { + "kind": "Method", + "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": "Content", + "text": "unregisterPropertyChanged(sourceId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", propertyId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", callback: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sourceId", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "propertyId", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "unregisterPropertyChanged" + }, + { + "kind": "Method", + "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": "Content", + "text": "unregisterSourceChanged(sourceId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", callback: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sourceId", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "unregisterSourceChanged" + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 DynamicDataSourceManager implements " + }, + { + "kind": "Reference", + "text": "IDisposable", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "DynamicDataSourceManager", + "members": [ + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataSourceManager#dispose:member(1)", + "docComment": "/**\n * Disposes the resources held by the Dynamic Data source.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dispose(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "dispose" + }, + { + "kind": "Method", + "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": "Content", + "text": "initializeSource(callableFunctions: " + }, + { + "kind": "Reference", + "text": "IDynamicDataCallables", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataCallables:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "callableFunctions", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "initializeSource" + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-component-base!DynamicDataSourceManager#isDisposed:member", + "docComment": "/**\n * Returns true if the DynamicDataSourceManager is disposed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly isDisposed: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isDisposed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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": "Content", + "text": "notifyPropertyChanged(propertyId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "propertyId", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "notifyPropertyChanged" + }, + { + "kind": "Method", + "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": "Content", + "text": "notifySourceChanged(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "notifySourceChanged" + }, + { + "kind": "Property", + "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 sourceId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "sourceId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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": "Content", + "text": "updateMetadata(metadata: " + }, + { + "kind": "Reference", + "text": "Partial", + "canonicalReference": "!Partial:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDynamicDataSourceMetadata", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "metadata", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + } + ], + "name": "updateMetadata" + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 DynamicProperty implements " + }, + { + "kind": "Reference", + "text": "IDisposable", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TValue", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "DynamicProperty", + "members": [ + { + "kind": "Constructor", + "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(provider: " + }, + { + "kind": "Reference", + "text": "DynamicDataProvider", + "canonicalReference": "@microsoft/sp-component-base!default:class" + }, + { + "kind": "Content", + "text": ", callback?: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "provider", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty#dispose:member(1)", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-core-library#IDisposable.dispose}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dispose(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "dispose" + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty#hasDefaultCallback:member(1)", + "docComment": "/**\n * Returns true if the object has a default callback.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hasDefaultCallback(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "hasDefaultCallback" + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-component-base!DynamicProperty#isDisposed:member", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-core-library#IDisposable.isDisposed}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly isDisposed: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isDisposed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 reference: " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "reference", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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": "Content", + "text": "register(callback: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "register" + }, + { + "kind": "Method", + "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": "Content", + "text": "removeDefaultCallback(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "removeDefaultCallback" + }, + { + "kind": "Method", + "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": "Content", + "text": "setReference(reference: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "reference", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "setReference" + }, + { + "kind": "Method", + "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": "Content", + "text": "setValue(value: " + }, + { + "kind": "Content", + "text": "TValue" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "setValue" + }, + { + "kind": "Method", + "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": "Content", + "text": "tryGetSource(): " + }, + { + "kind": "Reference", + "text": "IDynamicDataSource", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "tryGetSource" + }, + { + "kind": "Method", + "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": "Content", + "text": "tryGetValue(): " + }, + { + "kind": "Content", + "text": "TValue | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "tryGetValue" + }, + { + "kind": "Method", + "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": "Content", + "text": "tryGetValues(): " + }, + { + "kind": "Content", + "text": "TValue[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "tryGetValues" + }, + { + "kind": "Method", + "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": "Content", + "text": "unregister(callback: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "unregister" + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 IFontStyles " + } + ], + "releaseTag": "Public", + "name": "IFontStyles", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#large:member", + "docComment": "/**\n * Large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "large: " + }, + { + "kind": "Reference", + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "large", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#medium:member", + "docComment": "/**\n * Medium font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "medium: " + }, + { + "kind": "Reference", + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "medium", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#mediumPlus:member", + "docComment": "/**\n * Larger than medium but smaller than large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "mediumPlus: " + }, + { + "kind": "Reference", + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "mediumPlus", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#mega:member", + "docComment": "/**\n * Mega sized font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "mega: " + }, + { + "kind": "Reference", + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "mega", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#small:member", + "docComment": "/**\n * Small font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "small: " + }, + { + "kind": "Reference", + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "small", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#smallPlus:member", + "docComment": "/**\n * Larger than small but smaller than medium font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "smallPlus: " + }, + { + "kind": "Reference", + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "smallPlus", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#superLarge:member", + "docComment": "/**\n * Super large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "superLarge: " + }, + { + "kind": "Reference", + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "superLarge", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#tiny:member", + "docComment": "/**\n * Tiny font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tiny: " + }, + { + "kind": "Reference", + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "tiny", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#xLarge:member", + "docComment": "/**\n * Extra large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "xLarge: " + }, + { + "kind": "Reference", + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "xLarge", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#xSmall:member", + "docComment": "/**\n * Extra small font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "xSmall: " + }, + { + "kind": "Reference", + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "xSmall", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles#xxLarge:member", + "docComment": "/**\n * Extra extra large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "xxLarge: " + }, + { + "kind": "Reference", + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "xxLarge", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-component-base!IPalette:interface", + "docComment": "/**\n * Color palette.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IPalette " + } + ], + "releaseTag": "Public", + "name": "IPalette", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#accent:member", + "docComment": "/**\n * Color code for the accent.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "accent: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "black: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "black", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#blackTranslucent40:member", + "docComment": "/**\n * Color code for blackTranslucent40.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "blackTranslucent40: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "blackTranslucent40", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#blue:member", + "docComment": "/**\n * Color code for blue.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "blue: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "blue", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#blueDark:member", + "docComment": "/**\n * Color code for blueDark.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "blueDark: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "blueDark", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#blueLight:member", + "docComment": "/**\n * Color code for blueLight.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "blueLight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "blueLight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#blueMid:member", + "docComment": "/**\n * Color code for blueMid.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "blueMid: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "blueMid", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#green:member", + "docComment": "/**\n * Color code for green.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "green: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "green", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#greenDark:member", + "docComment": "/**\n * Color code for greenDark.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "greenDark: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "greenDark", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#greenLight:member", + "docComment": "/**\n * Color code for greenLight.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "greenLight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "greenLight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#magenta:member", + "docComment": "/**\n * Color code for magenta.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "magenta: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "magenta", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#magentaDark:member", + "docComment": "/**\n * Color code for magentaDark.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "magentaDark: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "magentaDark", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#magentaLight:member", + "docComment": "/**\n * Color code for magentaLight.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "magentaLight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "magentaLight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralDark:member", + "docComment": "/**\n * Color code for neutralDark.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralDark: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralDark", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralLight:member", + "docComment": "/**\n * Color code for neutralLight.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralLight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralLight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralLighter:member", + "docComment": "/**\n * Color code for neutralLighter.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralLighter: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralLighter", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralLighterAlt:member", + "docComment": "/**\n * Color code for neutralLighterAlt.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralLighterAlt: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralLighterAlt", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralPrimary:member", + "docComment": "/**\n * Color code for neutralPrimary.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralPrimary: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralPrimary", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralPrimaryAlt:member", + "docComment": "/**\n * Color code for neutralPrimaryAlt.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralPrimaryAlt: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralPrimaryAlt", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralQuaternary:member", + "docComment": "/**\n * Color code for neutralQuaternary.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralQuaternary: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralQuaternary", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralQuaternaryAlt:member", + "docComment": "/**\n * Color code for neutralQuaternaryAlt.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralQuaternaryAlt: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralQuaternaryAlt", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralSecondary:member", + "docComment": "/**\n * Color code for neutralSecondary.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralSecondary: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralSecondary", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralSecondaryAlt:member", + "docComment": "/**\n * Color code for neutralSecondaryAlt.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralSecondaryAlt: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralSecondaryAlt", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralTertiary:member", + "docComment": "/**\n * Color code for neutralTertiary.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralTertiary: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralTertiary", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#neutralTertiaryAlt:member", + "docComment": "/**\n * Color code for neutralTertiaryAlt.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "neutralTertiaryAlt: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "neutralTertiaryAlt", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#orange:member", + "docComment": "/**\n * Color code for orange.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "orange: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "orange", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#orangeLight:member", + "docComment": "/**\n * Color code for orangeLight.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "orangeLight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "orangeLight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#orangeLighter:member", + "docComment": "/**\n * Color code for orangeLighter.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "orangeLighter: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "orangeLighter", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#purple:member", + "docComment": "/**\n * Color code for purple.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purple: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "purple", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#purpleDark:member", + "docComment": "/**\n * Color code for purpleDark.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purpleDark: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "purpleDark", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#purpleLight:member", + "docComment": "/**\n * Color code for purpleLight.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purpleLight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "purpleLight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#red:member", + "docComment": "/**\n * Color code for red.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "red: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "red", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#redDark:member", + "docComment": "/**\n * Color code for redDark.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "redDark: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "redDark", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#teal:member", + "docComment": "/**\n * Color code for teal.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "teal: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "teal", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#tealDark:member", + "docComment": "/**\n * Color code for tealDark.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tealDark: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "tealDark", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#tealLight:member", + "docComment": "/**\n * Color code for tealLight.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tealLight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "tealLight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themeDark:member", + "docComment": "/**\n * Color code for themeDark.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "themeDark: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeDark", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themeDarkAlt:member", + "docComment": "/**\n * Color code for themeDarkAlt.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "themeDarkAlt: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeDarkAlt", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themeDarker:member", + "docComment": "/**\n * Color code for themeDarker.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "themeDarker: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeDarker", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themeLight:member", + "docComment": "/**\n * Color code for themeLight.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "themeLight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeLight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themeLighter:member", + "docComment": "/**\n * Color code for themeLighter.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "themeLighter: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeLighter", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themeLighterAlt:member", + "docComment": "/**\n * Color code for themeLighterAlt.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "themeLighterAlt: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeLighterAlt", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themePrimary:member", + "docComment": "/**\n * Color code for themePrimary.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "themePrimary: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themePrimary", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themeSecondary:member", + "docComment": "/**\n * Color code for themeSecondary.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "themeSecondary: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeSecondary", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#themeTertiary:member", + "docComment": "/**\n * Color code for themeTertiary.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "themeTertiary: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeTertiary", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "white: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "white", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#whiteTranslucent40:member", + "docComment": "/**\n * Color code for whiteTranslucent40\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "whiteTranslucent40: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "whiteTranslucent40", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#yellow:member", + "docComment": "/**\n * Color code for yellow.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "yellow: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "yellow", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IPalette#yellowLight:member", + "docComment": "/**\n * Color code for yellowLight.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "yellowLight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "yellowLight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IRawStyle extends " + }, + { + "kind": "Reference", + "text": "IRawStyleBase", + "canonicalReference": "@microsoft/sp-component-base!IRawStyleBase:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IRawStyle", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle#displayName:member", + "docComment": "/**\n * Display name for the style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "displayName?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "displayName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle#selectors:member", + "docComment": "/**\n * Custom selectors for the style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "selectors?: " + }, + { + "kind": "Content", + "text": "{\n [key: string]: " + }, + { + "kind": "Reference", + "text": "IStyle", + "canonicalReference": "@microsoft/sp-component-base!IStyle:type" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "selectors", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 IReadonlyFontStyles " + } + ], + "releaseTag": "Public", + "name": "IReadonlyFontStyles", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#large:member", + "docComment": "/**\n * Large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "large: " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "large", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#medium:member", + "docComment": "/**\n * Medium font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "medium: " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "medium", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#mediumPlus:member", + "docComment": "/**\n * Larger than medium but smaller than large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "mediumPlus: " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "mediumPlus", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#mega:member", + "docComment": "/**\n * Mega sized font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "mega: " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "mega", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#small:member", + "docComment": "/**\n * Small font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "small: " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "small", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#smallPlus:member", + "docComment": "/**\n * Larger than small but smaller than medium font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "smallPlus: " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "smallPlus", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#superLarge:member", + "docComment": "/**\n * Super large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "superLarge: " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "superLarge", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#tiny:member", + "docComment": "/**\n * Tiny font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tiny: " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "tiny", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#xLarge:member", + "docComment": "/**\n * Extra large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "xLarge: " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "xLarge", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#xSmall:member", + "docComment": "/**\n * Extra small font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "xSmall: " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "xSmall", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles#xxLarge:member", + "docComment": "/**\n * Extra extra large font style.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "xxLarge: " + }, + { + "kind": "Reference", + "text": "IReadonlyRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "xxLarge", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyRawStyle:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export declare type IReadonlyRawStyle = " + }, + { + "kind": "Reference", + "text": "Readonly", + "canonicalReference": "!Readonly:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IRawStyle", + "canonicalReference": "@microsoft/sp-component-base!IRawStyle:interface" + }, + { + "kind": "Content", + "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", + "canonicalReference": "!Readonly:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ITheme", + "canonicalReference": "@microsoft/sp-component-base!ITheme:interface" + }, + { + "kind": "Content", + "text": "> " + } + ], + "releaseTag": "Public", + "name": "IReadonlyTheme", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyTheme#fonts:member", + "docComment": "/**\n * Font styles for different sizes.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly fonts: " + }, + { + "kind": "Reference", + "text": "Readonly", + "canonicalReference": "!Readonly:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IReadonlyFontStyles", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyFontStyles:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "fonts", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyTheme#palette:member", + "docComment": "/**\n * Color palette.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly palette: " + }, + { + "kind": "Reference", + "text": "Readonly", + "canonicalReference": "!Readonly:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPalette", + "canonicalReference": "@microsoft/sp-component-base!IPalette:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "palette", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "PropertySignature", + "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 semanticColors: " + }, + { + "kind": "Reference", + "text": "Readonly", + "canonicalReference": "!Readonly:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ISemanticColors", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "semanticColors", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 5 + } + ] + }, + { + "kind": "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 ISemanticColors extends " + }, + { + "kind": "Reference", + "text": "ISemanticTextColors", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "ISemanticColors", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#accentButtonBackground:member", + "docComment": "/**\n * Background of an accent button (kicker)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentButtonBackground: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accentButtonBackground", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "blockingBackground: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "blockingBackground", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#bodyBackground:member", + "docComment": "/**\n * The default color for backgrounds.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bodyBackground: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodyBackground", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "bodyDivider: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodyDivider", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "bodyFrameBackground: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodyFrameBackground", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "bodyFrameDivider: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodyFrameDivider", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "bodyStandoutBackground: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodyStandoutBackground", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#buttonBackground:member", + "docComment": "/**\n * Background of a standard button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "buttonBackground: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonBackground", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "buttonBackgroundChecked: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonBackgroundChecked", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "buttonBackgroundCheckedHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonBackgroundCheckedHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#buttonBackgroundDisabled:member", + "docComment": "/**\n * Background of a disabled standard button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "buttonBackgroundDisabled: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonBackgroundDisabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#buttonBackgroundHovered:member", + "docComment": "/**\n * Background of a hovered standard button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "buttonBackgroundHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonBackgroundHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "buttonBackgroundPressed: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonBackgroundPressed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#buttonBorder:member", + "docComment": "/**\n * Border of a standard button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "buttonBorder: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonBorder", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#buttonBorderDisabled:member", + "docComment": "/**\n * Border of a disabled standard button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "buttonBorderDisabled: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonBorderDisabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "defaultStateBackground: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "defaultStateBackground", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "disabledBackground: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabledBackground", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "errorBackground: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "errorBackground", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "focusBorder: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "focusBorder", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#inputBackground:member", + "docComment": "/**\n * The background color of an input, e.g. textbox background.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "inputBackground: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputBackground", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "inputBackgroundChecked: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputBackgroundChecked", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "inputBackgroundCheckedHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputBackgroundCheckedHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "inputBorder: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputBorder", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "inputBorderHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputBorderHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "inputFocusBorderAlt: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputFocusBorderAlt", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "inputForegroundChecked: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputForegroundChecked", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#listBackground:member", + "docComment": "/**\n * The background color for the entire list.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "listBackground: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listBackground", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#listHeaderBackgroundHovered:member", + "docComment": "/**\n * The background color for a hovered list header.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "listHeaderBackgroundHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listHeaderBackgroundHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#listHeaderBackgroundPressed:member", + "docComment": "/**\n * The background color for a pressed list header.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "listHeaderBackgroundPressed: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listHeaderBackgroundPressed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#listItemBackgroundChecked:member", + "docComment": "/**\n * The background color of a checked list item.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "listItemBackgroundChecked: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listItemBackgroundChecked", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#listItemBackgroundCheckedHovered:member", + "docComment": "/**\n * The background color of a checked and hovered list item.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "listItemBackgroundCheckedHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listItemBackgroundCheckedHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#listItemBackgroundHovered:member", + "docComment": "/**\n * The background color of a hovered list item.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "listItemBackgroundHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listItemBackgroundHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "listText: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuBackground:member", + "docComment": "/**\n * The background of a menu.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "menuBackground: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuBackground", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuDivider:member", + "docComment": "/**\n * The divider between menu items.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "menuDivider: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuDivider", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuHeader:member", + "docComment": "/**\n * The headers in menus that denote title of a section.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "menuHeader: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuHeader", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuIcon:member", + "docComment": "/**\n * The default colors of icons in menus.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "menuIcon: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuIcon", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "menuItemBackgroundChecked: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuItemBackgroundChecked", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundHovered:member", + "docComment": "/**\n * The background of a hovered menu item.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "menuItemBackgroundHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuItemBackgroundHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuItemBackgroundPressed:member", + "docComment": "/**\n * The background of a pressed menu item.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "menuItemBackgroundPressed: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuItemBackgroundPressed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuItemText:member", + "docComment": "/**\n * The text color of a menu item.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "menuItemText: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuItemText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#menuItemTextHovered:member", + "docComment": "/**\n * The text color of a hovered menu item.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "menuItemTextHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "menuItemTextHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#primaryButtonBackground:member", + "docComment": "/**\n * Background of a primary button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "primaryButtonBackground: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonBackground", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundDisabled:member", + "docComment": "/**\n * Background of a disabled primary button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "primaryButtonBackgroundDisabled: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonBackgroundDisabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#primaryButtonBackgroundHovered:member", + "docComment": "/**\n * Background of a hovered primary button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "primaryButtonBackgroundHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonBackgroundHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "primaryButtonBackgroundPressed: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonBackgroundPressed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#primaryButtonBorder:member", + "docComment": "/**\n * Border of a primary button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "primaryButtonBorder: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonBorder", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "smallInputBorder: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "smallInputBorder", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#successBackground:member", + "docComment": "/**\n * Background for success\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "successBackground: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "successBackground", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "variantBorder: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "variantBorder", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "variantBorderHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "variantBorderHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#warningBackground:member", + "docComment": "/**\n * Background for warning messages.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "warningBackground: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "warningBackground", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors#warningHighlight:member", + "docComment": "/**\n * Foreground color for warning highlights\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "warningHighlight: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "warningHighlight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 ISemanticTextColors " + } + ], + "releaseTag": "Public", + "name": "ISemanticTextColors", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#accentButtonText:member", + "docComment": "/**\n * Color of text for accent button (kicker)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "accentButtonText: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accentButtonText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#actionLink:member", + "docComment": "/**\n * Neutral colored links and links for action buttons.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "actionLink: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "actionLink", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "actionLinkHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "actionLinkHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#bodySubtext:member", + "docComment": "/**\n * De-emphasized text; e.g. metadata, captions, placeholder text.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bodySubtext: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodySubtext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#bodyText:member", + "docComment": "/**\n * The default color for text.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bodyText: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodyText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#bodyTextChecked:member", + "docComment": "/**\n * Checked text color, e.g. selected menu item text.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bodyTextChecked: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodyTextChecked", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#buttonText:member", + "docComment": "/**\n * Color of text in a standard button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "buttonText: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#buttonTextChecked:member", + "docComment": "/**\n * Color of text in a checked standard button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "buttonTextChecked: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonTextChecked", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#buttonTextCheckedHovered:member", + "docComment": "/**\n * Color of text in a checked and hovered standard button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "buttonTextCheckedHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonTextCheckedHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#buttonTextDisabled:member", + "docComment": "/**\n * Color of text in a disabled standard button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "buttonTextDisabled: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonTextDisabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#buttonTextHovered:member", + "docComment": "/**\n * Color of text in a hovered standard button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "buttonTextHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonTextHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "buttonTextPressed: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "buttonTextPressed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "disabledBodySubtext: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabledBodySubtext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "disabledBodyText: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabledBodyText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#disabledSubtext:member", + "docComment": "/**\n * Disabled de-emphasized text, for use on disabledBackground.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "disabledSubtext: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabledSubtext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "disabledText: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disabledText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#errorText:member", + "docComment": "/**\n * The default color of error text, used on bodyBackground.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "errorText: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "errorText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#inputPlaceholderText:member", + "docComment": "/**\n * The color of placeholder text.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "inputPlaceholderText: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputPlaceholderText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#inputText:member", + "docComment": "/**\n * The color of input text.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "inputText: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#inputTextHovered:member", + "docComment": "/**\n * The color of input text on hover.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "inputTextHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "inputTextHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#link:member", + "docComment": "/**\n * The color of a link.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "link: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "link", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "linkHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "linkHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "listText: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "listTextColor: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listTextColor", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#primaryButtonText:member", + "docComment": "/**\n * Color of text in a primary button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "primaryButtonText: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextDisabled:member", + "docComment": "/**\n * Color of text in a disabled primary button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "primaryButtonTextDisabled: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonTextDisabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#primaryButtonTextHovered:member", + "docComment": "/**\n * Color of text in a hovered primary button\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "primaryButtonTextHovered: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonTextHovered", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "primaryButtonTextPressed: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "primaryButtonTextPressed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ISemanticTextColors#warningText:member", + "docComment": "/**\n * The color of text on errorBackground, warningBackground, blockingBackground, or successBackground.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "warningText: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "warningText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 ITheme " + } + ], + "releaseTag": "Public", + "name": "ITheme", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "disableGlobalClassNames: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disableGlobalClassNames", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ITheme#fonts:member", + "docComment": "/**\n * Font styles for different sizes.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "fonts: " + }, + { + "kind": "Reference", + "text": "IFontStyles", + "canonicalReference": "@microsoft/sp-component-base!IFontStyles:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "fonts", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ITheme#isInverted:member", + "docComment": "/**\n * Indicates whether the theme is inverted.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isInverted: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isInverted", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-component-base!ITheme#palette:member", + "docComment": "/**\n * Color palette.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "palette: " + }, + { + "kind": "Reference", + "text": "IPalette", + "canonicalReference": "@microsoft/sp-component-base!IPalette:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "palette", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "semanticColors: " + }, + { + "kind": "Reference", + "text": "ISemanticColors", + "canonicalReference": "@microsoft/sp-component-base!ISemanticColors:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "semanticColors", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 ThemeChangedEventArgs extends " + }, + { + "kind": "Reference", + "text": "SPEventArgs", + "canonicalReference": "@microsoft/sp-core-library!SPEventArgs:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "ThemeChangedEventArgs", + "members": [ + { + "kind": "Property", + "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 theme: " + }, + { + "kind": "Reference", + "text": "ITheme", + "canonicalReference": "@microsoft/sp-component-base!ITheme:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "theme", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "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 ThemeProvider " + } + ], + "releaseTag": "Public", + "name": "ThemeProvider", + "members": [ + { + "kind": "Constructor", + "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(serviceScope: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class" + }, + { + "kind": "Content", + "text": ", theme?: " + }, + { + "kind": "Reference", + "text": "ITheme", + "canonicalReference": "@microsoft/sp-component-base!ITheme:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "theme", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-component-base!ThemeProvider.serviceKey:member", + "docComment": "/**\n * The service key for ThemeProvider.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly serviceKey: " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ThemeProvider", + "canonicalReference": "@microsoft/sp-component-base!ThemeProvider:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 themeChangedEvent: " + }, + { + "kind": "Reference", + "text": "SPEvent", + "canonicalReference": "@microsoft/sp-core-library!SPEvent:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ThemeChangedEventArgs", + "canonicalReference": "@microsoft/sp-component-base!ThemeChangedEventArgs:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "themeChangedEvent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)", + "docComment": "/**\n * If set, get the current scoped theme.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tryGetTheme(): " + }, + { + "kind": "Reference", + "text": "IReadonlyTheme", + "canonicalReference": "@microsoft/sp-component-base!IReadonlyTheme:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "tryGetTheme" + } + ], + "implementsTokenRanges": [] + } + ] + } + ] +} diff --git a/generate-docs/json/sp-core-library.api.json b/generate-docs/json/sp-core-library.api.json index f7cd7913..f4d3a166 100644 --- a/generate-docs/json/sp-core-library.api.json +++ b/generate-docs/json/sp-core-library.api.json @@ -1,3264 +1,3562 @@ -{ - "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, - "members": { - "type": { - "kind": "property", - "signature": "public 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 - } - } - }, - "EnvironmentType": { - "kind": "enum", - "values": { - "ClassicSharePoint": { - "kind": "enum value", - "value": "", - "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": "", - "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": "", - "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": "", - "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 - }, - "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": "", - "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, - "members": { - "empty": { - "kind": "property", - "signature": "public 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 - }, - "equals": { - "kind": "method", - "signature": "public equals(guid: Guid): boolean;", - "accessModifier": "public", - "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 - }, - "isValid": { - "kind": "method", - "signature": "public static isValid(guid: string | undefined | null): boolean;", - "accessModifier": "public", - "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 - }, - "newGuid": { - "kind": "method", - "signature": "public static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;", - "accessModifier": "public", - "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 - }, - "parse": { - "kind": "method", - "signature": "public static parse(guidString: string | undefined | null): Guid;", - "accessModifier": "public", - "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 - }, - "toString": { - "kind": "method", - "signature": "public toString(): string;", - "accessModifier": "public", - "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 - }, - "tryParse": { - "kind": "method", - "signature": "public static tryParse(guid: string | undefined | null): Guid | undefined;", - "accessModifier": "public", - "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 - } - } - }, - "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, - "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 - }, - "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 - } - } - }, - "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 - } - } - }, - "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, - "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 - } - } - }, - "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, - "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 - } - } - }, - "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, - "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 - }, - "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 - } - } - }, - "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, - "members": { - "error": { - "kind": "method", - "signature": "public static error(source: string, error: Error, scope?: ServiceScope): void;", - "accessModifier": "public", - "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 - }, - "info": { - "kind": "method", - "signature": "public static info(source: string, message: string, scope?: ServiceScope): void;", - "accessModifier": "public", - "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 - }, - "verbose": { - "kind": "method", - "signature": "public static verbose(source: string, message: string, scope?: ServiceScope): void;", - "accessModifier": "public", - "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 - }, - "warn": { - "kind": "method", - "signature": "public static warn(source: string, message: string, scope?: ServiceScope): void;", - "accessModifier": "public", - "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 - } - } - }, - "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, - "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": "public generate(): number;", - "accessModifier": "public", - "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 - }, - "serviceKey": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "members": { - "create": { - "kind": "method", - "signature": "public static create < TKey >(name: string,\r\n serviceClass: { new (serviceScope: ServiceScope); }): ServiceKey;", - "accessModifier": "public", - "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": "{ new (serviceScope: ServiceScope); }" - } - }, - "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 - }, - "createCustom": { - "kind": "method", - "signature": "public static createCustom < TKey >(name: string, defaultCreator: ServiceCreator): ServiceKey;", - "accessModifier": "public", - "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 - }, - "defaultCreator": { - "kind": "property", - "signature": "public 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 - }, - "id": { - "kind": "property", - "signature": "public 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 - }, - "name": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "members": { - "consume": { - "kind": "method", - "signature": "public consume < T >(serviceKey: ServiceKey): T;", - "accessModifier": "public", - "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 - }, - "createAndProvide": { - "kind": "method", - "signature": "public createAndProvide < T >(serviceKey: ServiceKey,\r\n simpleServiceClass: { new (serviceScope: ServiceScope); }): T;", - "accessModifier": "public", - "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": "{ new (serviceScope: ServiceScope); }" - } - }, - "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 - }, - "createDefaultAndProvide": { - "kind": "method", - "signature": "public createDefaultAndProvide < T >(serviceKey: ServiceKey): T;", - "accessModifier": "public", - "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 - }, - "finish": { - "kind": "method", - "signature": "public finish(): void;", - "accessModifier": "public", - "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 - }, - "getParent": { - "kind": "method", - "signature": "public getParent(): ServiceScope | undefined;", - "accessModifier": "public", - "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 - }, - "provide": { - "kind": "method", - "signature": "public provide < T >(serviceKey: ServiceKey, service: T): T;", - "accessModifier": "public", - "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 - }, - "startNewChild": { - "kind": "method", - "signature": "public startNewChild(): ServiceScope;", - "accessModifier": "public", - "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 - }, - "startNewRoot": { - "kind": "method", - "signature": "public static startNewRoot(): ServiceScope;", - "accessModifier": "public", - "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 - }, - "whenFinished": { - "kind": "method", - "signature": "public whenFinished(callback: () => void): void;", - "accessModifier": "public", - "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 - } - } - }, - "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, - "members": { - "applicationId": { - "kind": "property", - "signature": "public 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 - }, - "pageId": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "members": { - "format": { - "kind": "method", - "signature": "public static format(s: string, ...values: any[]): string;", - "accessModifier": "public", - "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 - } - } - }, - "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, - "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": "public getDate(): Date;", - "accessModifier": "public", - "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 - }, - "getTimestamp": { - "kind": "method", - "signature": "public getTimestamp(): number;", - "accessModifier": "public", - "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 - }, - "serviceKey": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "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": "public getValue(param: string): string | undefined;", - "accessModifier": "public", - "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 - }, - "getValues": { - "kind": "method", - "signature": "public getValues(param: string): (string | undefined)[] | undefined;", - "accessModifier": "public", - "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 - } - } - }, - "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, - "members": { - "isNonemptyString": { - "kind": "method", - "signature": "public static isNonemptyString(value: string | undefined | null, variableName: string): void;", - "accessModifier": "public", - "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 - }, - "isNotNullOrUndefined": { - "kind": "method", - "signature": "public static isNotNullOrUndefined(value: any, variableName: string): void;", - "accessModifier": "public", - "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 - }, - "isTrue": { - "kind": "method", - "signature": "public static isTrue(value: boolean | undefined | null, variableName: string): void;", - "accessModifier": "public", - "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 - } - } - }, - "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, - "members": { - "compare": { - "kind": "method", - "signature": "public static compare(v1: Version, v2: Version): number;", - "accessModifier": "public", - "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 - }, - "equals": { - "kind": "method", - "signature": "public equals(compareWith: Version): boolean;", - "accessModifier": "public", - "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 - }, - "greaterThan": { - "kind": "method", - "signature": "public greaterThan(compareWith: Version): boolean;", - "accessModifier": "public", - "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 - }, - "isValid": { - "kind": "method", - "signature": "public static isValid(versionString: string | undefined | null): boolean;", - "accessModifier": "public", - "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 - }, - "lessThan": { - "kind": "method", - "signature": "public lessThan(compareWith: Version): boolean;", - "accessModifier": "public", - "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 - }, - "major": { - "kind": "property", - "signature": "public 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 - }, - "minor": { - "kind": "property", - "signature": "public 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 - }, - "parse": { - "kind": "method", - "signature": "public static parse(versionString: string | undefined | null): Version;", - "accessModifier": "public", - "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 - }, - "patch": { - "kind": "property", - "signature": "public 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 - }, - "revision": { - "kind": "property", - "signature": "public 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 - }, - "satisfies": { - "kind": "method", - "signature": "public satisfies(compareWith: Version): boolean;", - "accessModifier": "public", - "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 - }, - "toString": { - "kind": "method", - "signature": "public toString(): string;", - "accessModifier": "public", - "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 - }, - "tryParse": { - "kind": "method", - "signature": "public static tryParse(versionString: string | undefined | null): Version | undefined;", - "accessModifier": "public", - "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 - } - } - } - } -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "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", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-core-library!", + "name": "", + "members": [ + { + "kind": "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 DisplayMode " + } + ], + "releaseTag": "Public", + "name": "DisplayMode", + "members": [ + { + "kind": "EnumMember", + "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": "Content", + "text": "Edit = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "releaseTag": "Public", + "name": "Edit", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "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": "Content", + "text": "Read = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Public", + "name": "Read", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "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 Environment " + } + ], + "releaseTag": "Public", + "name": "Environment", + "members": [ + { + "kind": "Property", + "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 type: " + }, + { + "kind": "Reference", + "text": "EnvironmentType", + "canonicalReference": "@microsoft/sp-core-library!EnvironmentType:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 EnvironmentType " + } + ], + "releaseTag": "Public", + "name": "EnvironmentType", + "members": [ + { + "kind": "EnumMember", + "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": "Content", + "text": "ClassicSharePoint = " + }, + { + "kind": "Content", + "text": "3" + } + ], + "releaseTag": "Public", + "name": "ClassicSharePoint", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "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": "Content", + "text": "Local = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Public", + "name": "Local", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "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": "Content", + "text": "SharePoint = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "releaseTag": "Public", + "name": "SharePoint", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "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": "Content", + "text": "Test = " + }, + { + "kind": "Content", + "text": "0" + } + ], + "releaseTag": "Public", + "name": "Test", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "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 Guid " + } + ], + "releaseTag": "Public", + "name": "Guid", + "members": [ + { + "kind": "Property", + "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 empty: " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "empty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Method", + "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": "Content", + "text": "equals(guid: " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "guid", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "equals" + }, + { + "kind": "Method", + "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 isValid(guid: " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "guid", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "isValid" + }, + { + "kind": "Method", + "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 newGuid(randomNumberGenerator?: " + }, + { + "kind": "Reference", + "text": "IRandomNumberGenerator", + "canonicalReference": "@microsoft/sp-core-library!IRandomNumberGenerator:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "randomNumberGenerator", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "newGuid" + }, + { + "kind": "Method", + "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 parse(guidString: " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "guidString", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "parse" + }, + { + "kind": "Method", + "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": "Content", + "text": "toString(): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "toString" + }, + { + "kind": "Method", + "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 tryParse(guid: " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "guid", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "tryParse" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 IDisposable " + } + ], + "releaseTag": "Public", + "name": "IDisposable", + "members": [ + { + "kind": "MethodSignature", + "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": "Content", + "text": "dispose(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "dispose" + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "isDisposed: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isDisposed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IRandomNumberGenerator " + } + ], + "releaseTag": "Public", + "name": "IRandomNumberGenerator", + "members": [ + { + "kind": "MethodSignature", + "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": "Content", + "text": "generate(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "generate" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IServiceCollection " + } + ], + "releaseTag": "Public", + "name": "IServiceCollection", + "members": [ + { + "kind": "PropertySignature", + "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 serviceScope: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceScope", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 ISPEventObserver extends " + }, + { + "kind": "Reference", + "text": "IDisposable", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "ISPEventObserver", + "members": [ + { + "kind": "PropertySignature", + "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 componentId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "componentId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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 instanceId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "instanceId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 ITimeProvider " + } + ], + "releaseTag": "Public", + "name": "ITimeProvider", + "members": [ + { + "kind": "MethodSignature", + "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": "Content", + "text": "getDate(): " + }, + { + "kind": "Reference", + "text": "Date", + "canonicalReference": "!Date:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getDate" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "getTimestamp(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getTimestamp" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 Log " + } + ], + "releaseTag": "Public", + "name": "Log", + "members": [ + { + "kind": "Method", + "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 error(source: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", error: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": ", scope?: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "source", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "scope", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "error" + }, + { + "kind": "Method", + "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 info(source: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", scope?: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "source", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "scope", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "info" + }, + { + "kind": "Method", + "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 verbose(source: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", scope?: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "source", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "scope", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "verbose" + }, + { + "kind": "Method", + "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 warn(source: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", scope?: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "source", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "scope", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "warn" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 RandomNumberGenerator implements " + }, + { + "kind": "Reference", + "text": "IRandomNumberGenerator", + "canonicalReference": "@microsoft/sp-core-library!IRandomNumberGenerator:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "RandomNumberGenerator", + "members": [ + { + "kind": "Constructor", + "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(serviceScope: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Method", + "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": "Content", + "text": "generate(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "generate" + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-core-library!RandomNumberGenerator.serviceKey:member", + "docComment": "/**\n * The service key for IRandomNumberGenerator.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly serviceKey: " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IRandomNumberGenerator", + "canonicalReference": "@microsoft/sp-core-library!IRandomNumberGenerator:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": true + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "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 declare type ServiceCreator = " + }, + { + "kind": "Content", + "text": "(serviceScope: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "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": "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": "@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 create(name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", serviceClass: " + }, + { + "kind": "Content", + "text": "{\n new (serviceScope: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "): TKey;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "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": "static createCustom(name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", defaultCreator: " + }, + { + "kind": "Reference", + "text": "ServiceCreator", + "canonicalReference": "@microsoft/sp-core-library!ServiceCreator:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "defaultCreator", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "TKey", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "createCustom" + }, + { + "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": "readonly defaultCreator: " + }, + { + "kind": "Reference", + "text": "ServiceCreator", + "canonicalReference": "@microsoft/sp-core-library!ServiceCreator:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "defaultCreator", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 ServiceScope " + } + ], + "releaseTag": "Public", + "name": "ServiceScope", + "members": [ + { + "kind": "Constructor", + "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(parent: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "parent", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ] + }, + { + "kind": "Method", + "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": "Content", + "text": "consume(serviceKey: " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "serviceKey", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "consume" + }, + { + "kind": "Method", + "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": "Content", + "text": "createAndProvide(serviceKey: " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ", simpleServiceClass: " + }, + { + "kind": "Content", + "text": "{\n new (serviceScope: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "): T;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 8, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "serviceKey", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "parameterName": "simpleServiceClass", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 7 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "createAndProvide" + }, + { + "kind": "Method", + "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": "Content", + "text": "createDefaultAndProvide(serviceKey: " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "serviceKey", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "createDefaultAndProvide" + }, + { + "kind": "Method", + "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": "Content", + "text": "finish(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "finish" + }, + { + "kind": "Method", + "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": "Content", + "text": "getParent(): " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getParent" + }, + { + "kind": "Method", + "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": "Content", + "text": "provide(serviceKey: " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ", service: " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "serviceKey", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "parameterName": "service", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + } + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "provide" + }, + { + "kind": "Method", + "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": "Content", + "text": "startNewChild(): " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "startNewChild" + }, + { + "kind": "Method", + "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 startNewRoot(): " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "startNewRoot" + }, + { + "kind": "Method", + "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": "Content", + "text": "whenFinished(callback: " + }, + { + "kind": "Content", + "text": "() => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "whenFinished" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 Session " + } + ], + "releaseTag": "Public", + "name": "Session", + "members": [ + { + "kind": "Property", + "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 applicationId: " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "applicationId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 pageId: " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "pageId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 SPEvent " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TEventArgs", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "SPEvent", + "members": [ + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-core-library!SPEvent#add:member(1)", + "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": "Content", + "text": "add(observer: " + }, + { + "kind": "Reference", + "text": "ISPEventObserver", + "canonicalReference": "@microsoft/sp-core-library!ISPEventObserver:interface" + }, + { + "kind": "Content", + "text": ", eventHandler: " + }, + { + "kind": "Content", + "text": "(eventArgs: TEventArgs) => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "observer", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "eventHandler", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "add" + }, + { + "kind": "Method", + "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": "Content", + "text": "remove(observer: " + }, + { + "kind": "Reference", + "text": "ISPEventObserver", + "canonicalReference": "@microsoft/sp-core-library!ISPEventObserver:interface" + }, + { + "kind": "Content", + "text": ", eventHandler: " + }, + { + "kind": "Content", + "text": "(eventArgs: TEventArgs) => void" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "observer", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "eventHandler", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "remove" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 SPEventArgs " + } + ], + "releaseTag": "Public", + "name": "SPEventArgs", + "members": [], + "implementsTokenRanges": [] + }, + { + "kind": "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 Text " + } + ], + "releaseTag": "Public", + "name": "Text", + "members": [ + { + "kind": "Method", + "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 format(s: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", ...values: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "s", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "values", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "format" + }, + { + "kind": "Method", + "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 replaceAll(input: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", searchValue: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", replaceValue: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "input", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "searchValue", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "replaceValue", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "replaceAll" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 TimeProvider implements " + }, + { + "kind": "Reference", + "text": "ITimeProvider", + "canonicalReference": "@microsoft/sp-core-library!ITimeProvider:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "TimeProvider", + "members": [ + { + "kind": "Constructor", + "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(serviceScope: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Method", + "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": "Content", + "text": "getDate(): " + }, + { + "kind": "Reference", + "text": "Date", + "canonicalReference": "!Date:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getDate" + }, + { + "kind": "Method", + "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": "Content", + "text": "getTimestamp(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getTimestamp" + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-core-library!TimeProvider.serviceKey:member", + "docComment": "/**\n * The service key for ITimeProvider.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly serviceKey: " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ITimeProvider", + "canonicalReference": "@microsoft/sp-core-library!ITimeProvider:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": true + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 UrlQueryParameterCollection " + } + ], + "releaseTag": "Public", + "name": "UrlQueryParameterCollection", + "members": [ + { + "kind": "Constructor", + "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(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Method", + "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": "Content", + "text": "getValue(param: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "param", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getValue" + }, + { + "kind": "Method", + "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": "Content", + "text": "getValues(param: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "(string | undefined)[] | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "param", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getValues" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 Validate " + } + ], + "releaseTag": "Public", + "name": "Validate", + "members": [ + { + "kind": "Method", + "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 isNonemptyString(value: " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": ", variableName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "variableName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "isNonemptyString" + }, + { + "kind": "Method", + "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 isNotDisposed(value: " + }, + { + "kind": "Reference", + "text": "IDisposable", + "canonicalReference": "@microsoft/sp-core-library!IDisposable:interface" + }, + { + "kind": "Content", + "text": ", className: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "className", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "isNotDisposed" + }, + { + "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": "static isNotNullOrUndefined(value: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", variableName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "variableName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "isNotNullOrUndefined" + }, + { + "kind": "Method", + "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 isTrue(value: " + }, + { + "kind": "Content", + "text": "boolean | undefined | null" + }, + { + "kind": "Content", + "text": ", variableName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "variableName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "isTrue" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 Version " + } + ], + "releaseTag": "Public", + "name": "Version", + "members": [ + { + "kind": "Method", + "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 compare(v1: " + }, + { + "kind": "Reference", + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": ", v2: " + }, + { + "kind": "Reference", + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "v1", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "v2", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "compare" + }, + { + "kind": "Method", + "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": "Content", + "text": "equals(compareWith: " + }, + { + "kind": "Reference", + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "compareWith", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "equals" + }, + { + "kind": "Method", + "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": "Content", + "text": "greaterThan(compareWith: " + }, + { + "kind": "Reference", + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "compareWith", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "greaterThan" + }, + { + "kind": "Method", + "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 isValid(versionString: " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "versionString", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "isValid" + }, + { + "kind": "Method", + "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": "Content", + "text": "lessThan(compareWith: " + }, + { + "kind": "Reference", + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "compareWith", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "lessThan" + }, + { + "kind": "Property", + "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 major: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "major", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 minor: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "minor", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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 parse(versionString: " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "versionString", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "parse" + }, + { + "kind": "Property", + "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 patch: " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "patch", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 revision: " + }, + { + "kind": "Content", + "text": "number | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "revision", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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": "Content", + "text": "satisfies(compareWith: " + }, + { + "kind": "Reference", + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "compareWith", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "satisfies" + }, + { + "kind": "Method", + "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": "Content", + "text": "toString(): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "toString" + }, + { + "kind": "Method", + "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 tryParse(versionString: " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!default:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "versionString", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "tryParse" + } + ], + "implementsTokenRanges": [] + } + ] + } + ] +} diff --git a/generate-docs/json/sp-diagnostics.api.json b/generate-docs/json/sp-diagnostics.api.json new file mode 100644 index 00000000..92c0df19 --- /dev/null +++ b/generate-docs/json/sp-diagnostics.api.json @@ -0,0 +1,56 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "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", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-diagnostics!", + "name": "", + "members": [ + { + "kind": "Variable", + "canonicalReference": "@microsoft/sp-diagnostics!_logSourceServiceKey:var", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "logSourceServiceKey: " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "LogSource", + "canonicalReference": "@microsoft/sp-diagnostics!default:class" + }, + { + "kind": "Content", + "text": ">" + } + ], + "releaseTag": "Public", + "name": "_logSourceServiceKey", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + } + ] + } + ] +} diff --git a/generate-docs/json/sp-dialog.api.json b/generate-docs/json/sp-dialog.api.json index 5d02403a..86849b91 100644 --- a/generate-docs/json/sp-dialog.api.json +++ b/generate-docs/json/sp-dialog.api.json @@ -1,908 +1,897 @@ -{ - "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, - "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": "public close(): Promise;", - "accessModifier": "public", - "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 - }, - "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 - }, - "isHidden": { - "kind": "property", - "signature": "public 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 - }, - "isOpen": { - "kind": "property", - "signature": "public 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 - }, - "isSecondary": { - "kind": "property", - "signature": "public 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 - }, - "onAfterClose": { - "kind": "method", - "signature": "@virtual 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 - }, - "onBeforeOpen": { - "kind": "method", - "signature": "@virtual 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 - }, - "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 - }, - "secondaryDialogProvider": { - "kind": "property", - "signature": "public 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 - }, - "show": { - "kind": "method", - "signature": "public show(options?: IDialogShowOptions): Promise;", - "accessModifier": "public", - "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 - } - } - }, - "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, - "members": { - "alert": { - "kind": "method", - "signature": "public static alert(message: string, options?: IAlertOptions): Promise;", - "accessModifier": "public", - "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 - }, - "prompt": { - "kind": "method", - "signature": "public static prompt(message: string, options?: IPromptOptions): Promise;", - "accessModifier": "public", - "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 - } - } - }, - "IAlertOptions": { - "kind": "interface", - "extends": "IDialogShowOptions", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Options for showing an alert dialog" - } - ], - "remarks": [], - "isBeta": true - }, - "IDialogConfiguration": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The interface for dialog configuration" - } - ], - "remarks": [], - "isBeta": true, - "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 - } - } - }, - "IDialogShowOptions": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Options for showing a dialog" - } - ], - "remarks": [], - "isBeta": true, - "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 - } - } - }, - "IPromptOptions": { - "kind": "interface", - "extends": "IDialogShowOptions", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Options for showing a prompt dialog" - } - ], - "remarks": [], - "isBeta": true, - "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 - } - } - }, - "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, - "members": { - "alert": { - "kind": "method", - "signature": "public alert(message: string, options?: IAlertOptions): Promise;", - "accessModifier": "public", - "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 - }, - "prompt": { - "kind": "method", - "signature": "public prompt(message: string, options?: IPromptOptions): Promise;", - "accessModifier": "public", - "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 - }, - "show": { - "kind": "method", - "signature": "public show(dialog: BaseDialog, options?: IDialogShowOptions): Promise;", - "accessModifier": "public", - "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 - } - } - } - } -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "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", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-dialog!", + "name": "", + "members": [ + { + "kind": "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 BaseDialog " + } + ], + "releaseTag": "Public", + "name": "BaseDialog", + "members": [ + { + "kind": "Constructor", + "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(config?: " + }, + { + "kind": "Reference", + "text": "IDialogConfiguration", + "canonicalReference": "@microsoft/sp-dialog!IDialogConfiguration:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "config", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Method", + "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": "Content", + "text": "close(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "close" + }, + { + "kind": "Property", + "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 domElement: " + }, + { + "kind": "Reference", + "text": "HTMLElement", + "canonicalReference": "!HTMLElement:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "domElement", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 isHidden: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isHidden", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 isOpen: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isOpen", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 isSecondary: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isSecondary", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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 onAfterClose(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "onAfterClose" + }, + { + "kind": "Method", + "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 onBeforeOpen(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "onBeforeOpen" + }, + { + "kind": "Method", + "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 render(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "render" + }, + { + "kind": "Property", + "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 secondaryDialogProvider: " + }, + { + "kind": "Reference", + "text": "ISecondaryDialogProvider", + "canonicalReference": "@microsoft/sp-dialog!ISecondaryDialogProvider:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "secondaryDialogProvider", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Method", + "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": "Content", + "text": "show(options?: " + }, + { + "kind": "Reference", + "text": "IDialogShowOptions", + "canonicalReference": "@microsoft/sp-dialog!IDialogShowOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "show" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 Dialog " + } + ], + "releaseTag": "Public", + "name": "Dialog", + "members": [ + { + "kind": "Method", + "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 alert(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "IAlertOptions", + "canonicalReference": "@microsoft/sp-dialog!IAlertOptions: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": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "alert" + }, + { + "kind": "Method", + "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 prompt(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "IPromptOptions", + "canonicalReference": "@microsoft/sp-dialog!IPromptOptions: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": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "prompt" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 IAlertOptions extends " + }, + { + "kind": "Reference", + "text": "IDialogShowOptions", + "canonicalReference": "@microsoft/sp-dialog!IDialogShowOptions:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IAlertOptions", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 IDialogConfiguration " + } + ], + "releaseTag": "Public", + "name": "IDialogConfiguration", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "isBlocking?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isBlocking", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IDialogShowOptions " + } + ], + "releaseTag": "Public", + "name": "IDialogShowOptions", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "confirmOpen?: " + }, + { + "kind": "Content", + "text": "() => boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "confirmOpen", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IPromptOptions extends " + }, + { + "kind": "Reference", + "text": "IDialogShowOptions", + "canonicalReference": "@microsoft/sp-dialog!IDialogShowOptions:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPromptOptions", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-dialog!IPromptOptions#defaultValue:member", + "docComment": "/**\n * The default value for the input text field of prompt dialog\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defaultValue?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "defaultValue", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 ISecondaryDialogProvider " + } + ], + "releaseTag": "Public", + "name": "ISecondaryDialogProvider", + "members": [ + { + "kind": "MethodSignature", + "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": "Content", + "text": "alert(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "IAlertOptions", + "canonicalReference": "@microsoft/sp-dialog!IAlertOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "alert" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "prompt(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "IPromptOptions", + "canonicalReference": "@microsoft/sp-dialog!IPromptOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "prompt" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "show(dialog: " + }, + { + "kind": "Reference", + "text": "BaseDialog", + "canonicalReference": "@microsoft/sp-dialog!default:class" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "IDialogShowOptions", + "canonicalReference": "@microsoft/sp-dialog!IDialogShowOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "dialog", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "show" + } + ], + "extendsTokenRanges": [] + } + ] + } + ] +} 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..a0552b4f --- /dev/null +++ b/generate-docs/json/sp-dynamic-data.api.json @@ -0,0 +1,1386 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "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", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-dynamic-data!", + "name": "", + "members": [ + { + "kind": "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 DynamicDataReference " + } + ], + "releaseTag": "Public", + "name": "DynamicDataReference", + "members": [ + { + "kind": "Constructor", + "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(reference: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "reference", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Property", + "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 property: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "property", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 propertyPath: " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "propertyPath", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 reference: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "reference", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 sourceId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "sourceId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 IDynamicDataAnnotatedPropertyValue " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataAnnotatedPropertyValue", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#metadata:member", + "docComment": "/**\n * Metadata describing the sample value of the property.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "metadata?: " + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyValueMetadataCollection", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "metadata", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#sampleValue:member", + "docComment": "/**\n * Sample value of a property\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sampleValue: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "sampleValue", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IDynamicDataCallables " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataCallables", + "members": [ + { + "kind": "MethodSignature", + "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": "Content", + "text": "allowedEvents?(): " + }, + { + "kind": "Reference", + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDynamicDataEventDefinition", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [], + "name": "allowedEvents" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "getAnnotatedPropertyValue?(propertyId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IDynamicDataAnnotatedPropertyValue", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "propertyId", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getAnnotatedPropertyValue" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "getPropertyDefinitions(): " + }, + { + "kind": "Reference", + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyDefinition", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getPropertyDefinitions" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "getPropertyValue(propertyId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "propertyId", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getPropertyValue" + }, + { + "kind": "MethodSignature", + "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": "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": "@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 IDynamicDataEventDefinition " + } + ], + "releaseTag": "Beta", + "name": "IDynamicDataEventDefinition", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#description:member", + "docComment": "/**\n * User-friendly, localized description of the event.\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-dynamic-data!IDynamicDataEventDefinition#name:member", + "docComment": "/**\n * Event name\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IDynamicDataPropertyDefinition extends " + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyMetadata", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataPropertyDefinition", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 IDynamicDataPropertyMetadata " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataPropertyMetadata", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "description?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "title: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IDynamicDataPropertyValueMetadata extends " + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyMetadata", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyMetadata:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataPropertyValueMetadata", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata#metadata:member", + "docComment": "/**\n * Metadata describing the sample value of the property.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "metadata?: " + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyValueMetadataCollection", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadataCollection:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "metadata", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 IDynamicDataPropertyValueMetadataCollection " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataPropertyValueMetadataCollection", + "members": [ + { + "kind": "IndexSignature", + "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": "[key: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyValueMetadata", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyValueMetadata:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "key", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IDynamicDataSource " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataSource", + "members": [ + { + "kind": "MethodSignature", + "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": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDynamicDataEventDefinition", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataEventDefinition:interface" + }, + { + "kind": "Content", + "text": ">>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 7 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [], + "name": "allowedEventsAsync" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "getAnnotatedPropertyValue(propertyId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IDynamicDataAnnotatedPropertyValue", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface" + }, + { + "kind": "Content", + "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", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDynamicDataAnnotatedPropertyValue", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "propertyId", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getAnnotatedPropertyValueAsync" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "getPropertyDefinitions(): " + }, + { + "kind": "Reference", + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyDefinition", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getPropertyDefinitions" + }, + { + "kind": "MethodSignature", + "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": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDynamicDataPropertyDefinition", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataPropertyDefinition:interface" + }, + { + "kind": "Content", + "text": ">>" + }, + { + "kind": "Content", + "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", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "propertyId", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getPropertyValue" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "getPropertyValueAsync(propertyId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "propertyId", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getPropertyValueAsync" + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSource#id:member", + "docComment": "/**\n * Id of the Dynamic Data Source.\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-dynamic-data!IDynamicDataSource#metadata:member", + "docComment": "/**\n * Metadata of the Dynamic Data Source.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "metadata: " + }, + { + "kind": "Reference", + "text": "IDynamicDataSourceMetadata", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "metadata", + "propertyTypeTokenRange": { + "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": "@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 IDynamicDataSourceMetadata " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataSourceMetadata", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "alias?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "alias", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "componentId?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "componentId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#description:member", + "docComment": "/**\n * User-friendly, localized description of the Dynamic Data Source.\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-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": "Content", + "text": "instanceId?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "instanceId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "title: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + } + ] + } + ] +} diff --git a/generate-docs/json/sp-extension-base.api.json b/generate-docs/json/sp-extension-base.api.json index 4305444c..cd1aa9e1 100644 --- a/generate-docs/json/sp-extension-base.api.json +++ b/generate-docs/json/sp-extension-base.api.json @@ -1,181 +1,177 @@ -{ - "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, - "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 - }, - "onInit": { - "kind": "method", - "signature": "@virtual 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 - }, - "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 - } - } - }, - "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, - "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 - } - } - } - } -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "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", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-extension-base!", + "name": "", + "members": [ + { + "kind": "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 BaseExtension extends " + }, + { + "kind": "Reference", + "text": "BaseComponent", + "canonicalReference": "@microsoft/sp-component-base!BaseComponent:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "BaseExtension", + "members": [ + { + "kind": "Property", + "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 context: " + }, + { + "kind": "Reference", + "text": "ExtensionContext", + "canonicalReference": "@microsoft/sp-extension-base!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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 onInit(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "onInit" + }, + { + "kind": "Property", + "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 properties: " + }, + { + "kind": "Content", + "text": "TProperties" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "properties", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "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 ExtensionContext extends " + }, + { + "kind": "Reference", + "text": "BaseComponentContext", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "ExtensionContext", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + } + ] + } + ] +} diff --git a/generate-docs/json/sp-http.api.json b/generate-docs/json/sp-http.api.json index d73a9384..c1d74c0b 100644 --- a/generate-docs/json/sp-http.api.json +++ b/generate-docs/json/sp-http.api.json @@ -1,3322 +1,7065 @@ -{ - "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": { - "GraphHttpClient": { - "kind": "class", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [ - { - "kind": "text", - "text": "The GraphHttpClient class has been superceded 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, - "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 superceded 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": "public 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." - } - ], - "summary": [ - { - "kind": "text", - "text": "The standard predefined GraphHttpClientConfiguration objects for use with the GraphHttpClient class." - } - ], - "remarks": [], - "isBeta": true - }, - "fetch": { - "kind": "method", - "signature": "public fetch(url: string,\r\n configuration: GraphHttpClientConfiguration,\r\n options: IGraphHttpClientOptions): Promise;", - "accessModifier": "public", - "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 superceded 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 - }, - "get": { - "kind": "method", - "signature": "public get(url: string, configuration: GraphHttpClientConfiguration,\r\n options?: IGraphHttpClientOptions): Promise;", - "accessModifier": "public", - "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 superceded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"GET\"." - } - ], - "remarks": [], - "isBeta": true - }, - "post": { - "kind": "method", - "signature": "public post(url: string, configuration: GraphHttpClientConfiguration,\r\n options: IGraphHttpClientOptions): Promise;", - "accessModifier": "public", - "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 superceded by the MSGraphClient class." - } - ], - "summary": [ - { - "kind": "text", - "text": "Calls fetch(), but sets the method to \"POST\"." - } - ], - "remarks": [], - "isBeta": true - }, - "serviceKey": { - "kind": "property", - "signature": "public 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." - } - ], - "summary": [ - { - "kind": "text", - "text": "The service key for GraphHttpClient." - } - ], - "remarks": [], - "isBeta": true - } - } - }, - "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, - "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 - } - } - }, - "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, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "public 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": "@override public clone(): GraphHttpClientResponse;", - "accessModifier": "public", - "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 - } - } - }, - "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, - "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": "public 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 - }, - "fetch": { - "kind": "method", - "signature": "public fetch(url: string, configuration: HttpClientConfiguration,\r\n options: IHttpClientOptions): Promise;", - "accessModifier": "public", - "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": "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 - }, - "get": { - "kind": "method", - "signature": "public get(url: string, configuration: HttpClientConfiguration,\r\n options?: IHttpClientOptions): Promise;", - "accessModifier": "public", - "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": "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 - }, - "post": { - "kind": "method", - "signature": "public post(url: string, configuration: HttpClientConfiguration,\r\n options: IHttpClientOptions): Promise;", - "accessModifier": "public", - "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": "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 - }, - "serviceKey": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "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 - }, - "initializeFlags": { - "kind": "method", - "signature": "@virtual 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 - }, - "overrideWith": { - "kind": "method", - "signature": "@virtual public overrideWith(sourceFlags: IHttpClientConfiguration): HttpClientConfiguration;", - "accessModifier": "public", - "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 - } - } - }, - "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, - "members": { - "arrayBuffer": { - "kind": "method", - "signature": "public arrayBuffer(): Promise;", - "accessModifier": "public", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Body.arrayBuffer" - } - ], - "remarks": [], - "isBeta": false - }, - "blob": { - "kind": "method", - "signature": "public blob(): Promise;", - "accessModifier": "public", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Body.blob" - } - ], - "remarks": [], - "isBeta": false - }, - "bodyUsed": { - "kind": "property", - "signature": "public 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 - }, - "clone": { - "kind": "method", - "signature": "@virtual public clone(): HttpClientResponse;", - "accessModifier": "public", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "HttpClientResponse", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false - }, - "formData": { - "kind": "method", - "signature": "public formData(): Promise;", - "accessModifier": "public", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Body.formData" - } - ], - "remarks": [], - "isBeta": false - }, - "headers": { - "kind": "property", - "signature": "public 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 - }, - "json": { - "kind": "method", - "signature": "public json(): Promise;", - "accessModifier": "public", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Body.json" - } - ], - "remarks": [], - "isBeta": false - }, - "nativeResponse": { - "kind": "property", - "signature": "protected nativeResponse: Response;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "Response", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false - }, - "ok": { - "kind": "property", - "signature": "public 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 - }, - "status": { - "kind": "property", - "signature": "public 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 - }, - "statusText": { - "kind": "property", - "signature": "public 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 - }, - "text": { - "kind": "method", - "signature": "public text(): Promise;", - "accessModifier": "public", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "Promise", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "See documentation for whatwg-fetch:Body.text" - } - ], - "remarks": [], - "isBeta": false - }, - "type": { - "kind": "property", - "signature": "public 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 - }, - "url": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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 - }, - "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, - "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 - } - } - }, - "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 - }, - "IHttpClientConfiguration": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Flags interface for HttpClientConfiguration." - } - ], - "remarks": [], - "isBeta": 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, - "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 - } - } - }, - "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 - }, - "ISPHttpClientBatchConfiguration": { - "kind": "interface", - "extends": "ISPHttpClientCommonConfiguration", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Flags interface for SPHttpClientBatchConfiguration." - } - ], - "remarks": [], - "isBeta": true - }, - "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, - "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 - } - } - }, - "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, - "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 - } - } - }, - "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 - }, - "ISPHttpClientCommonConfiguration": { - "kind": "interface", - "extends": "IHttpClientConfiguration", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Flags interface for SPHttpClientCommonConfiguration" - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - } - } - }, - "ISPHttpClientConfiguration": { - "kind": "interface", - "extends": "ISPHttpClientCommonConfiguration", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Flags interface for SPHttpClientConfiguration." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - } - } - }, - "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, - "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 - } - } - }, - "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, - "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 - } - } - }, - "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, - "members": { - "toString": { - "kind": "method", - "signature": "public toString(): string;", - "accessModifier": "public", - "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 - }, - "tryParseFromHeaders": { - "kind": "method", - "signature": "public static tryParseFromHeaders(headers: Headers): ODataVersion | undefined;", - "accessModifier": "public", - "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 - }, - "v3": { - "kind": "property", - "signature": "public 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 - }, - "v4": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "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": "public beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;", - "accessModifier": "public", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "SPHttpClientBatch", - "description": [ - { - "kind": "text", - "text": "a promise that will return the result" - } - ] - }, - "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 - }, - "configurations": { - "kind": "property", - "signature": "public 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 - }, - "fetch": { - "kind": "method", - "signature": "public fetch(url: string, configuration: SPHttpClientConfiguration,\r\n options: ISPHttpClientOptions): Promise;", - "accessModifier": "public", - "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 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 - }, - "get": { - "kind": "method", - "signature": "public get(url: string, configuration: SPHttpClientConfiguration,\r\n options?: ISPHttpClientOptions): Promise;", - "accessModifier": "public", - "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 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 - }, - "getWebUrlFromRequestUrl": { - "kind": "method", - "signature": "public static getWebUrlFromRequestUrl(requestUrl: string): string;", - "accessModifier": "public", - "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 - }, - "post": { - "kind": "method", - "signature": "public post(url: string, configuration: SPHttpClientConfiguration,\r\n options: ISPHttpClientOptions): Promise;", - "accessModifier": "public", - "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 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 - }, - "serviceKey": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "members": { - "configurations": { - "kind": "property", - "signature": "public 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 - }, - "execute": { - "kind": "method", - "signature": "public execute(): Promise;", - "accessModifier": "public", - "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 - }, - "fetch": { - "kind": "method", - "signature": "public fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise;", - "accessModifier": "public", - "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 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). The parameters for this function are basically the same as the WHATWG API standard documented here: 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." - }, - { - "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." - } - ], - "remarks": [], - "isBeta": true - }, - "get": { - "kind": "method", - "signature": "public get(url: string, configuration: SPHttpClientBatchConfiguration,\r\n options?: ISPHttpClientBatchOptions): Promise;", - "accessModifier": "public", - "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 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 - }, - "post": { - "kind": "method", - "signature": "public post(url: string, configuration: SPHttpClientBatchConfiguration,\r\n options: ISPHttpClientBatchOptions): Promise;", - "accessModifier": "public", - "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 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 - } - } - }, - "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, - "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 - }, - "initializeFlags": { - "kind": "method", - "signature": "@override protected initializeFlags(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true - }, - "overrideWith": { - "kind": "method", - "signature": "@override public overrideWith(sourceFlags: ISPHttpClientBatchConfiguration): SPHttpClientBatchConfiguration;", - "accessModifier": "public", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "SPHttpClientBatchConfiguration", - "description": [] - }, - "parameters": { - "sourceFlags": { - "name": "sourceFlags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientBatchConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": true - } - } - }, - "SPHttpClientCommonConfiguration": { - "kind": "class", - "extends": "HttpClientConfiguration", - "implements": "ISPHttpClientCommonConfiguration", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Common base class for SPHttpClientConfiguration and SPHttpClientBatchConfiguration." - } - ], - "remarks": [], - "isBeta": 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 - }, - "initializeFlags": { - "kind": "method", - "signature": "@override protected initializeFlags(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false - }, - "jsonRequest": { - "kind": "property", - "signature": "public 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 - }, - "jsonResponse": { - "kind": "property", - "signature": "public 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 - }, - "overrideWith": { - "kind": "method", - "signature": "@override public overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration;", - "accessModifier": "public", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "SPHttpClientCommonConfiguration", - "description": [] - }, - "parameters": { - "sourceFlags": { - "name": "sourceFlags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientCommonConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false - } - } - }, - "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, - "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": "public 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 - }, - "defaultSameOriginCredentials": { - "kind": "property", - "signature": "public 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 - }, - "flags": { - "kind": "property", - "signature": "protected flags: ISPHttpClientConfiguration;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "ISPHttpClientConfiguration", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false - }, - "initializeFlags": { - "kind": "method", - "signature": "@override protected initializeFlags(): void;", - "accessModifier": "protected", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false - }, - "overrideWith": { - "kind": "method", - "signature": "@override public overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration;", - "accessModifier": "public", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "SPHttpClientConfiguration", - "description": [] - }, - "parameters": { - "sourceFlags": { - "name": "sourceFlags", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "ISPHttpClientConfiguration" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false - }, - "requestDigest": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "members": { - "__constructor": { - "kind": "constructor", - "signature": "public 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": "@override public clone(): SPHttpClientResponse;", - "accessModifier": "public", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "SPHttpClientResponse", - "description": [] - }, - "parameters": {}, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false - }, - "correlationId": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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 - } - } -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "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", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-http!", + "name": "", + "members": [ + { + "kind": "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 AadHttpClient " + } + ], + "releaseTag": "Public", + "name": "AadHttpClient", + "members": [ + { + "kind": "Constructor", + "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(serviceScope: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class" + }, + { + "kind": "Content", + "text": ", resourceEndpoint: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "IAadHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientOptions:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "resourceEndpoint", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ] + }, + { + "kind": "Property", + "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 configurations: " + }, + { + "kind": "Reference", + "text": "IAadHttpClientConfigurations", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientConfigurations:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "configurations", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Method", + "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": "Content", + "text": "fetch(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", configuration: " + }, + { + "kind": "Reference", + "text": "AadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "fetch" + }, + { + "kind": "Method", + "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": "Content", + "text": "get(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", configuration: " + }, + { + "kind": "Reference", + "text": "AadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "get" + }, + { + "kind": "Method", + "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": "Content", + "text": "post(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", configuration: " + }, + { + "kind": "Reference", + "text": "AadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "post" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 AadHttpClientConfiguration extends " + }, + { + "kind": "Reference", + "text": "HttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": " " + }, + { + "kind": "Content", + "text": "implements " + }, + { + "kind": "Reference", + "text": "IAadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "AadHttpClientConfiguration", + "members": [ + { + "kind": "Constructor", + "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(flags: " + }, + { + "kind": "Reference", + "text": "IAadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": ", overrideFlags?: " + }, + { + "kind": "Reference", + "text": "IAadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "flags", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "overrideFlags", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-http!AadHttpClientConfiguration#flags:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected flags: " + }, + { + "kind": "Reference", + "text": "IAadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "flags", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-http!AadHttpClientConfiguration#overrideWith:member(1)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "overrideWith(sourceFlags: " + }, + { + "kind": "Reference", + "text": "IAadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sourceFlags", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "overrideWith" + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [ + { + "startIndex": 4, + "endIndex": 6 + } + ] + }, + { + "kind": "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 AadHttpClientFactory " + } + ], + "releaseTag": "Public", + "name": "AadHttpClientFactory", + "members": [ + { + "kind": "Method", + "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": "Content", + "text": "getClient(resourceEndpoint: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "AadHttpClient", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "resourceEndpoint", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getClient" + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-http!AadHttpClientFactory.serviceKey:member", + "docComment": "/**\n * The service key for AadHttpClientFactory.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly serviceKey: " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "AadHttpClientFactory", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": true + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 AadTokenProvider implements " + }, + { + "kind": "Reference", + "text": "IAadTokenProvider", + "canonicalReference": "@microsoft/sp-http!IAadTokenProvider:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "AadTokenProvider", + "members": [ + { + "kind": "Method", + "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": "Content", + "text": "getToken(resourceEndpoint: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", useCachedToken?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "resourceEndpoint", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "useCachedToken", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getToken" + }, + { + "kind": "Property", + "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 tokenAcquisitionEvent: " + }, + { + "kind": "Reference", + "text": "SPEvent", + "canonicalReference": "@microsoft/sp-core-library!SPEvent:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "TokenAcquisitionEventArgs", + "canonicalReference": "@microsoft/sp-http!TokenAcquisitionEventArgs:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "tokenAcquisitionEvent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 AadTokenProviderFactory " + } + ], + "releaseTag": "Public", + "name": "AadTokenProviderFactory", + "members": [ + { + "kind": "Method", + "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": "Content", + "text": "getTokenProvider(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "AadTokenProvider", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getTokenProvider" + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-http!AadTokenProviderFactory.serviceKey:member", + "docComment": "/**\n * The service key for AadTokenProviderFactory.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly serviceKey: " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "AadTokenProviderFactory", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": true + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 DigestCache implements " + }, + { + "kind": "Reference", + "text": "IDigestCache", + "canonicalReference": "@microsoft/sp-http!IDigestCache:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "DigestCache", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "@microsoft/sp-http!DigestCache:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `DigestCache` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(serviceScope: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Method", + "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": "Content", + "text": "addDigestToCache(webUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", digestValue: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", expirationTimestamp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "webUrl", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "digestValue", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "expirationTimestamp", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "addDigestToCache" + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-http!DigestCache#clearAllDigests:member(1)", + "docComment": "/**\n * Clears all values from the cache.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearAllDigests(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "clearAllDigests" + }, + { + "kind": "Method", + "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": "Content", + "text": "clearDigest(webUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "webUrl", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "clearDigest" + }, + { + "kind": "Method", + "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": "Content", + "text": "fetchDigest(webUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "webUrl", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "fetchDigest" + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-http!DigestCache.serviceKey:member", + "docComment": "/**\n * The service key for IDigestCache.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly serviceKey: " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IDigestCache", + "canonicalReference": "@microsoft/sp-http!IDigestCache:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": true + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 IGraphRequest " + } + ], + "releaseTag": "Public", + "name": "GraphRequest", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#_headers:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "_headers: " + }, + { + "kind": "Content", + "text": "{\n [key: string]: string | number;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "_headers", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#_responseType:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "_responseType: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "_responseType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#buildFullUrl:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "buildFullUrl(): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "buildFullUrl" + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#config:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "config: " + }, + { + "kind": "Reference", + "text": "Options", + "canonicalReference": "@microsoft/microsoft-graph-client!Options:interface" + }, + { + "kind": "Content", + "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": "constructor(config: " + }, + { + "kind": "Reference", + "text": "Options", + "canonicalReference": "@microsoft/microsoft-graph-client!Options:interface" + }, + { + "kind": "Content", + "text": ", path: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "config", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "constructor" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#count:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "count(count: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "count", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "count" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#create:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "create(content: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", callback?: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "content", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "create" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#del:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "del(callback?: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "del" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#delete:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "delete(callback?: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "delete" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#expand:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "expand(properties: " + }, + { + "kind": "Content", + "text": "string | string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "expand" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#filter:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "filter(filterStr: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "filterStr", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "filter" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#get:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "get(callback?: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "get" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#getStream:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "getStream(callback: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getStream" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#header:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "header(headerKey: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", headerValue: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "this" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "headerKey", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "headerValue", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "header" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#headers:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "headers(headers: " + }, + { + "kind": "Content", + "text": "{\n [key: string]: string | number;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "this" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "headers", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "headers" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#orderby:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "orderby(properties: " + }, + { + "kind": "Content", + "text": "string | string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "orderby" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#parsePath:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "parsePath(rawPath: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "rawPath", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "parsePath" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#patch:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "patch(content: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", callback?: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "content", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "patch" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#post:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "post(content: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", callback?: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "content", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "post" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#put:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "put(content: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", callback?: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "content", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "put" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#putStream:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "putStream(stream: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", callback: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "stream", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "putStream" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#query:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "query(queryDictionaryOrString: " + }, + { + "kind": "Content", + "text": "string | {\n [key: string]: string | number;\n }" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "queryDictionaryOrString", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "query" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#responseType:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "responseType(responseType: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "responseType", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "responseType" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#select:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "select(properties: " + }, + { + "kind": "Content", + "text": "string | string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "properties", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "select" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#skip:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "skip(n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "skip" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#skipToken:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "skipToken(token: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "token", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "skipToken" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#top:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "top(n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "top" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#update:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "update(content: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", callback?: " + }, + { + "kind": "Reference", + "text": "GraphRequestCallback", + "canonicalReference": "@microsoft/microsoft-graph-client!GraphRequestCallback:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "content", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "callback", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "update" + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-http!GraphRequest#urlComponents:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "urlComponents: " + }, + { + "kind": "Reference", + "text": "URLComponents", + "canonicalReference": "@microsoft/microsoft-graph-client!URLComponents:interface" + }, + { + "kind": "Content", + "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", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "v", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "version" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 HttpClient " + } + ], + "releaseTag": "Public", + "name": "HttpClient", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "@microsoft/sp-http!HttpClient:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `HttpClient` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(serviceScope: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Property", + "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 configurations: " + }, + { + "kind": "Reference", + "text": "IHttpClientConfigurations", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfigurations:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "configurations", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Method", + "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": "Content", + "text": "fetch(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", configuration: " + }, + { + "kind": "Reference", + "text": "HttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "fetch" + }, + { + "kind": "Method", + "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": "Content", + "text": "get(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", configuration: " + }, + { + "kind": "Reference", + "text": "HttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "get" + }, + { + "kind": "Method", + "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": "Content", + "text": "post(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", configuration: " + }, + { + "kind": "Reference", + "text": "HttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "post" + }, + { + "kind": "Property", + "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 serviceKey: " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HttpClient", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": true + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 HttpClientConfiguration implements " + }, + { + "kind": "Reference", + "text": "IHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "HttpClientConfiguration", + "members": [ + { + "kind": "Constructor", + "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(flags: " + }, + { + "kind": "Reference", + "text": "IHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": ", overrideFlags?: " + }, + { + "kind": "Reference", + "text": "IHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "flags", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "overrideFlags", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-http!HttpClientConfiguration#flags:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected flags: " + }, + { + "kind": "Reference", + "text": "IHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "flags", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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 initializeFlags(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "initializeFlags" + }, + { + "kind": "Method", + "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": "Content", + "text": "overrideWith(sourceFlags: " + }, + { + "kind": "Reference", + "text": "IHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "HttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sourceFlags", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "overrideWith" + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 HttpClientResponse implements " + }, + { + "kind": "Reference", + "text": "Response", + "canonicalReference": "!Response:interface" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "Body", + "canonicalReference": "!Body:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "HttpClientResponse", + "members": [ + { + "kind": "Method", + "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": "Content", + "text": "arrayBuffer(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ArrayBuffer", + "canonicalReference": "!ArrayBuffer:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "arrayBuffer" + }, + { + "kind": "Method", + "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": "Content", + "text": "blob(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Blob", + "canonicalReference": "!Blob:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "blob" + }, + { + "kind": "Property", + "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 bodyUsed: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "bodyUsed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse#clone:member(1)", + "docComment": "/**\n * @virtual\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clone(): " + }, + { + "kind": "Reference", + "text": "HttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "clone" + }, + { + "kind": "Method", + "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": "Content", + "text": "formData(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "FormData", + "canonicalReference": "!FormData:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "formData" + }, + { + "kind": "Property", + "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 headers: " + }, + { + "kind": "Reference", + "text": "Headers", + "canonicalReference": "!Headers:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "headers", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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": "Content", + "text": "json(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "json" + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-http!HttpClientResponse#nativeResponse:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected nativeResponse: " + }, + { + "kind": "Reference", + "text": "Response", + "canonicalReference": "!Response:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "nativeResponse", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 ok: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ok", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 status: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "status", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 statusText: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "statusText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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": "Content", + "text": "text(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "text" + }, + { + "kind": "Property", + "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 type: " + }, + { + "kind": "Reference", + "text": "ResponseType", + "canonicalReference": "!ResponseType:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "url", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + }, + { + "startIndex": 3, + "endIndex": 5 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientConfiguration:interface", + "docComment": "/**\n * Flags interface for HttpClientConfiguration.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IAadHttpClientConfiguration extends " + }, + { + "kind": "Reference", + "text": "IHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IAadHttpClientConfiguration", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 IAadHttpClientConfigurations " + } + ], + "releaseTag": "Public", + "name": "IAadHttpClientConfigurations", + "members": [ + { + "kind": "PropertySignature", + "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 v1: " + }, + { + "kind": "Reference", + "text": "AadHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "v1", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IAadHttpClientOptions " + } + ], + "releaseTag": "Public", + "name": "IAadHttpClientOptions", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientOptions#configuration:member", + "docComment": "/**\n * @deprecated\n *\n * - AadHttpClient's configuration cannot be altered\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "configuration?: " + }, + { + "kind": "Reference", + "text": "IAadTokenProviderConfiguration", + "canonicalReference": "@microsoft/sp-http!IAadTokenProviderConfiguration:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "configuration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-http!IAadHttpClientOptions#tokenProvider:member", + "docComment": "/**\n * @deprecated\n *\n * - AadHttpClient does not support a custom tokenProvider.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tokenProvider?: " + }, + { + "kind": "Reference", + "text": "IAadTokenProvider", + "canonicalReference": "@microsoft/sp-http!IAadTokenProvider:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "tokenProvider", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "useCachedToken?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "useCachedToken", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IAadTokenProvider " + } + ], + "releaseTag": "Public", + "name": "IAadTokenProvider", + "members": [ + { + "kind": "MethodSignature", + "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": "Content", + "text": "getToken(resourceEndpoint: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", useCachedToken?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "resourceEndpoint", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "useCachedToken", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getToken" + }, + { + "kind": "PropertySignature", + "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 tokenAcquisitionEvent: " + }, + { + "kind": "Reference", + "text": "SPEvent", + "canonicalReference": "@microsoft/sp-core-library!SPEvent:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ITokenAcquisitionEventArgs", + "canonicalReference": "@microsoft/sp-http!ITokenAcquisitionEventArgs:interface" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "tokenAcquisitionEvent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IAadTokenProviderConfiguration " + } + ], + "releaseTag": "Public", + "name": "IAadTokenProviderConfiguration", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "aadInstanceUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "aadInstanceUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-http!IAadTokenProviderConfiguration#aadTenantId:member", + "docComment": "/**\n * The Azure Active Directory's tenant id.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "aadTenantId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "aadTenantId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "aadUserId?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "aadUserId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "redirectUri: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "redirectUri", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-http!IAadTokenProviderConfiguration#servicePrincipalId:member", + "docComment": "/**\n * The client ID of the developer's Azure Active Directory application.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "servicePrincipalId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "servicePrincipalId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "userEmail?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "userEmail", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "userPrincipalName?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "userPrincipalName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IDigestCache " + } + ], + "releaseTag": "Public", + "name": "IDigestCache", + "members": [ + { + "kind": "MethodSignature", + "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": "Content", + "text": "addDigestToCache(webUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", digestValue: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", expirationTimestamp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "webUrl", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "digestValue", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "expirationTimestamp", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "addDigestToCache" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-http!IDigestCache#clearAllDigests:member(1)", + "docComment": "/**\n * Clears all values from the cache.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearAllDigests(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "clearAllDigests" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "clearDigest(webUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "webUrl", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "clearDigest" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "fetchDigest(webUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "webUrl", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "fetchDigest" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfiguration:interface", + "docComment": "/**\n * Flags interface for HttpClientConfiguration.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface IHttpClientConfiguration " + } + ], + "releaseTag": "Public", + "name": "IHttpClientConfiguration", + "members": [], + "extendsTokenRanges": [] + }, + { + "kind": "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 IHttpClientConfigurations " + } + ], + "releaseTag": "Public", + "name": "IHttpClientConfigurations", + "members": [ + { + "kind": "PropertySignature", + "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 v1: " + }, + { + "kind": "Reference", + "text": "HttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "v1", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IHttpClientOptions extends " + }, + { + "kind": "Reference", + "text": "RequestInit", + "canonicalReference": "!RequestInit:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IHttpClientOptions", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface", + "docComment": "/**\n * Flags interface for SPHttpClientBatchConfiguration.\n *\n * @beta\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ISPHttpClientBatchConfiguration extends " + }, + { + "kind": "Reference", + "text": "ISPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Beta", + "name": "ISPHttpClientBatchConfiguration", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 ISPHttpClientBatchConfigurations " + } + ], + "releaseTag": "Beta", + "name": "ISPHttpClientBatchConfigurations", + "members": [ + { + "kind": "PropertySignature", + "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 v1: " + }, + { + "kind": "Reference", + "text": "SPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "v1", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 ISPHttpClientBatchCreationOptions " + } + ], + "releaseTag": "Beta", + "name": "ISPHttpClientBatchCreationOptions", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "webUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "webUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 ISPHttpClientBatchOptions extends " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Beta", + "name": "ISPHttpClientBatchOptions", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface", + "docComment": "/**\n * Flags interface for SPHttpClientCommonConfiguration\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ISPHttpClientCommonConfiguration extends " + }, + { + "kind": "Reference", + "text": "IHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!IHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "ISPHttpClientCommonConfiguration", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "jsonRequest?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "jsonRequest", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "jsonResponse?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "jsonResponse", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfiguration:interface", + "docComment": "/**\n * Flags interface for SPHttpClientConfiguration.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface ISPHttpClientConfiguration extends " + }, + { + "kind": "Reference", + "text": "ISPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "ISPHttpClientConfiguration", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "defaultODataVersion?: " + }, + { + "kind": "Reference", + "text": "ODataVersion", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "defaultODataVersion", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "defaultSameOriginCredentials?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "defaultSameOriginCredentials", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "requestDigest?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "requestDigest", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 ISPHttpClientConfigurations " + } + ], + "releaseTag": "Public", + "name": "ISPHttpClientConfigurations", + "members": [ + { + "kind": "PropertySignature", + "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 v1: " + }, + { + "kind": "Reference", + "text": "SPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "v1", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 ISPHttpClientOptions extends " + }, + { + "kind": "Reference", + "text": "IHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!IHttpClientOptions:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "ISPHttpClientOptions", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "webUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "webUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 ITokenAcquisitionEventArgs extends " + }, + { + "kind": "Reference", + "text": "SPEventArgs", + "canonicalReference": "@microsoft/sp-core-library!SPEventArgs:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "ITokenAcquisitionEventArgs", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "message", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "redirectUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "redirectUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "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 MSGraphClient " + } + ], + "releaseTag": "Public", + "name": "MSGraphClient", + "members": [ + { + "kind": "Method", + "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": "Content", + "text": "api(path: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", config?: " + }, + { + "kind": "Reference", + "text": "Options", + "canonicalReference": "@microsoft/microsoft-graph-client!Options:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IGraphRequest", + "canonicalReference": "@microsoft/sp-http!IGraphRequest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "config", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "api" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 MSGraphClientFactory " + } + ], + "releaseTag": "Public", + "name": "MSGraphClientFactory", + "members": [ + { + "kind": "Method", + "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": "Content", + "text": "getClient(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "MSGraphClient", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getClient" + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-http!MSGraphClientFactory.serviceKey:member", + "docComment": "/**\n * The service key for MSGraphClientFactory.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly serviceKey: " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "MSGraphClientFactory", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": true + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 ODataVersion " + } + ], + "releaseTag": "Public", + "name": "ODataVersion", + "members": [ + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-http!ODataVersion#toString:member(1)", + "docComment": "/**\n * Returns the \"OData-Version\" value, for example \"4.0\".\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "toString(): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "toString" + }, + { + "kind": "Method", + "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 tryParseFromHeaders(headers: " + }, + { + "kind": "Reference", + "text": "Headers", + "canonicalReference": "!Headers:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ODataVersion", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "headers", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "tryParseFromHeaders" + }, + { + "kind": "Property", + "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 v3: " + }, + { + "kind": "Reference", + "text": "ODataVersion", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "v3", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 v4: " + }, + { + "kind": "Reference", + "text": "ODataVersion", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "v4", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 SPHttpClient " + } + ], + "releaseTag": "Public", + "name": "SPHttpClient", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "@microsoft/sp-http!SPHttpClient:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `SPHttpClient` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(serviceScope: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Method", + "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": "Content", + "text": "beginBatch(batchCreationOptions?: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchCreationOptions", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchCreationOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "SPHttpClientBatch", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "batchCreationOptions", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "beginBatch" + }, + { + "kind": "Property", + "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 configurations: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientConfigurations", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfigurations:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "configurations", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Method", + "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": "Content", + "text": "fetch(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", configuration: " + }, + { + "kind": "Reference", + "text": "SPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPHttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "fetch" + }, + { + "kind": "Method", + "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": "Content", + "text": "get(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", configuration: " + }, + { + "kind": "Reference", + "text": "SPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPHttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "get" + }, + { + "kind": "Method", + "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 getWebUrlFromRequestUrl(requestUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "requestUrl", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getWebUrlFromRequestUrl" + }, + { + "kind": "Method", + "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": "Content", + "text": "post(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", configuration: " + }, + { + "kind": "Reference", + "text": "SPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientOptions", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPHttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "post" + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-http!SPHttpClient.serviceKey:member", + "docComment": "/**\n * The service key for SPHttpClient.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly serviceKey: " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPHttpClient", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": true + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 SPHttpClientBatch " + } + ], + "releaseTag": "Beta", + "name": "SPHttpClientBatch", + "members": [ + { + "kind": "Property", + "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 configurations: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchConfigurations", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchConfigurations:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "configurations", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-http!SPHttpClientBatch#execute:member(1)", + "docComment": "/**\n * Executes the batched queries that were queued using SPHttpClientBatch.fetch().\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "execute(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPHttpClientBatch", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [], + "name": "execute" + }, + { + "kind": "Method", + "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": "Content", + "text": "fetch(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", configuration: " + }, + { + "kind": "Reference", + "text": "SPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchOptions", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPHttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 11 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "fetch" + }, + { + "kind": "Method", + "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": "Content", + "text": "get(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", configuration: " + }, + { + "kind": "Reference", + "text": "SPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ", options?: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchOptions", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPHttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 11 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "get" + }, + { + "kind": "Method", + "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": "Content", + "text": "post(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", configuration: " + }, + { + "kind": "Reference", + "text": "SPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ", options: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchOptions", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPHttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 11 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "configuration", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "post" + } + ], + "implementsTokenRanges": [] + }, + { + "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": "export default class SPHttpClientBatchConfiguration extends " + }, + { + "kind": "Reference", + "text": "SPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": " " + }, + { + "kind": "Content", + "text": "implements " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Beta", + "name": "SPHttpClientBatchConfiguration", + "members": [ + { + "kind": "Constructor", + "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(flags: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface" + }, + { + "kind": "Content", + "text": ", overrideFlags?: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "flags", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "overrideFlags", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-http!SPHttpClientBatchConfiguration#flags:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected flags: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "flags", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-http!SPHttpClientBatchConfiguration#initializeFlags:member(1)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected initializeFlags(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [], + "name": "initializeFlags" + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-http!SPHttpClientBatchConfiguration#overrideWith:member(1)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "overrideWith(sourceFlags: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientBatchConfiguration:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "SPHttpClientBatchConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Beta", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sourceFlags", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "overrideWith" + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [ + { + "startIndex": 4, + "endIndex": 6 + } + ] + }, + { + "kind": "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 SPHttpClientCommonConfiguration extends " + }, + { + "kind": "Reference", + "text": "HttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": " " + }, + { + "kind": "Content", + "text": "implements " + }, + { + "kind": "Reference", + "text": "ISPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "SPHttpClientCommonConfiguration", + "members": [ + { + "kind": "Constructor", + "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(flags: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface" + }, + { + "kind": "Content", + "text": ", overrideFlags?: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "flags", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "overrideFlags", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-http!SPHttpClientCommonConfiguration#flags:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected flags: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "flags", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-http!SPHttpClientCommonConfiguration#initializeFlags:member(1)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected initializeFlags(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "initializeFlags" + }, + { + "kind": "Property", + "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 jsonRequest: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "jsonRequest", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 jsonResponse: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "jsonResponse", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-http!SPHttpClientCommonConfiguration#overrideWith:member(1)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "overrideWith(sourceFlags: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientCommonConfiguration:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "SPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sourceFlags", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "overrideWith" + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [ + { + "startIndex": 4, + "endIndex": 6 + } + ] + }, + { + "kind": "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 SPHttpClientConfiguration extends " + }, + { + "kind": "Reference", + "text": "SPHttpClientCommonConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": " " + }, + { + "kind": "Content", + "text": "implements " + }, + { + "kind": "Reference", + "text": "ISPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "SPHttpClientConfiguration", + "members": [ + { + "kind": "Constructor", + "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(flags: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": ", overrideFlags?: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "flags", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "overrideFlags", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Property", + "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 defaultODataVersion: " + }, + { + "kind": "Reference", + "text": "ODataVersion", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "defaultODataVersion", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 defaultSameOriginCredentials: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "defaultSameOriginCredentials", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-http!SPHttpClientConfiguration#flags:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected flags: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "flags", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-http!SPHttpClientConfiguration#initializeFlags:member(1)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "protected initializeFlags(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "initializeFlags" + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-http!SPHttpClientConfiguration#overrideWith:member(1)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "overrideWith(sourceFlags: " + }, + { + "kind": "Reference", + "text": "ISPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!ISPHttpClientConfiguration:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "SPHttpClientConfiguration", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sourceFlags", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "overrideWith" + }, + { + "kind": "Property", + "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 requestDigest: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "requestDigest", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [ + { + "startIndex": 4, + "endIndex": 6 + } + ] + }, + { + "kind": "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 SPHttpClientResponse extends " + }, + { + "kind": "Reference", + "text": "HttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "SPHttpClientResponse", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "@microsoft/sp-http!SPHttpClientResponse:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `SPHttpClientResponse` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(response: " + }, + { + "kind": "Reference", + "text": "Response", + "canonicalReference": "!Response:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "response", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-http!SPHttpClientResponse#clone:member(1)", + "docComment": "/**\n * @override\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clone(): " + }, + { + "kind": "Reference", + "text": "SPHttpClientResponse", + "canonicalReference": "@microsoft/sp-http!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "clone" + }, + { + "kind": "Property", + "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 correlationId: " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "correlationId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "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 SPHttpHeader " + } + ], + "releaseTag": "Beta", + "name": "SPHttpHeader", + "members": [ + { + "kind": "EnumMember", + "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": "Content", + "text": "SPRequestGuid = " + }, + { + "kind": "Content", + "text": "\"SPRequestGuid\"" + } + ], + "releaseTag": "Beta", + "name": "SPRequestGuid", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "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 TokenAcquisitionEventArgs extends " + }, + { + "kind": "Reference", + "text": "SPEventArgs", + "canonicalReference": "@microsoft/sp-core-library!SPEventArgs:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "TokenAcquisitionEventArgs", + "members": [ + { + "kind": "Constructor", + "canonicalReference": "@microsoft/sp-http!TokenAcquisitionEventArgs:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `TokenAcquisitionEventArgs` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", redirectUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "redirectUrl", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ] + }, + { + "kind": "Property", + "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": "Content", + "text": "message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "message", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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": "Content", + "text": "redirectUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "redirectUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "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 95251917..166e4554 100644 --- a/generate-docs/json/sp-listview-extensibility.api.json +++ b/generate-docs/json/sp-listview-extensibility.api.json @@ -1,1090 +1,1411 @@ -{ - "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, - "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 - }, - "onDisposeCell": { - "kind": "method", - "signature": "@virtual public onDisposeCell(event: IFieldCustomizerCellEventParameters): void;", - "accessModifier": "public", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "event": { - "name": "event", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IFieldCustomizerCellEventParameters" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false - }, - "onRenderCell": { - "kind": "method", - "signature": "@virtual public onRenderCell(event: IFieldCustomizerCellEventParameters): void;", - "accessModifier": "public", - "isOptional": false, - "isStatic": false, - "returnValue": { - "type": "void", - "description": [] - }, - "parameters": { - "event": { - "name": "event", - "description": [], - "isOptional": false, - "isSpread": false, - "type": "IFieldCustomizerCellEventParameters" - } - }, - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": 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, - "members": { - "context": { - "kind": "property", - "signature": "public 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 - }, - "onExecute": { - "kind": "method", - "signature": "@virtual public onExecute(event: IListViewCommandSetExecuteEventParameters): void;", - "accessModifier": "public", - "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 - }, - "onListViewUpdated": { - "kind": "method", - "signature": "@virtual public onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;", - "accessModifier": "public", - "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 - }, - "tryGetCommand": { - "kind": "method", - "signature": "public tryGetCommand(id: string): Command;", - "accessModifier": "public", - "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 - } - } - }, - "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, - "members": { - "field": { - "kind": "property", - "signature": "public 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 - }, - "visible": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "members": { - "ariaLabel": { - "kind": "property", - "signature": "public 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 - }, - "iconImageUrl": { - "kind": "property", - "signature": "public 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 - }, - "id": { - "kind": "property", - "signature": "public id: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Id of the command." - } - ], - "remarks": [], - "isBeta": false - }, - "title": { - "kind": "property", - "signature": "public 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 - }, - "visible": { - "kind": "property", - "signature": "public visible: boolean;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "True if the command is visible." - } - ], - "remarks": [], - "isBeta": 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, - "members": { - "field": { - "kind": "property", - "signature": "public 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 - }, - "tryGetListView": { - "kind": "method", - "signature": "public tryGetListView(): ListViewAccessor | undefined;", - "accessModifier": "public", - "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 - } - } - }, - "IFieldCustomizerCellEventParameters": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Event parameters for BaseFieldCustomizer.onRenderCell()" - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "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, - "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 - }, - "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 - } - } - }, - "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, - "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 - } - } - }, - "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, - "members": { - "fields": { - "kind": "property", - "signature": "public 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 - }, - "getValue": { - "kind": "method", - "signature": "public abstract getValue(field: SPField): any;", - "accessModifier": "public", - "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 - }, - "getValueByName": { - "kind": "method", - "signature": "public abstract getValueByName(internalName: string): any;", - "accessModifier": "public", - "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 - } - } - }, - "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, - "members": { - "columns": { - "kind": "property", - "signature": "public 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 - }, - "selectedRowsChangedEvent": { - "kind": "property", - "signature": "public readonly selectedRowsChangedEvent: Event;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "Event", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Event that gets raised every time the selected items in the list view change." - } - ], - "remarks": [], - "isBeta": false - }, - "tryGetColumnByName": { - "kind": "method", - "signature": "public abstract tryGetColumnByName(internalName: string): ColumnAccessor | undefined;", - "accessModifier": "public", - "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 - } - } - }, - "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, - "members": { - "listView": { - "kind": "property", - "signature": "public 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 - }, - "manifest": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "members": {} - }, - "SelectedRowsChangedEventArgs": { - "kind": "class", - "extends": "EventArgs", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Arguments for the selected rows changed event." - } - ], - "remarks": [], - "isBeta": false, - "members": { - "selectedRows": { - "kind": "property", - "signature": "public 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 - } - } - } - } -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "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", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-listview-extensibility!", + "name": "", + "members": [ + { + "kind": "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 BaseFieldCustomizer extends " + }, + { + "kind": "Reference", + "text": "BaseExtension", + "canonicalReference": "@microsoft/sp-extension-base!BaseExtension:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "BaseFieldCustomizer", + "members": [ + { + "kind": "Property", + "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 context: " + }, + { + "kind": "Reference", + "text": "FieldCustomizerContext", + "canonicalReference": "@microsoft/sp-listview-extensibility!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onDisposeCell:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "onDisposeCell(event: " + }, + { + "kind": "Reference", + "text": "IFieldCustomizerCellEventParameters", + "canonicalReference": "@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "event", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "onDisposeCell" + }, + { + "kind": "Method", + "canonicalReference": "@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onRenderCell:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "onRenderCell(event: " + }, + { + "kind": "Reference", + "text": "IFieldCustomizerCellEventParameters", + "canonicalReference": "@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "event", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "onRenderCell" + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "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 BaseListViewCommandSet extends " + }, + { + "kind": "Reference", + "text": "BaseExtension", + "canonicalReference": "@microsoft/sp-extension-base!BaseExtension:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "BaseListViewCommandSet", + "members": [ + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-listview-extensibility!BaseListViewCommandSet#context:member", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-extension-base#BaseExtension.context}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly context: " + }, + { + "kind": "Reference", + "text": "ListViewCommandSetContext", + "canonicalReference": "@microsoft/sp-listview-extensibility!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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": "Content", + "text": "onExecute(event: " + }, + { + "kind": "Reference", + "text": "IListViewCommandSetExecuteEventParameters", + "canonicalReference": "@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "event", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "onExecute" + }, + { + "kind": "Method", + "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": "Content", + "text": "onListViewUpdated(event: " + }, + { + "kind": "Reference", + "text": "IListViewCommandSetListViewUpdatedParameters", + "canonicalReference": "@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "event", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "onListViewUpdated" + }, + { + "kind": "Method", + "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": "Content", + "text": "tryGetCommand(id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Command", + "canonicalReference": "@microsoft/sp-listview-extensibility!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "id", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "tryGetCommand" + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "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 ColumnAccessor " + } + ], + "releaseTag": "Public", + "name": "ColumnAccessor", + "members": [ + { + "kind": "Property", + "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 field: " + }, + { + "kind": "Reference", + "text": "SPField", + "canonicalReference": "@microsoft/sp-page-context!SPField:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "field", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 visible: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "visible", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 Command " + } + ], + "releaseTag": "Public", + "name": "Command", + "members": [ + { + "kind": "Property", + "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": "Content", + "text": "ariaLabel: " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ariaLabel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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": "Content", + "text": "iconImageUrl: " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "iconImageUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-listview-extensibility!Command#id:member", + "docComment": "/**\n * Id of the command.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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": "Content", + "text": "title: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-listview-extensibility!Command#visible:member", + "docComment": "/**\n * True if the command is visible.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "visible: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "visible", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 FieldCustomizerContext extends " + }, + { + "kind": "Reference", + "text": "ExtensionContext", + "canonicalReference": "@microsoft/sp-extension-base!ExtensionContext:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "FieldCustomizerContext", + "members": [ + { + "kind": "Property", + "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 field: " + }, + { + "kind": "Reference", + "text": "SPField", + "canonicalReference": "@microsoft/sp-page-context!SPField:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "field", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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": "Content", + "text": "tryGetListView(): " + }, + { + "kind": "Reference", + "text": "ListViewAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!~ListViewAccessor:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "tryGetListView" + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "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 IFieldCustomizerCellEventParameters " + } + ], + "releaseTag": "Public", + "name": "IFieldCustomizerCellEventParameters", + "members": [ + { + "kind": "PropertySignature", + "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 domElement: " + }, + { + "kind": "Reference", + "text": "HTMLDivElement", + "canonicalReference": "!HTMLDivElement:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "domElement", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#fieldValue:member", + "docComment": "/**\n * The value of the field being rendered.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly fieldValue: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "fieldValue", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#listItem:member", + "docComment": "/**\n * The list item being edited.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly listItem: " + }, + { + "kind": "Reference", + "text": "ListItemAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listItem", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "userData: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "userData", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IListViewCommandSetExecuteEventParameters " + } + ], + "releaseTag": "Public", + "name": "IListViewCommandSetExecuteEventParameters", + "members": [ + { + "kind": "PropertySignature", + "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 itemId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "itemId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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 selectedRows: " + }, + { + "kind": "Reference", + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "RowAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!RowAccessor:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "selectedRows", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IListViewCommandSetListViewUpdatedParameters " + } + ], + "releaseTag": "Public", + "name": "IListViewCommandSetListViewUpdatedParameters", + "members": [ + { + "kind": "PropertySignature", + "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 selectedRows: " + }, + { + "kind": "Reference", + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "RowAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!RowAccessor:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "selectedRows", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 ListItemAccessor " + } + ], + "releaseTag": "Public", + "name": "ListItemAccessor", + "members": [ + { + "kind": "Property", + "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 fields: " + }, + { + "kind": "Reference", + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SPField", + "canonicalReference": "@microsoft/sp-page-context!SPField:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "fields", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": false + }, + { + "kind": "Method", + "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 getValue(field: " + }, + { + "kind": "Reference", + "text": "SPField", + "canonicalReference": "@microsoft/sp-page-context!SPField:class" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "field", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getValue" + }, + { + "kind": "Method", + "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 getValueByName(internalName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "internalName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getValueByName" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 ListViewAccessor " + } + ], + "releaseTag": "Public", + "name": "ListViewAccessor", + "members": [ + { + "kind": "Property", + "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 columns: " + }, + { + "kind": "Reference", + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ColumnAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!ColumnAccessor:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "columns", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 selectedRowsChangedEvent: " + }, + { + "kind": "Reference", + "text": "SPEvent", + "canonicalReference": "@microsoft/sp-core-library!SPEvent:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "SelectedRowsChangedEventArgs", + "canonicalReference": "@microsoft/sp-listview-extensibility!SelectedRowsChangedEventArgs:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "selectedRowsChangedEvent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": false + }, + { + "kind": "Method", + "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 tryGetColumnByName(internalName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ColumnAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!ColumnAccessor:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "internalName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "tryGetColumnByName" + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 ListViewCommandSetContext extends " + }, + { + "kind": "Reference", + "text": "ExtensionContext", + "canonicalReference": "@microsoft/sp-extension-base!ExtensionContext:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "ListViewCommandSetContext", + "members": [ + { + "kind": "Property", + "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 listView: " + }, + { + "kind": "Reference", + "text": "ListViewAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!~ListViewAccessor:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listView", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-listview-extensibility!ListViewCommandSetContext#manifest:member", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponentContext.manifest}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly manifest: " + }, + { + "kind": "Reference", + "text": "ICommandSetExtensionManifest", + "canonicalReference": "@microsoft/sp-module-interfaces!ICommandSetExtensionManifest:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manifest", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "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 RowAccessor extends " + }, + { + "kind": "Reference", + "text": "ListItemAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!default:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "RowAccessor", + "members": [], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "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 SelectedRowsChangedEventArgs extends " + }, + { + "kind": "Reference", + "text": "SPEventArgs", + "canonicalReference": "@microsoft/sp-core-library!SPEventArgs:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "SelectedRowsChangedEventArgs", + "members": [ + { + "kind": "Property", + "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": "Content", + "text": "selectedRows: " + }, + { + "kind": "Reference", + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "RowAccessor", + "canonicalReference": "@microsoft/sp-listview-extensibility!RowAccessor:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "selectedRows", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "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..5dcd2932 --- /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 * 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", + "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 * 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", + "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 * Inserts a `` tag for a stylesheet.\n *\n * @param url - The CSS file URL.\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 * 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", + "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 14476774..f4300af2 100644 --- a/generate-docs/json/sp-odata-types.api.json +++ b/generate-docs/json/sp-odata-types.api.json @@ -1,1596 +1,2166 @@ -{ - "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, - "members": { - "High": { - "kind": "property", - "signature": "High: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": false - }, - "Low": { - "kind": "property", - "signature": "Low: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": 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, - "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 - } - } - }, - "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, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "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, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "EntityTypeName": { - "kind": "property", - "signature": "EntityTypeName: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"MyListTitleList\"" - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "Title": { - "kind": "property", - "signature": "Title: string;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "string", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: \"Pages\"" - } - ], - "remarks": [], - "isBeta": 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, - "members": { - "ContentTypeId": { - "kind": "property", - "signature": "ContentTypeId:", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "{ StringValue: string }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Example: { StringValue: \"0x010100C5...\" }" - } - ], - "remarks": [], - "isBeta": false - }, - "ID": { - "kind": "property", - "signature": "ID: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": 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 - }, - "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 - } - } - }, - "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, - "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 - }, - "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 - }, - "IsDocLib": { - "kind": "property", - "signature": "IsDocLib?: boolean;", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "boolean", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "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, - "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 - }, - "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 - } - } - }, - "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, - "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 - }, - "Id": { - "kind": "property", - "signature": "Id: number;", - "isOptional": false, - "isReadOnly": false, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "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, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "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, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - } - } - } - } -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "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", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-odata-types!", + "name": "", + "members": [ + { + "kind": "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 IODataUserId " + } + ], + "releaseTag": "Public", + "name": "_IODataUserId", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!_IODataUserId#NameId:member", + "docComment": "/**\n * Example: `\"s-1-5-21-2127521184-1604012920-1887927527-2632426\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "NameId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "NameId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!_IODataUserId#NameIdIssuer:member", + "docComment": "/**\n * Example: `\"urn:office:idp:activedirectory\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "NameIdIssuer: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "NameIdIssuer", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IODataBasePermission " + } + ], + "releaseTag": "Public", + "name": "IODataBasePermission", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataBasePermission#High:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "High: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "High", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataBasePermission#Low:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Low: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Low", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IODataChangeToken " + } + ], + "releaseTag": "Public", + "name": "IODataChangeToken", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "StringValue: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "StringValue", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IODataContextWebInformation " + } + ], + "releaseTag": "Public", + "name": "IODataContextWebInformation", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataContextWebInformation#LibraryVersion:member", + "docComment": "/**\n * Example: `\"16.0.4919.3000\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "LibraryVersion: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "LibraryVersion", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataContextWebInformation#SiteFullUrl:member", + "docComment": "/**\n * Example: `\"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "SiteFullUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "SiteFullUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataContextWebInformation#SupportedSchemaVersions:member", + "docComment": "/**\n * Example: `[ \"14.0.0.0\", \"15.0.0.0\" ]`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "SupportedSchemaVersions: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "SupportedSchemaVersions", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataContextWebInformation#WebFullUrl:member", + "docComment": "/**\n * Example: `\"http:\\u002f\\u002fexample.com\\u002fsites\\u002fPubSite\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "WebFullUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "WebFullUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IODataList " + } + ], + "releaseTag": "Public", + "name": "IODataList", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#BaseTemplate:member", + "docComment": "/**\n * The list definition type on which the list is based.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "BaseTemplate: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "BaseTemplate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#Created:member", + "docComment": "/**\n * Example: `\"/Date(1453294804000)/\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Created: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Created", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "CurrentChangeToken: " + }, + { + "kind": "Reference", + "text": "IODataChangeToken", + "canonicalReference": "@microsoft/sp-odata-types!IODataChangeToken:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CurrentChangeToken", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#Description:member", + "docComment": "/**\n * A description of the List.\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-odata-types!IODataList#EntityTypeName:member", + "docComment": "/**\n * Example: `\"MyListTitleList\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "EntityTypeName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "EntityTypeName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "Hidden: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Hidden", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#Id:member", + "docComment": "/**\n * Example: `\"/Guid(9fb9199b-65f2-4a4a-b597-11d1a44422c1)/\"`\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-odata-types!IODataList#LastItemDeletedDate:member", + "docComment": "/**\n * Example: `\"/Date(1453294809000)/\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "LastItemDeletedDate: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "LastItemDeletedDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#LastItemModifiedDate:member", + "docComment": "/**\n * Example: `\"/Date(1453294809000)/\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "LastItemModifiedDate: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "LastItemModifiedDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#ListItemEntityTypeFullName:member", + "docComment": "/**\n * Example: `\"SP.Data.MyListTitleListItem\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ListItemEntityTypeFullName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ListItemEntityTypeFullName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#ParentWebUrl:member", + "docComment": "/**\n * Example: `\"/sites/PubSite\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ParentWebUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ParentWebUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#TemplateFeatureId:member", + "docComment": "/**\n * Example: `\"/Guid(22a9ef51-737b-4ff2-9346-694633fe4416)/\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "TemplateFeatureId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "TemplateFeatureId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataList#Title:member", + "docComment": "/**\n * Example: `\"Pages\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Title: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Title", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IODataListItem " + } + ], + "releaseTag": "Public", + "name": "IODataListItem", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataListItem#ContentTypeId:member", + "docComment": "/**\n * Example: `{ StringValue: \"0x010100C5...\" }`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ContentTypeId: " + }, + { + "kind": "Content", + "text": "{\n StringValue: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ContentTypeId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataListItem#ID:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ID: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ID", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataListItem#Title:member", + "docComment": "/**\n * Title of the List Item\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-odata-types!IODataListItem#UniqueId:member", + "docComment": "/**\n * Example: `\"/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "UniqueId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "UniqueId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IODataNavigationNode " + } + ], + "releaseTag": "Public", + "name": "IODataNavigationNode", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "Children?: " + }, + { + "kind": "Reference", + "text": "IODataNavigationNode", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNode:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Children", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "Id?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNode#IsDocLib:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "IsDocLib?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "IsDocLib", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "IsExternal?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "IsExternal", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "IsVisible?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "IsVisible", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "Title?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Title", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "Url?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Url", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IODataNavigationNodeCollection " + } + ], + "releaseTag": "Public", + "name": "IODataNavigationNodeCollection", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "quickLaunch: " + }, + { + "kind": "Reference", + "text": "IODataNavigationNode", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNode:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "quickLaunch", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "topNav: " + }, + { + "kind": "Reference", + "text": "IODataNavigationNode", + "canonicalReference": "@microsoft/sp-odata-types!IODataNavigationNode:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "topNav", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IODataUser " + } + ], + "releaseTag": "Public", + "name": "IODataUser", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataUser#Email:member", + "docComment": "/**\n * Example: `\"someone@example.com\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "Email: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Email", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataUser#Id:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Id: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "IsSiteAdmin: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "IsSiteAdmin", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataUser#LoginName:member", + "docComment": "/**\n * Example: `\"i:0#.w|domain\\user\"`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "LoginName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "LoginName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "PrincipalType: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "PrincipalType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataUser#Title:member", + "docComment": "/**\n * Example: `\"DOMAIN\\user\"`\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-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": "Content", + "text": "UserId: " + }, + { + "kind": "Reference", + "text": "IODataUserId", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserId:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "UserId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IODataUserCustomAction " + } + ], + "releaseTag": "Public", + "name": "IODataUserCustomAction", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "ClientSideComponentId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ClientSideComponentId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "ClientSideComponentProperties: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ClientSideComponentProperties", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "CommandUIExtension: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CommandUIExtension", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#Description:member", + "docComment": "/**\n * Gets or sets the description of the custom action.\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-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": "Content", + "text": "Group: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Group", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "Id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "ImageUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ImageUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "Location: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Location", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "RegistrationId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "RegistrationId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "RegistrationType: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "RegistrationType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "Rights: " + }, + { + "kind": "Reference", + "text": "IODataBasePermission", + "canonicalReference": "@microsoft/sp-odata-types!IODataBasePermission:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Rights", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "Scope: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Scope", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "ScriptBlock: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ScriptBlock", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "ScriptSrc: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ScriptSrc", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "Sequence: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Sequence", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataUserCustomAction#Title:member", + "docComment": "/**\n * Gets or sets the display title of the custom action.\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-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": "Content", + "text": "Url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Url", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "VersionOfUserCustomAction: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "VersionOfUserCustomAction", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IODataWeb " + } + ], + "releaseTag": "Public", + "name": "IODataWeb", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "Created?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Created", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "CurrentChangeToken?: " + }, + { + "kind": "Reference", + "text": "IODataChangeToken", + "canonicalReference": "@microsoft/sp-odata-types!IODataChangeToken:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CurrentChangeToken", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "CustomMasterUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CustomMasterUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#Description:member", + "docComment": "/**\n * Gets or sets the description for the site.\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-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": "Content", + "text": "Id?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#IsMultilingual:member", + "docComment": "/**\n * Value that represents if the web was\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "IsMultilingual?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "IsMultilingual", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "Language?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Language", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "LastItemModifiedDate?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "LastItemModifiedDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "MasterUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "MasterUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "NoCrawl?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "NoCrawl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "QuickLaunchEnabled?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "QuickLaunchEnabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "RecycleBinEnabled?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "RecycleBinEnabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "ServerRelativeUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "ServerRelativeUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#SiteLogoUrl:member", + "docComment": "/**\n * Gets the url for the logo of this particular site.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "SiteLogoUrl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "SiteLogoUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-odata-types!IODataWeb#Title:member", + "docComment": "/**\n * The title of the web.\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-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": "Content", + "text": "UIVersion?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "UIVersion", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "Url?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Url", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "WebTemplate?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "WebTemplate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + } + ] + } + ] +} diff --git a/generate-docs/json/sp-page-context.api.json b/generate-docs/json/sp-page-context.api.json index e4614196..590d8a7e 100644 --- a/generate-docs/json/sp-page-context.api.json +++ b/generate-docs/json/sp-page-context.api.json @@ -1,2013 +1,3692 @@ -{ - "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, - "members": { - "currentCultureName": { - "kind": "property", - "signature": "public 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 - }, - "currentUICultureName": { - "kind": "property", - "signature": "public 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 - }, - "isRightToLeft": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "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": [] - }, - "cultureInfo": { - "kind": "property", - "signature": "public 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 - }, - "isInitialized": { - "kind": "property", - "signature": "public 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 - }, - "legacyPageContext": { - "kind": "property", - "signature": "public 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 - }, - "list": { - "kind": "property", - "signature": "public 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 - }, - "listItem": { - "kind": "property", - "signature": "public 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 - }, - "serviceKey": { - "kind": "property", - "signature": "public 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 - }, - "site": { - "kind": "property", - "signature": "public 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 - }, - "user": { - "kind": "property", - "signature": "public 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 - }, - "web": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "members": { - "clientSideComponentId": { - "kind": "property", - "signature": "public 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 - }, - "clientSideComponentProperties": { - "kind": "property", - "signature": "public 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 - }, - "displayName": { - "kind": "property", - "signature": "public 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 - }, - "fieldType": { - "kind": "property", - "signature": "public 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 - }, - "id": { - "kind": "property", - "signature": "public 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 - }, - "internalName": { - "kind": "property", - "signature": "public 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 - }, - "isRequired": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "members": { - "id": { - "kind": "property", - "signature": "public 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 - }, - "permissions": { - "kind": "property", - "signature": "public 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 - }, - "serverRelativeUrl": { - "kind": "property", - "signature": "public 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 - }, - "title": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "members": { - "id": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "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": "public 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 - }, - "addDelPrivateWebParts": { - "kind": "property", - "signature": "public 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 - }, - "addListItems": { - "kind": "property", - "signature": "public 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 - }, - "applyStyleSheets": { - "kind": "property", - "signature": "public 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 - }, - "applyThemeAndBorder": { - "kind": "property", - "signature": "public 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 - }, - "approveItems": { - "kind": "property", - "signature": "public 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 - }, - "browseDirectories": { - "kind": "property", - "signature": "public 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 - }, - "browserUserInfo": { - "kind": "property", - "signature": "public 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 - }, - "cancelCheckout": { - "kind": "property", - "signature": "public 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 - }, - "createAlerts": { - "kind": "property", - "signature": "public static readonly createAlerts: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Create e-mail alerts." - } - ], - "remarks": [], - "isBeta": false - }, - "createGroups": { - "kind": "property", - "signature": "public 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 - }, - "createSSCSite": { - "kind": "property", - "signature": "public 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 - }, - "deleteListItems": { - "kind": "property", - "signature": "public 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 - }, - "deleteVersions": { - "kind": "property", - "signature": "public 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 - }, - "editListItems": { - "kind": "property", - "signature": "public 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 - }, - "editMyUserInfo": { - "kind": "property", - "signature": "public 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 - }, - "emptyMask": { - "kind": "property", - "signature": "public 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 - }, - "enumeratePermissions": { - "kind": "property", - "signature": "public 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 - }, - "fullMask": { - "kind": "property", - "signature": "public 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 - }, - "hasAllPermissions": { - "kind": "method", - "signature": "public hasAllPermissions(...requestedPerms: SPPermission[]): boolean;", - "accessModifier": "public", - "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 - }, - "hasAnyPermissions": { - "kind": "method", - "signature": "public hasAnyPermissions(...requestedPerms: SPPermission[]): boolean;", - "accessModifier": "public", - "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 - }, - "hasPermission": { - "kind": "method", - "signature": "public hasPermission(requestedPerm: SPPermission): boolean;", - "accessModifier": "public", - "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 - }, - "layoutsPage": { - "kind": "property", - "signature": "public static readonly layoutsPage: SPPermission;", - "isOptional": false, - "isReadOnly": true, - "isStatic": true, - "type": "SPPermission", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "View the layouts page?" - } - ], - "remarks": [], - "isBeta": false - }, - "manageAlerts": { - "kind": "property", - "signature": "public 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 - }, - "manageLists": { - "kind": "property", - "signature": "public 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 - }, - "managePermissions": { - "kind": "property", - "signature": "public 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 - }, - "managePersonalViews": { - "kind": "property", - "signature": "public 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 - }, - "manageSubwebs": { - "kind": "property", - "signature": "public 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 - }, - "manageWeb": { - "kind": "property", - "signature": "public 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 - }, - "open": { - "kind": "property", - "signature": "public 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 - }, - "openItems": { - "kind": "property", - "signature": "public 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 - }, - "updatePersonalWebParts": { - "kind": "property", - "signature": "public 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 - }, - "useClientIntegration": { - "kind": "property", - "signature": "public 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 - }, - "useRemoteAPIs": { - "kind": "property", - "signature": "public 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 - }, - "value": { - "kind": "property", - "signature": "public 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 - }, - "viewFormPages": { - "kind": "property", - "signature": "public 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 - }, - "viewListItems": { - "kind": "property", - "signature": "public 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 - }, - "viewPages": { - "kind": "property", - "signature": "public 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 - }, - "viewUsageData": { - "kind": "property", - "signature": "public 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 - }, - "viewVersions": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "members": { - "absoluteUrl": { - "kind": "property", - "signature": "public 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 - }, - "cdnPrefix": { - "kind": "property", - "signature": "public 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 - }, - "classification": { - "kind": "property", - "signature": "public 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 - }, - "correlationId": { - "kind": "property", - "signature": "public 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 - }, - "group": { - "kind": "property", - "signature": "public 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 - }, - "id": { - "kind": "property", - "signature": "public 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 - }, - "isNoScriptEnabled": { - "kind": "property", - "signature": "public 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 - }, - "recycleBinItemCount": { - "kind": "property", - "signature": "public readonly recycleBinItemCount: number;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "number", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The amount of items in the recyle bin." - } - ], - "remarks": [], - "isBeta": false - }, - "serverRelativeUrl": { - "kind": "property", - "signature": "public 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 - }, - "serverRequestPath": { - "kind": "property", - "signature": "public 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 - }, - "sitePagesEnabled": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "members": { - "displayName": { - "kind": "property", - "signature": "public 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 - }, - "email": { - "kind": "property", - "signature": "public 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 - }, - "isAnonymousGuestUser": { - "kind": "property", - "signature": "public 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 - }, - "isExternalGuestUser": { - "kind": "property", - "signature": "public 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 - }, - "loginName": { - "kind": "property", - "signature": "public 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: \"i:0#.w|domain\\user\"" - } - ], - "isBeta": false - }, - "preferUserTimeZone": { - "kind": "property", - "signature": "public 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 - } - } - }, - "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, - "members": { - "absoluteUrl": { - "kind": "property", - "signature": "public 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 - }, - "description": { - "kind": "property", - "signature": "public 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 - }, - "id": { - "kind": "property", - "signature": "public 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 - }, - "isAppWeb": { - "kind": "property", - "signature": "public 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 - }, - "language": { - "kind": "property", - "signature": "public 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 - }, - "logoUrl": { - "kind": "property", - "signature": "public 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 - }, - "permissions": { - "kind": "property", - "signature": "public 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 - }, - "serverRelativeUrl": { - "kind": "property", - "signature": "public 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 - }, - "templateName": { - "kind": "property", - "signature": "public 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 - }, - "title": { - "kind": "property", - "signature": "public 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 - } - } - } - } -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "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", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-page-context!", + "name": "", + "members": [ + { + "kind": "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 CultureInfo " + } + ], + "releaseTag": "Public", + "name": "CultureInfo", + "members": [ + { + "kind": "Property", + "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 currentCultureName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "currentCultureName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 currentUICultureName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "currentUICultureName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 isRightToLeft: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isRightToLeft", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 ISPSystemTime " + } + ], + "releaseTag": "Beta", + "name": "ISPSystemTime", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime#Day:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Day: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "Day", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime#DayOfWeek:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "DayOfWeek: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "DayOfWeek", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime#Hour:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Hour: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "Hour", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime#Milliseconds:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Milliseconds: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "Milliseconds", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime#Minute:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Minute: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "Minute", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime#Month:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Month: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "Month", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime#Second:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Second: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "Second", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime#Year:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Year: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "Year", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 ISPTimeZoneData " + } + ], + "releaseTag": "Beta", + "name": "ISPTimeZoneData", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-page-context!ISPTimeZoneData#daylightDate:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "daylightDate: " + }, + { + "kind": "Reference", + "text": "ISPSystemTime", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "daylightDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-page-context!ISPTimeZoneData#daylightOffset:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "daylightOffset: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "daylightOffset", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-page-context!ISPTimeZoneData#description:member", + "docComment": "", + "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-page-context!ISPTimeZoneData#id:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-page-context!ISPTimeZoneData#offset:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "offset: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "offset", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-page-context!ISPTimeZoneData#standardDate:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "standardDate: " + }, + { + "kind": "Reference", + "text": "ISPSystemTime", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "standardDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-page-context!ISPTimeZoneData#standardOffset:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "standardOffset: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "standardOffset", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 PageContext " + } + ], + "releaseTag": "Public", + "name": "PageContext", + "members": [ + { + "kind": "Constructor", + "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(serviceScope: " + }, + { + "kind": "Reference", + "text": "ServiceScope", + "canonicalReference": "@microsoft/sp-core-library!ServiceScope:class" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "serviceScope", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Property", + "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 aadInfo: " + }, + { + "kind": "Reference", + "text": "AzureActiveDirectoryInfo", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "aadInfo", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 cultureInfo: " + }, + { + "kind": "Reference", + "text": "CultureInfo", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "cultureInfo", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-page-context!PageContext#isInitialized:member", + "docComment": "/**\n * Returns whether the `PageContext` has been initialized.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly isInitialized: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isInitialized", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 legacyPageContext: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "legacyPageContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 list: " + }, + { + "kind": "Reference", + "text": "SPList", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "list", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 listItem: " + }, + { + "kind": "Reference", + "text": "SPListItem", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "listItem", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-page-context!PageContext.serviceKey:member", + "docComment": "/**\n * The service key for PageContext.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly serviceKey: " + }, + { + "kind": "Reference", + "text": "ServiceKey", + "canonicalReference": "@microsoft/sp-core-library!ServiceKey:class" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "PageContext", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serviceKey", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 site: " + }, + { + "kind": "Reference", + "text": "SPSite", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "site", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 user: " + }, + { + "kind": "Reference", + "text": "SPUser", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "user", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 web: " + }, + { + "kind": "Reference", + "text": "SPWeb", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "web", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 SPDayOfWeek " + } + ], + "releaseTag": "Beta", + "name": "SPDayOfWeek", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek.Friday:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Friday = " + }, + { + "kind": "Content", + "text": "5" + } + ], + "releaseTag": "Beta", + "name": "Friday", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek.Monday:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Monday = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Beta", + "name": "Monday", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek.Saturday:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Saturday = " + }, + { + "kind": "Content", + "text": "6" + } + ], + "releaseTag": "Beta", + "name": "Saturday", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek.Sunday:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Sunday = " + }, + { + "kind": "Content", + "text": "0" + } + ], + "releaseTag": "Beta", + "name": "Sunday", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek.Thursday:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Thursday = " + }, + { + "kind": "Content", + "text": "4" + } + ], + "releaseTag": "Beta", + "name": "Thursday", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek.Tuesday:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Tuesday = " + }, + { + "kind": "Content", + "text": "2" + } + ], + "releaseTag": "Beta", + "name": "Tuesday", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek.Wednesday:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "Wednesday = " + }, + { + "kind": "Content", + "text": "3" + } + ], + "releaseTag": "Beta", + "name": "Wednesday", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "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 SPField " + } + ], + "releaseTag": "Public", + "name": "SPField", + "members": [ + { + "kind": "Property", + "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 clientSideComponentId: " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "clientSideComponentId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 clientSideComponentProperties: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "clientSideComponentProperties", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 displayName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "displayName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 fieldType: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "fieldType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-page-context!SPField#id:member", + "docComment": "/**\n * The GUID identifier for this field.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly id: " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 internalName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "internalName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 isRequired: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isRequired", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 SPList " + } + ], + "releaseTag": "Public", + "name": "SPList", + "members": [ + { + "kind": "Property", + "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 id: " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 permissions: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "permissions", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 serverRelativeUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serverRelativeUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-page-context!SPList#title:member", + "docComment": "/**\n * Returns the title for this `SPList`.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly title: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 SPListItem " + } + ], + "releaseTag": "Public", + "name": "SPListItem", + "members": [ + { + "kind": "Property", + "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 id: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 SPPermission " + } + ], + "releaseTag": "Public", + "name": "SPPermission", + "members": [ + { + "kind": "Constructor", + "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(value: " + }, + { + "kind": "Reference", + "text": "IODataBasePermission", + "canonicalReference": "@microsoft/sp-odata-types!IODataBasePermission:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Property", + "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 addAndCustomizePages: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "addAndCustomizePages", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 addDelPrivateWebParts: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "addDelPrivateWebParts", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 addListItems: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "addListItems", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 applyStyleSheets: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "applyStyleSheets", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 applyThemeAndBorder: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "applyThemeAndBorder", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 approveItems: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "approveItems", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 browseDirectories: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "browseDirectories", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 browserUserInfo: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "browserUserInfo", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 cancelCheckout: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "cancelCheckout", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.createAlerts:member", + "docComment": "/**\n * Create e-mail alerts.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly createAlerts: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "createAlerts", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 createGroups: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "createGroups", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 createSSCSite: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "createSSCSite", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 deleteListItems: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "deleteListItems", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 deleteVersions: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "deleteVersions", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 editListItems: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "editListItems", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 editMyUserInfo: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "editMyUserInfo", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 emptyMask: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "emptyMask", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 enumeratePermissions: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "enumeratePermissions", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 fullMask: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "fullMask", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Method", + "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": "Content", + "text": "hasAllPermissions(...requestedPerms: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "requestedPerms", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "name": "hasAllPermissions" + }, + { + "kind": "Method", + "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": "Content", + "text": "hasAnyPermissions(...requestedPerms: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "requestedPerms", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "name": "hasAnyPermissions" + }, + { + "kind": "Method", + "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": "Content", + "text": "hasPermission(requestedPerm: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "requestedPerm", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "hasPermission" + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.layoutsPage:member", + "docComment": "/**\n * View the layouts page?\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly layoutsPage: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "layoutsPage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 manageAlerts: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manageAlerts", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 manageLists: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manageLists", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 managePermissions: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "managePermissions", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 managePersonalViews: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "managePersonalViews", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 manageSubwebs: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manageSubwebs", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 manageWeb: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manageWeb", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 open: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "open", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 openItems: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "openItems", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 updatePersonalWebParts: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "updatePersonalWebParts", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 useClientIntegration: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "useClientIntegration", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 useRemoteAPIs: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "useRemoteAPIs", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-page-context!SPPermission#value:member", + "docComment": "/**\n * Returns the value of this SPPermission object\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly value: " + }, + { + "kind": "Reference", + "text": "IODataBasePermission", + "canonicalReference": "@microsoft/sp-odata-types!IODataBasePermission:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "value", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 viewFormPages: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "viewFormPages", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 viewListItems: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "viewListItems", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.viewPages:member", + "docComment": "/**\n * View pages in a Web site.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly viewPages: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "viewPages", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-page-context!SPPermission.viewUsageData:member", + "docComment": "/**\n * View reports on Web site usage.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "static readonly viewUsageData: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "viewUsageData", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + }, + { + "kind": "Property", + "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 viewVersions: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "viewVersions", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": true + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 SPSite " + } + ], + "releaseTag": "Public", + "name": "SPSite", + "members": [ + { + "kind": "Property", + "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 absoluteUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "absoluteUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 cdnPrefix: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "cdnPrefix", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-page-context!SPSite#classification:member", + "docComment": "/**\n * Returns the classification of the site.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly classification: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "classification", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 correlationId: " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "correlationId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 group: " + }, + { + "kind": "Reference", + "text": "O365GroupAssociation", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "group", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 id: " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 isNoScriptEnabled: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isNoScriptEnabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 recycleBinItemCount: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "recycleBinItemCount", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 serverRelativeUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serverRelativeUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 serverRequestPath: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serverRequestPath", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 sitePagesEnabled: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "sitePagesEnabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 SPTimeZone " + } + ], + "releaseTag": "Beta", + "name": "SPTimeZone", + "members": [ + { + "kind": "Property", + "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 daylightDate: " + }, + { + "kind": "Reference", + "text": "ISPSystemTime", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "daylightDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 daylightOffset: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "daylightOffset", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-page-context!SPTimeZone#description:member", + "docComment": "/**\n * Gets the description for the time zone.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly description: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-page-context!SPTimeZone#id:member", + "docComment": "/**\n * Gets the ID of the time zone.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly id: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 offset: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "offset", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 standardDate: " + }, + { + "kind": "Reference", + "text": "ISPSystemTime", + "canonicalReference": "@microsoft/sp-page-context!ISPSystemTime:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "standardDate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 standardOffset: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "standardOffset", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 SPUser " + } + ], + "releaseTag": "Public", + "name": "SPUser", + "members": [ + { + "kind": "Property", + "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 displayName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "displayName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 email: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "email", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 firstDayOfWeek: " + }, + { + "kind": "Reference", + "text": "SPDayOfWeek", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek:enum" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "firstDayOfWeek", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 isAnonymousGuestUser: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isAnonymousGuestUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 isExternalGuestUser: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isExternalGuestUser", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 loginName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "loginName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 preferUserTimeZone: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "preferUserTimeZone", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 timeZoneInfo: " + }, + { + "kind": "Reference", + "text": "SPTimeZone", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "timeZoneInfo", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "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 SPWeb " + } + ], + "releaseTag": "Public", + "name": "SPWeb", + "members": [ + { + "kind": "Property", + "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 absoluteUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "absoluteUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-page-context!SPWeb#description:member", + "docComment": "/**\n * Returns the description of the current SPWeb.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly description: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 firstDayOfWeek: " + }, + { + "kind": "Reference", + "text": "SPDayOfWeek", + "canonicalReference": "@microsoft/sp-page-context!SPDayOfWeek:enum" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "firstDayOfWeek", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 id: " + }, + { + "kind": "Reference", + "text": "Guid", + "canonicalReference": "@microsoft/sp-core-library!Guid:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 isAppWeb: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isAppWeb", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 language: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "language", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 languageName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "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", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "logoUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 permissions: " + }, + { + "kind": "Reference", + "text": "SPPermission", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "permissions", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 serverRelativeUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serverRelativeUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 templateName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "templateName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 timeZoneInfo: " + }, + { + "kind": "Reference", + "text": "SPTimeZone", + "canonicalReference": "@microsoft/sp-page-context!default:class" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "timeZoneInfo", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-page-context!SPWeb#title:member", + "docComment": "/**\n * Returns the title of the current SPWeb.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly title: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "implementsTokenRanges": [] + } + ] + } + ] +} 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 a7ad252c..b9f23b16 100644 --- a/generate-docs/json/sp-webpart-base.api.json +++ b/generate-docs/json/sp-webpart-base.api.json @@ -1,5199 +1,5639 @@ -{ - "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, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "getPropertyPaneConfiguration": { - "kind": "method", - "signature": "@virtual 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": "See IPropertyPane and other PropertyPane integration wiki documentation for more details." - } - ], - "remarks": [], - "isBeta": 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 - }, - "onAfterDeserialize": { - "kind": "method", - "signature": "@virtual 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 - }, - "onAfterPropertyPaneChangesApplied": { - "kind": "method", - "signature": "@virtual 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 - }, - "onBeforeSerialize": { - "kind": "method", - "signature": "@virtual 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 - }, - "onDisplayModeChanged": { - "kind": "method", - "signature": "@virtual 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 - }, - "onDispose": { - "kind": "method", - "signature": "@virtual 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 - }, - "onInit": { - "kind": "method", - "signature": "@virtual 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 - }, - "onPropertyPaneConfigurationComplete": { - "kind": "method", - "signature": "@virtual 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 - }, - "onPropertyPaneConfigurationStart": { - "kind": "method", - "signature": "@virtual 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 - }, - "onPropertyPaneFieldChanged": { - "kind": "method", - "signature": "@virtual 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 - }, - "onPropertyPaneRendered": { - "kind": "method", - "signature": "@virtual 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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "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, - "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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "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, - "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 - }, - "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 - } - } - }, - "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, - "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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "IPropertyPaneButtonProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane button props." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "IPropertyPaneCheckboxProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane CheckBox component props." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - } - } - }, - "IPropertyPaneChoiceGroupOption": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane ChoiceGroup option props." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - }, - "imageSize": { - "kind": "property", - "signature": "imageSize?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{ width: number, height: number }", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "The width and height of the image in px for choice field." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "IPropertyPaneChoiceGroupOptionIconProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane ChoiceGroup icon props." - } - ], - "remarks": [], - "isBeta": 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 - } - } - }, - "IPropertyPaneChoiceGroupProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane ChoiceGroup props." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - } - } - }, - "IPropertyPaneConfiguration": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part configuration settings" - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "IPropertyPaneCustomFieldProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane CustomPropertyField props." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - }, - "onRender": { - "kind": "property", - "signature": "onRender: (\r\n domElement: HTMLElement,\r\n context?: any,\r\n 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", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "This API will be called once the custom field is mounted on the host element." - } - ], - "remarks": [], - "isBeta": false - } - } - }, - "IPropertyPaneDropdownOption": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane drop down options." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "IPropertyPaneDropdownProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane drop down component props." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "IPropertyPaneField": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [ - "TProperties" - ], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane field." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "IPropertyPaneGroup": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane group. Group is part of the PropertyPanePage." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - } - } - }, - "IPropertyPaneLabelProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPaneLabel component props." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - } - } - }, - "IPropertyPaneLinkProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPaneLink component props." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "IPropertyPanePage": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPanePage interface." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - } - } - }, - "IPropertyPanePageHeader": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPane header. This header remains same for all the pages." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - } - } - }, - "IPropertyPaneSliderProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPaneSliderProps component props." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "IPropertyPaneTextFieldProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPaneTextField component props." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "IPropertyPaneToggleProps": { - "kind": "interface", - "extends": "", - "implements": "", - "typeParameters": [], - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "PropertyPaneToggle component props." - } - ], - "remarks": [], - "isBeta": 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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "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, - "members": { - "htmlStrings": { - "kind": "property", - "signature": "htmlStrings?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{ [key: string]: string }", - "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 - }, - "imageSources": { - "kind": "property", - "signature": "imageSources?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{ [key: string]: string }", - "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 - }, - "links": { - "kind": "property", - "signature": "links?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{ [key: string]: string }", - "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 - }, - "searchablePlainTexts": { - "kind": "property", - "signature": "searchablePlainTexts?:", - "isOptional": true, - "isReadOnly": false, - "isStatic": false, - "type": "{ [key: string]: string }", - "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 - } - } - }, - "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, - "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 - }, - "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 - }, - "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 - } - } - }, - "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, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "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, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "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, - "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 - } - } - }, - "PropertyPaneButton": { - "kind": "function", - "signature": "export function PropertyPaneButton(targetProperty: string,\r\n 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": "", - "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": "", - "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": "", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Hero button." - } - ], - "remarks": [], - "isBeta": false - }, - "Icon": { - "kind": "enum value", - "value": "", - "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": "", - "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": "", - "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,\r\n 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,\r\n 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,\r\n 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 - }, - "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 - }, - "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,\r\n 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,\r\n 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,\r\n 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,\r\n 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,\r\n 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, - "members": { - "domElement": { - "kind": "property", - "signature": "public 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 - }, - "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 - }, - "manifest": { - "kind": "property", - "signature": "public 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 - }, - "propertyPane": { - "kind": "property", - "signature": "public 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 - }, - "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 - }, - "statusRenderer": { - "kind": "property", - "signature": "public readonly statusRenderer: IClientSideWebPartStatusRenderer;", - "isOptional": false, - "isReadOnly": true, - "isStatic": false, - "type": "IClientSideWebPartStatusRenderer", - "deprecatedMessage": [], - "summary": [ - { - "kind": "text", - "text": "Web part status renderer." - } - ], - "remarks": [], - "isBeta": false - }, - "webPartTag": { - "kind": "property", - "signature": "public 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 - } - } - } - } -} +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.5.0", + "schemaVersion": 1003, + "oldestForwardsCompatibleVersion": 1001 + }, + "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", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@microsoft/sp-webpart-base!", + "name": "", + "members": [ + { + "kind": "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 BaseClientSideWebPart extends " + }, + { + "kind": "Reference", + "text": "BaseWebPart", + "canonicalReference": "@microsoft/sp-webpart-base!default:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "BaseClientSideWebPart", + "members": [ + { + "kind": "Constructor", + "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": [ + { + "kind": "Content", + "text": "constructor();" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [] + }, + { + "kind": "Property", + "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 canOpenPopupOnRender: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "canOpenPopupOnRender", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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 clearError(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "clearError" + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-webpart-base!BaseClientSideWebPart#context:member", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponent.context}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly context: " + }, + { + "kind": "Reference", + "text": "WebPartContext", + "canonicalReference": "@microsoft/sp-webpart-base!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 domElement: " + }, + { + "kind": "Reference", + "text": "HTMLElement", + "canonicalReference": "!HTMLElement:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "domElement", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 isRenderAsync: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isRenderAsync", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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 onDisplayModeChanged(oldDisplayMode: " + }, + { + "kind": "Reference", + "text": "DisplayMode", + "canonicalReference": "@microsoft/sp-core-library!DisplayMode:enum" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "oldDisplayMode", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "onDisplayModeChanged" + }, + { + "kind": "Method", + "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 onDispose(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "onDispose" + }, + { + "kind": "Method", + "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 render(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "render" + }, + { + "kind": "Method", + "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 renderCompleted(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "renderCompleted" + }, + { + "kind": "Property", + "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 renderedFromPersistedData: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "renderedFromPersistedData", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 renderedOnce: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "renderedOnce", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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 renderError(error: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "renderError" + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "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 BaseWebPart extends " + }, + { + "kind": "Reference", + "text": "BaseComponent", + "canonicalReference": "@microsoft/sp-component-base!BaseComponent:class" + }, + { + "kind": "Content", + "text": " " + }, + { + "kind": "Content", + "text": "implements " + }, + { + "kind": "Reference", + "text": "IPropertyPaneConsumer", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConsumer:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "BaseWebPart", + "members": [ + { + "kind": "Constructor", + "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": [ + { + "kind": "Content", + "text": "constructor();" + } + ], + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [] + }, + { + "kind": "Property", + "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 accessibleTitle: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "accessibleTitle", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPart#context:member", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponent.context}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly context: " + }, + { + "kind": "Reference", + "text": "BaseWebPartContext", + "canonicalReference": "@microsoft/sp-webpart-base!default:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 dataVersion: " + }, + { + "kind": "Reference", + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!Version:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "dataVersion", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 description: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 disableReactivePropertyChanges: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "disableReactivePropertyChanges", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 displayMode: " + }, + { + "kind": "Reference", + "text": "DisplayMode", + "canonicalReference": "@microsoft/sp-core-library!DisplayMode:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "displayMode", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Method", + "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 getPropertyPaneConfiguration(): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneConfiguration", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneConfiguration:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getPropertyPaneConfiguration" + }, + { + "kind": "Method", + "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 onAfterDeserialize(deserializedObject: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", dataVersion: " + }, + { + "kind": "Reference", + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!Version:class" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "TProperties" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "deserializedObject", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "dataVersion", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "onAfterDeserialize" + }, + { + "kind": "Method", + "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 onAfterPropertyPaneChangesApplied(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "onAfterPropertyPaneChangesApplied" + }, + { + "kind": "Method", + "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 onBeforeSerialize(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "onBeforeSerialize" + }, + { + "kind": "Method", + "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 onDisplayModeChanged(oldDisplayMode: " + }, + { + "kind": "Reference", + "text": "DisplayMode", + "canonicalReference": "@microsoft/sp-core-library!DisplayMode:enum" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "oldDisplayMode", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "onDisplayModeChanged" + }, + { + "kind": "Method", + "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 onDispose(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "onDispose" + }, + { + "kind": "Method", + "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 onInit(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:class" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "onInit" + }, + { + "kind": "Method", + "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 onPropertyPaneConfigurationComplete(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "onPropertyPaneConfigurationComplete" + }, + { + "kind": "Method", + "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 onPropertyPaneConfigurationStart(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "onPropertyPaneConfigurationStart" + }, + { + "kind": "Method", + "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 onPropertyPaneFieldChanged(propertyPath: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", oldValue: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", newValue: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "propertyPath", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "oldValue", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "newValue", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "onPropertyPaneFieldChanged" + }, + { + "kind": "Method", + "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 onPropertyPaneRendered(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "onPropertyPaneRendered" + }, + { + "kind": "Property", + "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": "readonly previewImageUrl: " + }, + { + "kind": "Content", + "text": "string | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "previewImageUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 properties: " + }, + { + "kind": "Content", + "text": "TProperties" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "properties", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 propertiesMetadata: " + }, + { + "kind": "Reference", + "text": "IWebPartPropertiesMetadata", + "canonicalReference": "@microsoft/sp-webpart-base!~IWebPartPropertiesMetadata:interface" + }, + { + "kind": "Content", + "text": " | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "propertiesMetadata", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 title: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "implementsTokenRanges": [ + { + "startIndex": 6, + "endIndex": 8 + } + ] + }, + { + "kind": "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 BaseWebPartContext extends " + }, + { + "kind": "Reference", + "text": "BaseComponentContext", + "canonicalReference": "@microsoft/sp-component-base!BaseComponentContext:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "BaseWebPartContext", + "members": [ + { + "kind": "Property", + "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 formFactor: " + }, + { + "kind": "Reference", + "text": "WebPartFormFactor", + "canonicalReference": "@microsoft/sp-webpart-base!WebPartFormFactor:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "formFactor", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-webpart-base!BaseWebPartContext#manifest:member", + "docComment": "/**\n * {@inheritDoc @microsoft/sp-component-base#BaseComponentContext.manifest}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly manifest: " + }, + { + "kind": "Reference", + "text": "IClientSideWebPartManifestInstance", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manifest", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 propertyPane: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneAccessor", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "propertyPane", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 webPartTag: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "webPartTag", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "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 DynamicDataSharedDepth " + } + ], + "releaseTag": "Public", + "name": "DynamicDataSharedDepth", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-webpart-base!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-webpart-base!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-webpart-base!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-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 IClientSideWebPartStatusRenderer " + } + ], + "releaseTag": "Public", + "name": "IClientSideWebPartStatusRenderer", + "members": [ + { + "kind": "MethodSignature", + "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": "Content", + "text": "clearError(domElement: " + }, + { + "kind": "Reference", + "text": "HTMLElement", + "canonicalReference": "!HTMLElement:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "domElement", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "clearError" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "clearLoadingIndicator(domElement: " + }, + { + "kind": "Reference", + "text": "Element", + "canonicalReference": "!Element:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "domElement", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "clearLoadingIndicator" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "displayLoadingIndicator(domElement: " + }, + { + "kind": "Reference", + "text": "Element", + "canonicalReference": "!Element:interface" + }, + { + "kind": "Content", + "text": ", loadingMessage: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", timeout?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "domElement", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "loadingMessage", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "timeout", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "displayLoadingIndicator" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "renderError(domElement: " + }, + { + "kind": "Reference", + "text": "HTMLElement", + "canonicalReference": "!HTMLElement:interface" + }, + { + "kind": "Content", + "text": ", error: " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": " | string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "domElement", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "error", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + } + } + ], + "name": "renderError" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IDynamicDataSharedPropertyConfiguration extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedPropertyConfiguration", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedPropertyConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataSharedPropertyConfiguration", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IDynamicDataSharedPropertyFilters extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedPropertyFilters", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedPropertyFilters:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataSharedPropertyFilters", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IDynamicDataSharedSourceConfiguration extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedSourceConfiguration", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataSharedSourceConfiguration", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IDynamicDataSharedSourceFilters extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IDynamicDataSharedSourceFilters", + "canonicalReference": "@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IDynamicDataSharedSourceFilters", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IMicrosoftTeams " + } + ], + "releaseTag": "Public", + "name": "IMicrosoftTeams", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-webpart-base!IMicrosoftTeams#context:member", + "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", + "text": "context: " + }, + { + "kind": "Content", + "text": "microsoftTeams." + }, + { + "kind": "Reference", + "text": "Context", + "canonicalReference": "@microsoft/teams-js!Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member", + "docComment": "/**\n * Microsoft Teams SDK.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "teamsJs: " + }, + { + "kind": "Content", + "text": "typeof microsoftTeams" + }, + { + "kind": "Content", + "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": "Office.Context", + "canonicalReference": "!Office.Context:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "context", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IPropertyPaneAccessor " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneAccessor", + "members": [ + { + "kind": "MethodSignature", + "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": "Content", + "text": "close(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "close" + }, + { + "kind": "MethodSignature", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneAccessor#isPropertyPaneOpen:member(1)", + "docComment": "/**\n * Returns true if the PropertyPane is open.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isPropertyPaneOpen(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "isPropertyPaneOpen" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "isRenderedByWebPart(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "isRenderedByWebPart" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "open(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "open" + }, + { + "kind": "MethodSignature", + "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": "Content", + "text": "openDetails(context?: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "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" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IPropertyPaneButtonProps extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneButtonProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneButtonProps:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneButtonProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneCheckboxProps extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneCheckboxProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCheckboxProps:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneCheckboxProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneChoiceGroupOption extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupOption", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneChoiceGroupOption", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneChoiceGroupOptionIconProps extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupOptionIconProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOptionIconProps:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneChoiceGroupOptionIconProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneChoiceGroupProps extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneChoiceGroupProps:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneChoiceGroupProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneConditionalGroup extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneConditionalGroup", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConditionalGroup:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneConditionalGroup", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneConfiguration extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneConfiguration", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneConfiguration:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneConfiguration", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneCustomFieldProps extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneCustomFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneCustomFieldProps:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneCustomFieldProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneDropdownCalloutProps extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneDropdownCalloutProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownCalloutProps:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneDropdownCalloutProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneDropdownOption extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneDropdownOption", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownOption:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneDropdownOption", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneDropdownProps extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneDropdownProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDropdownProps:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneDropdownProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneDynamicFieldFilters extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldFilters", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldFilters:type" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneDynamicFieldFilters", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneDynamicFieldProps extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneDynamicFieldProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneDynamicFieldSetProps extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldSetProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneDynamicFieldSetProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneDynamicTextFieldProps extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicTextFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Beta", + "name": "IPropertyPaneDynamicTextFieldProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneField extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "typeParameters": [ + { + "typeParameterName": "TProperties", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "IPropertyPaneField", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneGroup extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneGroup", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneGroup:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneGroup", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneLabelProps extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneLabelProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLabelProps:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneLabelProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneLinkProps extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneLinkProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneLinkProps:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneLinkProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPanePage extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPanePage", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPanePage:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPanePage", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPanePageHeader extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPanePageHeader", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPanePageHeader:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPanePageHeader", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneSliderProps extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneSliderProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneSliderProps:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneSliderProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneTextFieldProps extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneTextFieldProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneTextFieldProps:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneTextFieldProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 IPropertyPaneToggleProps extends " + }, + { + "kind": "Content", + "text": "SPPropertyPane." + }, + { + "kind": "Reference", + "text": "IPropertyPaneToggleProps", + "canonicalReference": "@microsoft/sp-property-pane!IPropertyPaneToggleProps:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "IPropertyPaneToggleProps", + "members": [], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 4 + } + ] + }, + { + "kind": "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 ISDKs " + } + ], + "releaseTag": "Public", + "name": "ISDKs", + "members": [ + { + "kind": "PropertySignature", + "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": "IMicrosoftTeams", + "canonicalReference": "@microsoft/sp-webpart-base!IMicrosoftTeams:interface" + }, + { + "kind": "Content", + "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": "IOffice", + "canonicalReference": "@microsoft/sp-webpart-base!IOffice:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "office", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 ISerializedServerProcessedData " + } + ], + "releaseTag": "Public", + "name": "ISerializedServerProcessedData", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "htmlStrings?: " + }, + { + "kind": "Content", + "text": "{\n [key: string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "htmlStrings", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "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": "imageSources?: " + }, + { + "kind": "Content", + "text": "{\n [key: string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "imageSources", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "links?: " + }, + { + "kind": "Content", + "text": "{\n [key: string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "links", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "searchablePlainTexts?: " + }, + { + "kind": "Content", + "text": "{\n [key: string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "searchablePlainTexts", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 ISerializedWebPartData " + } + ], + "releaseTag": "Public", + "name": "ISerializedWebPartData", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "dataVersion: " + }, + { + "kind": "Reference", + "text": "Version", + "canonicalReference": "@microsoft/sp-core-library!Version:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "dataVersion", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "dynamicDataPaths?: " + }, + { + "kind": "Content", + "text": "{\n [path: string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "dynamicDataPaths", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "dynamicDataValues?: " + }, + { + "kind": "Content", + "text": "{\n [path: string]: any;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "dynamicDataValues", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "properties?: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "properties", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "serverProcessedContent?: " + }, + { + "kind": "Reference", + "text": "ISerializedServerProcessedData", + "canonicalReference": "@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serverProcessedContent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "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 IWebPartContext " + } + ], + "releaseTag": "Public", + "name": "IWebPartContext", + "members": [ + { + "kind": "PropertySignature", + "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 domElement: " + }, + { + "kind": "Reference", + "text": "HTMLElement", + "canonicalReference": "!HTMLElement:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "domElement", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartContext#httpClient:member", + "docComment": "/**\n * HttpClient instance scoped to this web part.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly httpClient: " + }, + { + "kind": "Reference", + "text": "HttpClient", + "canonicalReference": "@microsoft/sp-http!HttpClient:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "httpClient", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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 instanceId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "instanceId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartContext#manifest:member", + "docComment": "/**\n * Manifest for the client-side web part.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly manifest: " + }, + { + "kind": "Reference", + "text": "IClientSideWebPartManifestInstance", + "canonicalReference": "@microsoft/sp-module-interfaces!IClientSideWebPartManifestInstance:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "manifest", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartContext#pageContext:member", + "docComment": "/**\n * SharePoint page context.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly pageContext: " + }, + { + "kind": "Reference", + "text": "PageContext", + "canonicalReference": "@microsoft/sp-page-context!PageContext:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "pageContext", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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 propertyPane: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneAccessor", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "propertyPane", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartContext#spHttpClient:member", + "docComment": "/**\n * SPHttpClient instance scoped to this web part.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly spHttpClient: " + }, + { + "kind": "Reference", + "text": "SPHttpClient", + "canonicalReference": "@microsoft/sp-http!SPHttpClient:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "spHttpClient", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartContext#statusRenderer:member", + "docComment": "/**\n * Web part status renderer.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly statusRenderer: " + }, + { + "kind": "Reference", + "text": "IClientSideWebPartStatusRenderer", + "canonicalReference": "@microsoft/sp-webpart-base!default:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "statusRenderer", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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 webPartTag: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "webPartTag", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IWebPartData " + } + ], + "releaseTag": "Public", + "name": "IWebPartData", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "dataVersion: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "dataVersion", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "description?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "description", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "dynamicDataPaths?: " + }, + { + "kind": "Content", + "text": "{\n [path: string]: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "dynamicDataPaths", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "dynamicDataValues?: " + }, + { + "kind": "Content", + "text": "{\n [path: string]: any;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Beta", + "name": "dynamicDataValues", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "instanceId: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "instanceId", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "properties?: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "properties", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "serverProcessedContent?: " + }, + { + "kind": "Reference", + "text": "ISerializedServerProcessedData", + "canonicalReference": "@microsoft/sp-webpart-base!ISerializedServerProcessedData:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "serverProcessedContent", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "title: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "title", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IWebPartPropertiesMetadata " + } + ], + "releaseTag": "Public", + "name": "IWebPartPropertiesMetadata", + "members": [ + { + "kind": "IndexSignature", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:index(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "[key: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Reference", + "text": "IWebPartPropertyMetadata", + "canonicalReference": "@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "key", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "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 IWebPartPropertyMetadata " + } + ], + "releaseTag": "Public", + "name": "IWebPartPropertyMetadata", + "members": [ + { + "kind": "PropertySignature", + "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": "Content", + "text": "dynamicPropertyType?: " + }, + { + "kind": "Content", + "text": "'boolean' | 'number' | 'string' | 'array' | 'object'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "dynamicPropertyType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "isHtmlString?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isHtmlString", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "isImageSource?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isImageSource", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "isLink?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isLink", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "isSearchablePlainText?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "isSearchablePlainText", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "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": "Content", + "text": "shouldNotPersist?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "shouldNotPersist", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Function", + "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 PropertyPaneButton(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneButtonProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneButtonProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneButtonProps", + "canonicalReference": "@microsoft/sp-webpart-base!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-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 PropertyPaneButtonType " + } + ], + "releaseTag": "Public", + "name": "PropertyPaneButtonType", + "members": [ + { + "kind": "EnumMember", + "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": "Content", + "text": "Command = " + }, + { + "kind": "Content", + "text": "4" + } + ], + "releaseTag": "Public", + "name": "Command", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "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": "Content", + "text": "Compound = " + }, + { + "kind": "Content", + "text": "3" + } + ], + "releaseTag": "Public", + "name": "Compound", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-webpart-base!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-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": "Content", + "text": "Icon = " + }, + { + "kind": "Content", + "text": "5" + } + ], + "releaseTag": "Public", + "name": "Icon", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "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": "Content", + "text": "Normal = " + }, + { + "kind": "Content", + "text": "0" + } + ], + "releaseTag": "Public", + "name": "Normal", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "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": "Content", + "text": "Primary = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Public", + "name": "Primary", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + }, + { + "kind": "Function", + "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 PropertyPaneCheckbox(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneCheckboxProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneCheckboxProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneCheckboxProps", + "canonicalReference": "@microsoft/sp-webpart-base!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-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 PropertyPaneChoiceGroup(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneChoiceGroupProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneChoiceGroupProps", + "canonicalReference": "@microsoft/sp-webpart-base!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-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 PropertyPaneCustomField(properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneCustomFieldProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneCustomFieldProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneCustomFieldProps", + "canonicalReference": "@microsoft/sp-webpart-base!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-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 PropertyPaneDropdown(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneDropdownProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDropdownProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneDropdownProps", + "canonicalReference": "@microsoft/sp-webpart-base!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-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 PropertyPaneDropdownOptionType " + } + ], + "releaseTag": "Public", + "name": "PropertyPaneDropdownOptionType", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-webpart-base!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-webpart-base!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-webpart-base!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-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 PropertyPaneDynamicField(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldProps", + "canonicalReference": "@microsoft/sp-webpart-base!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-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 PropertyPaneDynamicFieldSet(properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldSetProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDynamicFieldSetProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicFieldSetProps", + "canonicalReference": "@microsoft/sp-webpart-base!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-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 PropertyPaneDynamicTextField(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicTextFieldProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneDynamicTextFieldProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneDynamicTextFieldProps", + "canonicalReference": "@microsoft/sp-webpart-base!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-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": "export declare enum PropertyPaneFieldType " + } + ], + "releaseTag": "Public", + "name": "PropertyPaneFieldType", + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-webpart-base!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-webpart-base!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-webpart-base!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-webpart-base!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-webpart-base!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-webpart-base!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-webpart-base!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-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": "Content", + "text": "DynamicTextField = " + }, + { + "kind": "Content", + "text": "15" + } + ], + "releaseTag": "Beta", + "name": "DynamicTextField", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "canonicalReference": "@microsoft/sp-webpart-base!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-webpart-base!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-webpart-base!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-webpart-base!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-webpart-base!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-webpart-base!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-webpart-base!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-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 PropertyPaneHorizontalRule(): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!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-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 PropertyPaneLabel(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneLabelProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneLabelProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneLabelProps", + "canonicalReference": "@microsoft/sp-webpart-base!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-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 PropertyPaneLink(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneLinkProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneLinkProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneLinkProps", + "canonicalReference": "@microsoft/sp-webpart-base!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-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 PropertyPaneSlider(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneSliderProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneSliderProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneSliderProps", + "canonicalReference": "@microsoft/sp-webpart-base!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-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 PropertyPaneTextField(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneTextFieldProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneTextFieldProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneTextFieldProps", + "canonicalReference": "@microsoft/sp-webpart-base!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-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 PropertyPaneToggle(targetProperty: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", properties: " + }, + { + "kind": "Reference", + "text": "IPropertyPaneToggleProps", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneToggleProps:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "IPropertyPaneField", + "canonicalReference": "@microsoft/sp-webpart-base!IPropertyPaneField:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IPropertyPaneToggleProps", + "canonicalReference": "@microsoft/sp-webpart-base!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" + }, + { + "kind": "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 WebPartContext extends " + }, + { + "kind": "Reference", + "text": "BaseWebPartContext", + "canonicalReference": "@microsoft/sp-webpart-base!default:class" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "WebPartContext", + "members": [ + { + "kind": "Property", + "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 domElement: " + }, + { + "kind": "Reference", + "text": "HTMLElement", + "canonicalReference": "!HTMLElement:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "domElement", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 microsoftTeams: " + }, + { + "kind": "Content", + "text": "typeof microsoftTeams | undefined" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "microsoftTeams", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "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 sdks: " + }, + { + "kind": "Reference", + "text": "ISDKs", + "canonicalReference": "@microsoft/sp-webpart-base!ISDKs:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "sdks", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + }, + { + "kind": "Property", + "canonicalReference": "@microsoft/sp-webpart-base!WebPartContext#statusRenderer:member", + "docComment": "/**\n * Web part status renderer.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly statusRenderer: " + }, + { + "kind": "Reference", + "text": "IClientSideWebPartStatusRenderer", + "canonicalReference": "@microsoft/sp-webpart-base!default:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "statusRenderer", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "implementsTokenRanges": [] + }, + { + "kind": "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 WebPartFormFactor " + } + ], + "releaseTag": "Beta", + "name": "WebPartFormFactor", + "members": [ + { + "kind": "EnumMember", + "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": "Content", + "text": "FullSize = " + }, + { + "kind": "Content", + "text": "1" + } + ], + "releaseTag": "Beta", + "name": "FullSize", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "EnumMember", + "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": "Content", + "text": "Standard = " + }, + { + "kind": "Content", + "text": "0" + } + ], + "releaseTag": "Beta", + "name": "Standard", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ] + } + ] +}