From 882bd6e1d140ac87eef65ab6100066d37022e2b7 Mon Sep 17 00:00:00 2001 From: NicPape Date: Wed, 1 Oct 2025 10:26:47 -0500 Subject: [PATCH] Update public docs for 1.22.0-beta.2 release --- SP-Framework/decorators.yml | 4 +- .../sp-adaptive-card-extension-base.yml | 38 +++---- .../adaptivecardextensioncontext.yml | 16 +-- .../barchartdata.yml | 2 +- .../baseadaptivecardextension.yml | 67 ++++++----- .../baseadaptivecardquickview.yml | 12 +- .../basebasiccardview.yml | 2 +- .../basecardview.yml | 10 +- .../basecomponentscardview.yml | 4 +- .../baseimagecardview.yml | 2 +- .../baseprimarytextcardview.yml | 2 +- .../basequickview.yml | 6 +- .../basetemplatecardview.yml | 4 +- .../baseview.yml | 2 +- .../basewebquickview.yml | 2 +- .../genericcardviewfooterconfiguration.yml | 2 +- .../genericcardviewfooterparameters.yml | 4 +- .../iadaptivecardextensionactionview.yml | 2 +- .../iadaptivecardextensiondataview.yml | 2 +- ...iadaptivecardextensionpropertymetadata.yml | 2 +- .../sp-adaptive-card-extension-base/iaxis.yml | 4 +- .../ibarchartcardviewconfiguration.yml | 2 +- .../ibarchartseries.yml | 6 +- .../ibaseactionerrorarguments.yml | 2 +- .../ibasecarddatavisualizationparameters.yml | 8 +- .../ibasiccardparameters.yml | 2 +- .../ibasictextcardviewconfiguration.yml | 4 +- .../icachedloadparameters.yml | 2 +- .../icachesettings.yml | 2 +- .../icardbarchartparameters.yml | 2 +- .../icardbarparameters.yml | 4 +- .../icardbutton.yml | 4 +- .../icardbuttonbase.yml | 2 +- .../icardbuttonparameters.yml | 4 +- .../icardcomponentparameters.yml | 4 +- .../icardlinechartparameters.yml | 2 +- .../icardpiechartparameters.yml | 2 +- .../icardsearchboxbutton.yml | 2 +- .../icardsearchboxparameters.yml | 2 +- .../icardsearchfooterparameters.yml | 8 +- .../icardtextinputiconbutton.yml | 4 +- .../icardtextinputparameters.yml | 8 +- .../icardtextinputtitlebutton.yml | 2 +- .../icardtextparameters.yml | 2 +- .../icardviewconfiguration.yml | 4 +- .../icardviewparameters.yml | 8 +- .../icartesianchartparameters.yml | 10 +- ...datavisualizationcardviewconfiguration.yml | 4 +- .../idatavisualizationcardviewparameters.yml | 2 +- .../iexecuteactionarguments.yml | 2 +- .../iexecutecardaction.yml | 2 +- .../iexternallinkactionarguments.yml | 2 +- .../iexternallinkcardaction.yml | 2 +- .../igetlocationaction.yml | 4 +- .../igetlocationactionarguments.yml | 6 +- .../igetlocationactionparameters.yml | 2 +- .../igetlocationcardaction.yml | 2 +- .../iimagecardparameters.yml | 2 +- .../iimagecardviewconfiguration.yml | 8 +- .../ilinechartcardviewconfiguration.yml | 2 +- .../ilinechartseries.yml | 6 +- .../ilocationerrorarguments.yml | 2 +- .../inotificationarguments.yml | 2 +- .../ipartialmicrosoftteams.yml | 2 +- .../ipartialsdks.yml | 2 +- .../ipiechartcardviewconfiguration.yml | 2 +- .../ipiechartseries.yml | 2 +- .../ipiedatapoint.yml | 4 +- .../iprimarytextcardparameters.yml | 2 +- .../iprimarytextcardviewconfiguration.yml | 8 +- .../iquickviewactionarguments.yml | 2 +- .../iquickviewcardaction.yml | 2 +- .../iquickviewnavigator.yml | 2 +- .../isearchcardviewconfiguration.yml | 8 +- .../isearchcardviewparameters.yml | 2 +- .../iselectmediaaction.yml | 4 +- .../iselectmediaactionarguments.yml | 4 +- .../iselectmediaactionerrorarguments.yml | 4 +- .../iselectmediaactionparameters.yml | 4 +- .../iselectmediaattachment.yml | 2 +- .../iselectmediacardaction.yml | 2 +- .../ishowcardactionarguments.yml | 2 +- .../ishowlocationaction.yml | 4 +- .../ishowlocationactionarguments.yml | 2 +- .../ishowlocationactionparameters.yml | 4 +- .../ishowlocationcardaction.yml | 2 +- .../ispfxadaptivecard.yml | 2 +- .../isubmitactionarguments.yml | 2 +- .../isubmitcardaction.yml | 4 +- .../itextcardviewparameters.yml | 4 +- .../itextinputcardviewconfiguration.yml | 8 +- .../itextinputcardviewparameters.yml | 4 +- .../itextinputimagecardviewconfiguration.yml | 10 +- .../iviewnavigator.yml | 14 +-- .../linechartdata.yml | 2 +- .../maxthreetuple.yml | 2 +- .../quickviewnavigator.yml | 2 +- .../supportedbarchartdatatypes.yml | 2 +- .../supportedlinechartdatatypes.yml | 2 +- .../viewnavigator.yml | 20 ++-- .../applicationaccessor.yml | 3 +- .../applicationcustomizercontext.yml | 6 +- .../sp-application-base/baseapplication.yml | 4 +- .../baseapplicationcontext.yml | 12 +- .../baseapplicationcustomizer.yml | 6 +- .../placeholdercontent.yml | 2 +- .../placeholderprovider.yml | 16 +-- .../sp-component-base/basecomponent.yml | 4 +- .../basecomponentcontext.yml | 22 ++-- .../sp-component-base/dynamicdataprovider.yml | 22 ++-- .../dynamicdatasourcemanager.yml | 4 +- .../sp-component-base/dynamicproperty.yml | 16 +-- .../sp-component-base/ireadonlyfontstyles.yml | 2 +- .../sp-component-base/ireadonlytheme.yml | 2 +- .../iserializedserverprocesseddata.yml | 17 --- SP-Framework/sp-component-base/itheme.yml | 4 +- .../themechangedeventargs.yml | 8 +- .../sp-component-base/themeprovider.yml | 16 +-- SP-Framework/sp-core-library/_isnever.yml | 2 +- SP-Framework/sp-core-library/_nextvalue.yml | 2 +- SP-Framework/sp-core-library/_stop.yml | 2 +- SP-Framework/sp-core-library/environment.yml | 2 +- .../sp-core-library/extractfromset.yml | 2 +- SP-Framework/sp-core-library/guid.yml | 20 ++-- SP-Framework/sp-core-library/idisposable.yml | 4 +- SP-Framework/sp-core-library/iloghandler.yml | 24 ++-- .../irandomnumbergenerator.yml | 2 +- .../sp-core-library/iservicecollection.yml | 2 +- SP-Framework/sp-core-library/iservicekey.yml | 2 +- .../sp-core-library/iservicescope.yml | 22 ++-- .../sp-core-library/ispeventobserver.yml | 8 +- .../sp-core-library/itimeprovider.yml | 6 +- SP-Framework/sp-core-library/log.yml | 30 ++--- .../sp-core-library/randomnumbergenerator.yml | 4 +- .../sp-core-library/rootservicekey.yml | 2 +- SP-Framework/sp-core-library/servicekey.yml | 24 ++-- SP-Framework/sp-core-library/servicescope.yml | 28 ++--- SP-Framework/sp-core-library/session.yml | 4 +- SP-Framework/sp-core-library/sperror.yml | 4 +- SP-Framework/sp-core-library/spevent.yml | 14 +-- SP-Framework/sp-core-library/speventargs.yml | 4 +- SP-Framework/sp-core-library/text_2.yml | 16 +-- SP-Framework/sp-core-library/timeprovider.yml | 6 +- .../urlqueryparametercollection.yml | 4 +- SP-Framework/sp-core-library/validate.yml | 28 ++--- SP-Framework/sp-core-library/version.yml | 33 +++--- SP-Framework/sp-dialog/basedialog.yml | 10 +- SP-Framework/sp-dialog/dialog.yml | 12 +- SP-Framework/sp-dialog/ialertoptions.yml | 2 +- SP-Framework/sp-dialog/ipromptoptions.yml | 2 +- .../sp-dialog/isecondarydialogprovider.yml | 20 ++-- .../idynamicdataannotatedpropertyvalue.yml | 2 +- .../sp-dynamic-data/idynamicdatacallables.yml | 14 +-- .../idynamicdataeventdefinition.yml | 2 +- .../idynamicdatapropertydefinition.yml | 2 +- .../idynamicdatapropertyvaluemetadata.yml | 4 +- ...micdatapropertyvaluemetadatacollection.yml | 4 - .../sp-dynamic-data/idynamicdatasource.yml | 12 +- .../idynamicdatasourcemetadata.yml | 2 +- .../sp-extension-base/baseextension.yml | 4 +- .../sp-extension-base/extensioncontext.yml | 2 +- SP-Framework/sp-http-base.yml | 2 + SP-Framework/sp-http-base/aadhttpclient.yml | 44 ++++---- .../aadhttpclientconfiguration.yml | 16 +-- .../sp-http-base/aadhttpclientfactory.yml | 2 +- .../sp-http-base/aadhttpclientresponse.yml | 6 +- .../sp-http-base/aadtokenprovider.yml | 10 +- .../sp-http-base/aadtokenproviderfactory.yml | 2 +- .../beforefullpageredirecteventargs.yml | 53 +++++++++ .../sp-http-base/beforeredirecteventargs.yml | 10 +- SP-Framework/sp-http-base/digestcache.yml | 6 +- SP-Framework/sp-http-base/httpclient.yml | 38 +++---- .../sp-http-base/httpclientconfiguration.yml | 16 +-- .../sp-http-base/httpclientresponse.yml | 26 ++--- .../iaadhttpclientconfiguration.yml | 2 +- .../iaadhttpclientconfigurations.yml | 2 +- .../sp-http-base/iaadhttpclientoptions.yml | 4 +- .../sp-http-base/iaadtokenprovider.yml | 10 +- .../sp-http-base/ibeforeredirecteventargs.yml | 2 +- SP-Framework/sp-http-base/idigestcache.yml | 4 +- SP-Framework/sp-http-base/ifetchprovider.yml | 4 +- .../sp-http-base/igettokenoptions.yml | 2 +- .../ihttpclientconfigurations.yml | 2 +- SP-Framework/sp-http-base/ipopupeventargs.yml | 6 +- .../isphttpclientbatchconfiguration.yml | 2 +- .../isphttpclientbatchconfigurations.yml | 2 +- .../isphttpclientbatchoptions.yml | 2 +- .../isphttpclientcommonconfiguration.yml | 16 ++- .../isphttpclientconfiguration.yml | 18 ++- .../isphttpclientconfigurations.yml | 2 +- .../sp-http-base/isphttpclientoptions.yml | 2 +- .../itokenacquisitioneventargs.yml | 2 +- SP-Framework/sp-http-base/odataversion.yml | 10 +- SP-Framework/sp-http-base/popupeventargs.yml | 12 +- .../sp-http-base/popuprequesteventargs.yml | 38 +++++++ SP-Framework/sp-http-base/sphttpclient.yml | 82 +++++++++----- .../sp-http-base/sphttpclientbatch.yml | 38 +++---- .../sphttpclientbatchconfiguration.yml | 16 +-- .../sphttpclientcommonconfiguration.yml | 16 +-- .../sphttpclientconfiguration.yml | 34 ++++-- .../sp-http-base/sphttpclientresponse.yml | 8 +- SP-Framework/sp-http-base/sphttpheader.yml | 2 +- .../tokenacquisitioneventargs.yml | 6 +- SP-Framework/sp-http-msgraph/graphrequest.yml | 88 +++++++-------- .../sp-http-msgraph/msgraphclient.yml | 8 +- .../sp-http-msgraph/msgraphclientfactory.yml | 10 +- .../sp-http-msgraph/msgraphclientv3.yml | 4 +- .../sp-image-helper/iimagehelperrequest.yml | 2 +- SP-Framework/sp-image-helper/imagehelper.yml | 2 +- .../icreatesubscriptionsettings.yml | 12 +- .../ilistsubscription.yml | 2 +- .../listsubscriptionfactory.yml | 8 +- .../basefieldcustomizer.yml | 8 +- .../baseformcustomizer.yml | 8 +- .../baselistviewcommandset.yml | 12 +- .../columnaccessor.yml | 4 +- .../sp-listview-extensibility/command.yml | 2 +- .../fieldcustomizercontext.yml | 8 +- .../formcustomizercontext.yml | 18 +-- .../sp-listview-extensibility/icolumn.yml | 4 +- .../ifieldcustomizercelleventparameters.yml | 2 +- .../iformcustomizercontext.yml | 8 +- .../sp-listview-extensibility/ilist.yml | 2 +- .../sp-listview-extensibility/ilistitem.yml | 2 +- .../ilistviewaccessorstate.yml | 12 +- ...stviewcommandsetexecuteeventparameters.yml | 4 +- ...iewcommandsetlistviewupdatedparameters.yml | 4 +- .../sp-listview-extensibility/iview.yml | 2 +- .../listitemaccessor.yml | 4 +- .../listviewaccessor.yml | 16 +-- .../listviewcommandsetcontext.yml | 6 +- .../listviewstatechangedeventargs.yml | 6 +- .../sp-listview-extensibility/rowaccessor.yml | 4 +- .../selectedrowschangedeventargs.yml | 4 +- SP-Framework/sp-loader/iloadscriptoptions.yml | 2 +- SP-Framework/sp-loader/spcomponentloader.yml | 18 +-- SP-Framework/sp-module-interfaces.yml | 1 + .../iadaptivecardextensionmanifest.yml | 7 +- .../iadaptivecardextensionmanifestentry.yml | 12 +- .../sp-module-interfaces/iaiproperties.yml | 50 +++++++++ .../iclientsideapplicationmanifest.yml | 12 +- .../iclientsideassemblymanifest.yml | 2 +- ...clientsidecomponentloaderconfiguration.yml | 6 +- .../iclientsidecomponentmanifest.yml | 8 +- .../iclientsideextensionmanifest.yml | 4 +- .../iclientsidelibrarymanifest.yml | 2 +- .../iclientsidemultiversionmanifest.yml | 4 +- .../iclientsidewebpartmanifest.yml | 31 +++-- .../iclientsidewebpartmanifestentry.yml | 14 +-- .../iclientsidewebpartmanifestinstance.yml | 2 +- .../icommanddefinition.yml | 4 +- .../icommandsetextensionmanifest.yml | 2 +- .../icomponentmoduleconfiguration.yml | 4 +- .../iflexiblelayoutsizing.yml | 4 +- .../ilocalizedpathmoduleconfiguration.yml | 6 +- .../imoduleconfigurationbase.yml | 2 +- .../ipathmoduleconfiguration.yml | 6 +- .../iprefabappmanifest.yml | 16 +-- .../iprefabappondemandsitescript.yml | 2 +- .../iprefabapponinstallsitescript.yml | 2 +- .../iprefabappsitescriptbase.yml | 4 +- .../iprefabappsitesettingslink.yml | 4 +- .../iprefabapptoolboxentry.yml | 8 +- .../sp-module-interfaces/ipreloadoptions.yml | 2 +- .../sp-module-interfaces/manifesttype.yml | 2 +- .../sp-odata-types/iodatacontenttype.yml | 4 +- .../iodatacontextwebinformation.yml | 2 +- .../iodataformsclientsideconfiguration.yml | 8 +- SP-Framework/sp-odata-types/iodatalist.yml | 4 +- .../sp-odata-types/iodatanavigationnode.yml | 2 +- .../iodatanavigationnodecollection.yml | 4 +- SP-Framework/sp-odata-types/iodatauser.yml | 2 +- .../sp-odata-types/iodatausercustomaction.yml | 4 +- SP-Framework/sp-odata-types/iodataweb.yml | 2 +- .../azureactivedirectoryinfo.yml | 4 +- .../sp-page-context/isptimezonedata.yml | 4 +- .../sp-page-context/o365groupassociation.yml | 4 +- SP-Framework/sp-page-context/pagecontext.yml | 18 +-- .../sp-page-context/spdayofweek-typealias.yml | 2 +- SP-Framework/sp-page-context/spfield.yml | 4 +- SP-Framework/sp-page-context/splist.yml | 4 +- SP-Framework/sp-page-context/sppermission.yml | 106 +++++++++--------- SP-Framework/sp-page-context/spsite.yml | 6 +- SP-Framework/sp-page-context/sptimezone.yml | 4 +- SP-Framework/sp-page-context/spuser.yml | 4 +- SP-Framework/sp-page-context/spweb.yml | 10 +- SP-Framework/sp-property-pane.yml | 66 +++++------ ...dynamicdatasharedpropertyconfiguration.yml | 2 +- .../idynamicdatasharedsourceconfiguration.yml | 2 +- .../idynamicdatasharedsourcefilters.yml | 2 +- .../sp-property-pane/imagefit-typealias.yml | 2 +- .../sp-property-pane/ipopupwindowprops.yml | 2 +- .../ipropertypanebuttonprops.yml | 2 +- .../ipropertypanechoicegroupoption.yml | 2 +- .../ipropertypanechoicegroupprops.yml | 2 +- .../ipropertypaneconditionalgroup.yml | 4 +- .../ipropertypaneconfiguration.yml | 23 +++- .../ipropertypanedebounceproperty.yml | 2 +- .../ipropertypanedropdownoption.yml | 4 +- .../ipropertypanedropdownprops.yml | 6 +- .../ipropertypanedynamicfieldprops.yml | 4 +- .../ipropertypanedynamicfieldsetprops.yml | 2 +- .../ipropertypanedynamictextfieldprops.yml | 4 +- .../sp-property-pane/ipropertypanefield.yml | 2 +- .../sp-property-pane/ipropertypanegroup.yml | 2 +- .../ipropertypaneheadingprops.yml | 2 +- .../ipropertypaneiconpickerprops.yml | 8 +- .../ipropertypanelabelprops.yml | 2 +- .../ipropertypanelinkprops.yml | 2 +- .../sp-property-pane/ipropertypanepage.yml | 2 +- .../ipropertypanesliderprops.yml | 2 +- .../ipropertypanetextfieldprops.yml | 8 +- .../ipropertypanethumbnailpickerprops.yml | 7 +- .../ipropertypanetoggleprops.yml | 2 +- .../ithumbnailfabricreacticon.yml | 2 +- .../ithumbnailiconsizeimage.yml | 2 +- .../sp-property-pane/ithumbnailimage.yml | 5 +- .../propertypaneheadinglevel.yml | 2 +- .../thumbnailtype-typealias.yml | 2 +- .../basesearchquerymodifier.yml | 14 +-- .../searchquerymodifiercontext.yml | 2 +- SP-Framework/sp-top-actions.yml | 6 + SP-Framework/sp-top-actions/itopactions.yml | 6 +- .../itopactionsbuttonv2props.yml | 11 ++ .../itopactionscomboboxprops.yml | 13 +++ .../itopactionsdropdownoption.yml | 2 +- .../itopactionsdropdownprops.yml | 4 +- .../itopactionsdropdownv2props.yml | 13 +++ .../sp-top-actions/itopactionsfield.yml | 2 +- .../itopactionsfieldcommonprops.yml | 13 +++ .../sp-top-actions/itopactionssplitprops.yml | 13 +++ .../sp-top-actions/itopactionstoggleprops.yml | 26 +++++ .../sp-top-actions/topactionsfieldtype.yml | 15 +++ SP-Framework/sp-webpart-base.yml | 50 ++++----- .../sp-webpart-base/baseclientsidewebpart.yml | 12 +- SP-Framework/sp-webpart-base/basewebpart.yml | 26 ++--- .../sp-webpart-base/basewebpartcontext.yml | 10 +- SP-Framework/sp-webpart-base/iagentssdk.yml | 2 +- .../iclientsidewebpartstatusrenderer.yml | 12 +- ...dynamicdatasharedpropertyconfiguration.yml | 2 +- .../idynamicdatasharedpropertyfilters.yml | 2 +- .../idynamicdatasharedsourceconfiguration.yml | 2 +- .../idynamicdatasharedsourcefilters.yml | 2 +- .../sp-webpart-base/imicrosoftteams.yml | 2 +- .../sp-webpart-base/ipropertypaneaccessor.yml | 4 +- .../ipropertypanebuttonprops.yml | 2 +- .../ipropertypanecheckboxprops.yml | 2 +- .../ipropertypanechoicegroupoption.yml | 2 +- ...propertypanechoicegroupoptioniconprops.yml | 2 +- .../ipropertypanechoicegroupprops.yml | 2 +- .../ipropertypaneconditionalgroup.yml | 2 +- .../ipropertypaneconfiguration.yml | 2 +- .../ipropertypanecustomfieldprops.yml | 2 +- .../ipropertypanedropdowncalloutprops.yml | 2 +- .../ipropertypanedropdownoption.yml | 2 +- .../ipropertypanedropdownprops.yml | 2 +- .../ipropertypanedynamicfieldfilters.yml | 2 +- .../ipropertypanedynamicfieldprops.yml | 2 +- .../ipropertypanedynamicfieldsetprops.yml | 2 +- .../ipropertypanedynamictextfieldprops.yml | 2 +- .../sp-webpart-base/ipropertypanefield.yml | 2 +- .../sp-webpart-base/ipropertypanegroup.yml | 2 +- .../ipropertypanelabelprops.yml | 2 +- .../ipropertypanelifecycleeventdata.yml | 2 +- .../ipropertypanelinkprops.yml | 2 +- .../sp-webpart-base/ipropertypanepage.yml | 2 +- .../ipropertypanepageheader.yml | 2 +- .../ipropertypanesliderprops.yml | 2 +- .../ipropertypanetextfieldprops.yml | 2 +- .../ipropertypanetoggleprops.yml | 2 +- SP-Framework/sp-webpart-base/isdks.yml | 4 +- .../iserializedwebpartdata.yml | 8 +- .../sp-webpart-base/iwebpartcontext.yml | 14 +-- SP-Framework/sp-webpart-base/iwebpartdata.yml | 9 +- .../iwebpartpropertymetadata.yml | 4 +- .../sp-webpart-base/webpartcontext.yml | 6 +- .../sp-webpart-base/webpartformfactor.yml | 2 +- SP-Framework/toc.yml | 18 +++ 378 files changed, 1605 insertions(+), 1309 deletions(-) create mode 100644 SP-Framework/sp-http-base/beforefullpageredirecteventargs.yml create mode 100644 SP-Framework/sp-http-base/popuprequesteventargs.yml create mode 100644 SP-Framework/sp-module-interfaces/iaiproperties.yml create mode 100644 SP-Framework/sp-top-actions/itopactionsbuttonv2props.yml create mode 100644 SP-Framework/sp-top-actions/itopactionscomboboxprops.yml create mode 100644 SP-Framework/sp-top-actions/itopactionsdropdownv2props.yml create mode 100644 SP-Framework/sp-top-actions/itopactionsfieldcommonprops.yml create mode 100644 SP-Framework/sp-top-actions/itopactionssplitprops.yml create mode 100644 SP-Framework/sp-top-actions/itopactionstoggleprops.yml diff --git a/SP-Framework/decorators.yml b/SP-Framework/decorators.yml index 44fe058e..703c273a 100644 --- a/SP-Framework/decorators.yml +++ b/SP-Framework/decorators.yml @@ -4,7 +4,7 @@ name: '@microsoft/decorators' type: package summary: A conservative set of decorators intended for use in both NodeJS and web browser projects. functions: - - name: 'override(target, propertyKey, descriptor)' + - name: override(target, propertyKey, descriptor) uid: '@microsoft/decorators!override:function(1)' package: '@microsoft/decorators!' summary: >- @@ -51,7 +51,7 @@ functions: return: type: void description: '' - - name: 'virtual(target, propertyKey, descriptor)' + - name: virtual(target, propertyKey, descriptor) uid: '@microsoft/decorators!virtual:function(1)' package: '@microsoft/decorators!' summary: >- diff --git a/SP-Framework/sp-adaptive-card-extension-base.yml b/SP-Framework/sp-adaptive-card-extension-base.yml index c2cdfde1..6bb0312f 100644 --- a/SP-Framework/sp-adaptive-card-extension-base.yml +++ b/SP-Framework/sp-adaptive-card-extension-base.yml @@ -172,7 +172,7 @@ functions: <number> return: - type: '' + type: description: '' - name: BarChartCardView(configuration) uid: '@microsoft/sp-adaptive-card-extension-base!BarChartCardView:function(2)' @@ -192,7 +192,7 @@ functions: <string> return: - type: '' + type: description: '' - name: BarChartCardView(configuration) uid: '@microsoft/sp-adaptive-card-extension-base!BarChartCardView:function(3)' @@ -212,7 +212,7 @@ functions: <Date> return: - type: '' + type: description: '' - name: BasicCardView(configuration) uid: '@microsoft/sp-adaptive-card-extension-base!BasicCardView:function(1)' @@ -226,9 +226,9 @@ functions: parameters: - id: configuration description: basic card view configuration. - type: '' + type: return: - type: '' + type: description: '' - name: ImageCardView(configuration) uid: '@microsoft/sp-adaptive-card-extension-base!ImageCardView:function(1)' @@ -242,9 +242,9 @@ functions: parameters: - id: configuration description: image card view configuration. - type: '' + type: return: - type: '' + type: description: '' - name: LineChartCardView(configuration) uid: '@microsoft/sp-adaptive-card-extension-base!LineChartCardView:function(1)' @@ -264,7 +264,7 @@ functions: <number> return: - type: '' + type: description: '' - name: LineChartCardView(configuration) uid: '@microsoft/sp-adaptive-card-extension-base!LineChartCardView:function(2)' @@ -284,7 +284,7 @@ functions: <Date> return: - type: '' + type: description: '' - name: PieChartCardView(configuration) uid: '@microsoft/sp-adaptive-card-extension-base!PieChartCardView:function(1)' @@ -300,9 +300,9 @@ functions: parameters: - id: configuration description: pie chart card view configuration. - type: '' + type: return: - type: '' + type: description: pie chart card view parameters. - name: PrimaryTextCardView(configuration) uid: '@microsoft/sp-adaptive-card-extension-base!PrimaryTextCardView:function(1)' @@ -318,9 +318,9 @@ functions: parameters: - id: configuration description: primary text card view configuration. - type: '' + type: return: - type: '' + type: description: '' - name: SearchCardView(configuration) uid: '@microsoft/sp-adaptive-card-extension-base!SearchCardView:function(1)' @@ -334,9 +334,9 @@ functions: parameters: - id: configuration description: search card view configuration. - type: '' + type: return: - type: '' + type: description: '' - name: TextInputCardView(configuration) uid: '@microsoft/sp-adaptive-card-extension-base!TextInputCardView:function(1)' @@ -352,9 +352,9 @@ functions: parameters: - id: configuration description: text input card view configuration. - type: '' + type: return: - type: '' + type: description: '' - name: TextInputImageCardView(configuration) uid: '@microsoft/sp-adaptive-card-extension-base!TextInputImageCardView:function(1)' @@ -370,7 +370,7 @@ functions: parameters: - id: configuration description: text input with image card view configuration. - type: '' + type: return: - type: '' + type: description: '' diff --git a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml index e9906fdd..8b89bf76 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/adaptivecardextensioncontext.yml @@ -22,7 +22,7 @@ properties: syntax: content: 'get deviceContext(): DeviceContext;' return: - type: '' + type: - name: location uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#location:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -34,31 +34,31 @@ properties: syntax: content: 'get location(): Promise;' return: - type: 'Promise<>' + type: Promise<> - name: manifest uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#manifest:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: manifest - summary: 'See [BaseComponentContext.manifest](xref:@microsoft/sp-component-base!BaseComponentContext%23manifest:member)' + summary: See [BaseComponentContext.manifest](xref:@microsoft/sp-component-base!BaseComponentContext%23manifest:member) remarks: '' isPreview: false isDeprecated: false syntax: content: 'readonly manifest: IAdaptiveCardExtensionManifest;' return: - type: '<unknown>' + type: <unknown> - name: propertyPane uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#propertyPane:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: propertyPane - summary: 'See [IPropertyPaneAccessor](xref:@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface)' + summary: See [IPropertyPaneAccessor](xref:@microsoft/sp-webpart-base!IPropertyPaneAccessor:interface) remarks: '' isPreview: false isDeprecated: false syntax: content: 'get propertyPane(): IPropertyPaneAccessor | undefined;' return: - type: ' | undefined' + type: | undefined - name: sdks uid: '@microsoft/sp-adaptive-card-extension-base!AdaptiveCardExtensionContext#sdks:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -72,5 +72,5 @@ properties: syntax: content: 'get sdks(): IPartialSDKs | undefined;' return: - type: ' | undefined' -extends: '' + type: | undefined +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/barchartdata.yml b/SP-Framework/sp-adaptive-card-extension-base/barchartdata.yml index b9f9b920..cc63e4da 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/barchartdata.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/barchartdata.yml @@ -9,4 +9,4 @@ remarks: >- valid types. isPreview: false isDeprecated: false -syntax: 'export type BarChartData = ExtractFromSet;' +syntax: export type BarChartData = ExtractFromSet; diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml index 8ab61bc1..c83c97a8 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardextension.yml @@ -48,7 +48,7 @@ properties: uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardNavigator:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: cardNavigator - summary: 'The [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Card view.' + summary: The [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class) for the Card view. remarks: '' isPreview: false isDeprecated: false @@ -62,26 +62,26 @@ properties: uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#cardSize:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: cardSize - summary: 'The current [CardSize](xref:@microsoft/sp-adaptive-card-extension-base!CardSize:type).' + summary: The current [CardSize](xref:@microsoft/sp-adaptive-card-extension-base!CardSize:type). remarks: '' isPreview: false isDeprecated: false syntax: content: 'protected get cardSize(): CardSize;' return: - type: '' + type: - name: context uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#context:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: context - summary: 'See [BaseComponent.context](xref:@microsoft/sp-component-base!BaseComponent%23context:member).' + summary: See [BaseComponent.context](xref:@microsoft/sp-component-base!BaseComponent%23context:member). remarks: '' isPreview: false isDeprecated: false syntax: content: 'protected context: AdaptiveCardExtensionContext;' return: - type: '' + type: - name: dataVersion uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#dataVersion:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -95,7 +95,7 @@ properties: syntax: content: 'protected get dataVersion(): Version;' return: - type: '' + type: - name: description uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#description:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -112,20 +112,20 @@ properties: uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#displayMode:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: displayMode - summary: 'The current [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum).' + summary: The current [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum). remarks: '' isPreview: false isDeprecated: false syntax: content: 'get displayMode(): DisplayMode;' return: - type: '' + type: - name: iconProperty uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#iconProperty:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: iconProperty summary: The icon url used to render an icon on the Card view. - remarks: 'By default, this will return the iconImageUrl defined in the manifest.' + remarks: By default, this will return the iconImageUrl defined in the manifest. isPreview: false isDeprecated: false syntax: @@ -172,13 +172,12 @@ properties: uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#navigator:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: navigator - summary: 'The current [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class).' + summary: The current [ViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!ViewNavigator:class). remarks: >- If the current [BaseAdaptiveCardExtension.renderType](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23renderType:member) is `QuickView` then returns [BaseAdaptiveCardExtension.quickViewNavigator](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23quickViewNavigator:member). isPreview: false isDeprecated: false syntax: @@ -191,7 +190,7 @@ properties: uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#properties:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: properties - summary: 'The custom, persisted properties of the Adaptive Card Extension.' + summary: The custom, persisted properties of the Adaptive Card Extension. remarks: '' isPreview: false isDeprecated: false @@ -266,14 +265,14 @@ properties: uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#renderType:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: renderType - summary: 'The current [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type).' + summary: The current [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type). remarks: '' isPreview: false isDeprecated: false syntax: content: 'get renderType(): RenderType;' return: - type: '' + type: - name: state uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#state:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -299,7 +298,7 @@ properties: 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.' + remarks: By default, this will return the title defined in the manifest. isPreview: false isDeprecated: false syntax: @@ -314,7 +313,7 @@ methods: package: '@microsoft/sp-adaptive-card-extension-base!' fullName: getCachedState(state) summary: This virtual method returns a subset of the state object that will be cached by the client. - remarks: 'If not overriden, this will return an empty object.' + remarks: If not overriden, this will return an empty object. isPreview: true isDeprecated: false syntax: @@ -341,7 +340,7 @@ methods: /** @virtual */ protected getCacheSettings(): Partial; return: - type: 'Partial<>' + type: Partial<> description: '' - name: getPropertyPaneConfiguration() uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#getPropertyPaneConfiguration:member(1)' @@ -353,7 +352,6 @@ methods: remarks: >- Property Pane resources can be defer loaded to reduce bundle size. See [BaseAdaptiveCardExtension.loadPropertyPaneResources()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23loadPropertyPaneResources:member(1)). isPreview: false isDeprecated: false syntax: @@ -361,7 +359,7 @@ methods: /** @virtual */ protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration; return: - type: '' + type: description: '' - name: loadPropertyPaneResources() uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#loadPropertyPaneResources:member(1)' @@ -380,10 +378,10 @@ methods: return: type: Promise<void> description: '' - - name: 'onAfterDeserialize(deserializedProperties, dataVersion)' + - name: onAfterDeserialize(deserializedProperties, dataVersion) uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onAfterDeserialize:member(1)' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'onAfterDeserialize(deserializedProperties, dataVersion)' + fullName: onAfterDeserialize(deserializedProperties, dataVersion) summary: Lifecycle method called before the property bag is populated with the deserialized property object. remarks: >- The default implementation is a no-op. An Adaptive Card Extension developer can override this API if the @@ -413,7 +411,7 @@ methods: 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: '' + type: return: type: TProperties description: The property bag of the Adaptive Card Extension @@ -424,7 +422,7 @@ methods: 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`.' + remarks: For isolated Adaptive Card Extensions, this lifecycle is invoked instead of `onPropertyPaneFieldChanged`. isPreview: false isDeprecated: false syntax: @@ -458,7 +456,7 @@ methods: description: >- [IOnBeforeActionArguments](xref:@microsoft/sp-adaptive-card-extension-base!IOnBeforeActionArguments:type) for the current action. - type: '' + type: return: type: void description: '' @@ -481,7 +479,7 @@ methods: uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onDisplayModeChanged:member(1)' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: onDisplayModeChanged(oldDisplayMode) - summary: 'Lifecycle method called after the [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum) changed.' + summary: Lifecycle method called after the [DisplayMode](xref:@microsoft/sp-core-library!DisplayMode:enum) changed. remarks: '' isPreview: false isDeprecated: false @@ -492,7 +490,7 @@ methods: parameters: - id: oldDisplayMode description: The old display mode. - type: '' + type: return: type: void description: '' @@ -549,7 +547,7 @@ methods: [BaseAdaptiveCardExtension.getCachedState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23getCachedState:member(1))), which can be used to rehydrate the AdaptiveCardExtension. If undefined, the AdaptiveCardExtension was not cached or the cache expired. - type: '' + type: return: type: Promise<void> description: '' @@ -579,12 +577,12 @@ methods: Readonly<<{}>> return: - type: ' | undefined' + type: | undefined description: A registered quick view id to open or undefined. - - name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + - name: onPropertyPaneFieldChanged(propertyPath, oldValue, newValue) uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension#onPropertyPaneFieldChanged:member(1)' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + fullName: onPropertyPaneFieldChanged(propertyPath, oldValue, newValue) summary: Lifecycle method called when a Property Pane field is changed. remarks: This is invoked for reactive Property Panes. isPreview: false @@ -625,8 +623,8 @@ methods: protected onRenderTypeChanged(oldRenderType: RenderType): void; parameters: - id: oldRenderType - description: 'The previous [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type).' - type: '' + description: The previous [RenderType](xref:@microsoft/sp-adaptive-card-extension-base!RenderType:type). + type: return: type: void description: '' @@ -635,7 +633,7 @@ methods: package: '@microsoft/sp-adaptive-card-extension-base!' fullName: renderCard() summary: The id of the initial Card view. - remarks: 'By default, this returns undefined and will render a default Card view.' + remarks: By default, this returns undefined and will render a default Card view. isPreview: false isDeprecated: false syntax: @@ -676,7 +674,6 @@ methods: [BaseAdaptiveCardExtension.state](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23state:member) must have been initialized before calling [BaseAdaptiveCardExtension.setState()](xref:@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardExtension%23setState:member(1)). isPreview: false isDeprecated: false syntax: @@ -688,4 +685,4 @@ methods: return: type: void description: '' -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardquickview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardquickview.yml index 888e4af7..28ed2482 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardquickview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseadaptivecardquickview.yml @@ -28,7 +28,7 @@ properties: package: '@microsoft/sp-adaptive-card-extension-base!' fullName: focusParameters summary: An optional focus element to set focus when the view is rendered for accessibility purposes. - remarks: 'If not overriden, the focus element defaulted to the first actionable element of the quick view.' + remarks: If not overriden, the focus element defaulted to the first actionable element of the quick view. isPreview: false isDeprecated: false syntax: @@ -36,7 +36,7 @@ properties: /** @virtual */ get focusParameters(): IFocusParameters | undefined; return: - type: ' | undefined' + type: | undefined - name: template uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardQuickView#template:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -50,7 +50,7 @@ properties: /** @virtual */ abstract get template(): ISPFxAdaptiveCard; return: - type: '' + type: methods: - name: onAction(action) uid: '@microsoft/sp-adaptive-card-extension-base!BaseAdaptiveCardQuickView#onAction:member(1)' @@ -69,7 +69,7 @@ methods: description: >- The [IActionArguments](xref:@microsoft/sp-adaptive-card-extension-base!IActionArguments:type) for the current event. - type: '' + type: return: type: void description: '' @@ -90,8 +90,8 @@ methods: description: >- The [IActionErrorArguments](xref:@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments:type) for the current event. - type: '' + type: return: type: void description: '' -extends: '<TProperties, TState>' +extends: <TProperties, TState> diff --git a/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml index 0a8d2565..ecd2df6e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basebasiccardview.yml @@ -27,7 +27,7 @@ properties: /** @sealed */ get template(): ISPFxAdaptiveCard; return: - type: '' + type: extends: >- <TProperties, TState, > diff --git a/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml index bc8aea8d..c8a088a0 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basecardview.yml @@ -26,12 +26,12 @@ properties: syntax: content: 'get cardSize(): CardSize;' return: - type: '' + type: - name: isCacheEnabled uid: '@microsoft/sp-adaptive-card-extension-base!BaseCardView#isCacheEnabled:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: isCacheEnabled - summary: 'If true, this Card view will be cached and rendered at next load.' + summary: If true, this Card view will be cached and rendered at next load. remarks: '' isPreview: false isDeprecated: false @@ -81,7 +81,7 @@ methods: description: >- The [IActionArguments](xref:@microsoft/sp-adaptive-card-extension-base!IActionArguments:type) for the current event. - type: '' + type: return: type: void description: '' @@ -102,7 +102,7 @@ methods: description: >- The [IActionErrorArguments](xref:@microsoft/sp-adaptive-card-extension-base!IActionErrorArguments:type) for the current event. - type: '' + type: return: type: void description: '' @@ -126,4 +126,4 @@ methods: return: type: void description: '' -extends: '<TProperties, TState>' +extends: <TProperties, TState> diff --git a/SP-Framework/sp-adaptive-card-extension-base/basecomponentscardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basecomponentscardview.yml index 11ece04b..a87cc084 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basecomponentscardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basecomponentscardview.yml @@ -14,11 +14,11 @@ properties: package: '@microsoft/sp-adaptive-card-extension-base!' fullName: cardViewParameters summary: The Card view configuration. - remarks: 'The property must return the full configuration of the card view, including title and actions.' + remarks: The property must return the full configuration of the card view, including title and actions. isPreview: false isDeprecated: false syntax: content: 'abstract get cardViewParameters(): TParameters;' return: type: TParameters -extends: '<TProperties, TState>' +extends: <TProperties, TState> diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml index a1f0bc0a..9497d7f9 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseimagecardview.yml @@ -27,7 +27,7 @@ properties: /** @sealed */ get template(): ISPFxAdaptiveCard; return: - type: '' + type: extends: >- <TProperties, TState, > diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml index e2f04f60..640044ae 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseprimarytextcardview.yml @@ -27,7 +27,7 @@ properties: /** @sealed */ get template(): ISPFxAdaptiveCard; return: - type: '' + type: extends: >- <TProperties, TState, > diff --git a/SP-Framework/sp-adaptive-card-extension-base/basequickview.yml b/SP-Framework/sp-adaptive-card-extension-base/basequickview.yml index 0c14aa67..2d2d02f7 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basequickview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basequickview.yml @@ -14,7 +14,7 @@ properties: package: '@microsoft/sp-adaptive-card-extension-base!' fullName: externalLink summary: An optional external link to be displayed in the navigation bar above the Adaptive Card. - remarks: 'If this method is not overriden or returns undefined, no link will be displayed.' + remarks: If this method is not overriden or returns undefined, no link will be displayed. isPreview: false isDeprecated: false syntax: @@ -22,7 +22,7 @@ properties: /** @virtual */ get externalLink(): IExternalLinkParameters | undefined; return: - type: ' | undefined' + type: | undefined - name: title uid: '@microsoft/sp-adaptive-card-extension-base!BaseQuickView#title:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -39,4 +39,4 @@ properties: get title(): string; return: type: string -extends: '<TProperties, TState>' +extends: <TProperties, TState> diff --git a/SP-Framework/sp-adaptive-card-extension-base/basetemplatecardview.yml b/SP-Framework/sp-adaptive-card-extension-base/basetemplatecardview.yml index 50b94679..0f54cc84 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basetemplatecardview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basetemplatecardview.yml @@ -57,5 +57,5 @@ properties: syntax: content: 'abstract get template(): ISPFxAdaptiveCard;' return: - type: '' -extends: '<TProperties, TState>' + type: +extends: <TProperties, TState> diff --git a/SP-Framework/sp-adaptive-card-extension-base/baseview.yml b/SP-Framework/sp-adaptive-card-extension-base/baseview.yml index e3d59b5b..a6eba6c1 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/baseview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/baseview.yml @@ -43,7 +43,7 @@ properties: syntax: content: 'get context(): AdaptiveCardExtensionContext;' return: - type: '' + type: - name: properties uid: '@microsoft/sp-adaptive-card-extension-base!BaseView#properties:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/basewebquickview.yml b/SP-Framework/sp-adaptive-card-extension-base/basewebquickview.yml index 0d144a44..a9519789 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/basewebquickview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/basewebquickview.yml @@ -71,4 +71,4 @@ methods: return: type: void description: '' -extends: '<TProperties, TState>' +extends: <TProperties, TState> diff --git a/SP-Framework/sp-adaptive-card-extension-base/genericcardviewfooterconfiguration.yml b/SP-Framework/sp-adaptive-card-extension-base/genericcardviewfooterconfiguration.yml index 0e1938d2..4054c853 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/genericcardviewfooterconfiguration.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/genericcardviewfooterconfiguration.yml @@ -4,7 +4,7 @@ uid: '@microsoft/sp-adaptive-card-extension-base!GenericCardViewFooterConfigurat package: '@microsoft/sp-adaptive-card-extension-base!' fullName: GenericCardViewFooterConfiguration summary: The footer configuration for the Generic card view templates. -remarks: 'The Generic card view templates are Basic Card View, Primary Text Card View, and Image Card View.' +remarks: The Generic card view templates are Basic Card View, Primary Text Card View, and Image Card View. isPreview: false isDeprecated: false syntax: export type GenericCardViewFooterConfiguration = CardViewActionsFooterConfiguration | ICardTextInputConfiguration; diff --git a/SP-Framework/sp-adaptive-card-extension-base/genericcardviewfooterparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/genericcardviewfooterparameters.yml index 2250a568..63870474 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/genericcardviewfooterparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/genericcardviewfooterparameters.yml @@ -4,7 +4,7 @@ uid: '@microsoft/sp-adaptive-card-extension-base!GenericCardViewFooterParameters package: '@microsoft/sp-adaptive-card-extension-base!' fullName: GenericCardViewFooterParameters summary: The footer parameters for the Generic card view templates. Can contain either 0 to 2 buttons or a single text input. -remarks: 'The Generic card view templates are Basic Card View, Primary Text Card View, and Image Card View.' +remarks: The Generic card view templates are Basic Card View, Primary Text Card View, and Image Card View. isPreview: false isDeprecated: false -syntax: 'export type GenericCardViewFooterParameters = CardViewActionsFooterParameters | [ICardTextInputParameters];' +syntax: export type GenericCardViewFooterParameters = CardViewActionsFooterParameters | [ICardTextInputParameters]; diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionactionview.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionactionview.yml index 12082472..ca623dc1 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionactionview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionactionview.yml @@ -33,4 +33,4 @@ properties: content: 'onActionError: (error: IActionErrorArguments) => void;' return: type: '(error: ) => void' -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensiondataview.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensiondataview.yml index eb09a6d9..8275e725 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensiondataview.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensiondataview.yml @@ -21,4 +21,4 @@ properties: content: 'get data(): TData | undefined;' return: type: TData | undefined -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml index 23ad28a1..5d84722a 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iadaptivecardextensionpropertymetadata.yml @@ -8,4 +8,4 @@ remarks: '' isPreview: false isDeprecated: false type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iaxis.yml b/SP-Framework/sp-adaptive-card-extension-base/iaxis.yml index cfc6934e..652f86b2 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iaxis.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iaxis.yml @@ -14,7 +14,7 @@ properties: package: '@microsoft/sp-adaptive-card-extension-base!' fullName: formatter summary: A function that formats the labels for the data points on the axis. - remarks: 'If no formatter is provided, a default formatter will be used.' + remarks: If no formatter is provided, a default formatter will be used. isPreview: false isDeprecated: false syntax: @@ -39,4 +39,4 @@ properties: syntax: content: 'labelValues?: T[];' return: - type: 'T[]' + type: T[] diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibarchartcardviewconfiguration.yml b/SP-Framework/sp-adaptive-card-extension-base/ibarchartcardviewconfiguration.yml index b6830448..1e199a02 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibarchartcardviewconfiguration.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibarchartcardviewconfiguration.yml @@ -27,4 +27,4 @@ properties: [<T>] | [, <T>] -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibarchartseries.yml b/SP-Framework/sp-adaptive-card-extension-base/ibarchartseries.yml index cefead4f..d55d972b 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibarchartseries.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibarchartseries.yml @@ -17,7 +17,7 @@ properties: package: '@microsoft/sp-adaptive-card-extension-base!' fullName: color summary: Color of the series. - remarks: 'If not provided, a color will be automatically assigned.' + remarks: If not provided, a color will be automatically assigned. isPreview: false isDeprecated: false syntax: @@ -35,5 +35,5 @@ properties: syntax: content: 'data: IDataPoint[];' return: - type: '<T>[]' -extends: '' + type: <T>[] +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml index 8292b5cb..3e3bd859 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibaseactionerrorarguments.yml @@ -23,7 +23,7 @@ properties: syntax: content: 'error: IActionError;' return: - type: '' + type: - name: id uid: '@microsoft/sp-adaptive-card-extension-base!IBaseActionErrorArguments#id:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasecarddatavisualizationparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasecarddatavisualizationparameters.yml index 0c6e6887..a54de453 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibasecarddatavisualizationparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasecarddatavisualizationparameters.yml @@ -14,7 +14,7 @@ properties: package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ariaDescription summary: The 'aria-description' attribute for the data visualization component. - remarks: 'For example, "Line chart showing revenue by month from January to December".' + remarks: For example, "Line chart showing revenue by month from January to December". isPreview: false isDeprecated: false syntax: @@ -26,7 +26,7 @@ properties: package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ariaLabel summary: The 'aria-label' attribute for the data visualization component. - remarks: 'For example, "Revenue by month".' + remarks: For example, "Revenue by month". isPreview: false isDeprecated: false syntax: @@ -56,5 +56,5 @@ properties: syntax: content: 'dataVisualizationKind: CardDataVisualizationKind;' return: - type: '' -extends: '' + type: +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml index f8ad9c06..d2353a7a 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasiccardparameters.yml @@ -23,4 +23,4 @@ properties: content: 'primaryText: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ibasictextcardviewconfiguration.yml b/SP-Framework/sp-adaptive-card-extension-base/ibasictextcardviewconfiguration.yml index ba5ab1aa..17b57bdb 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ibasictextcardviewconfiguration.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ibasictextcardviewconfiguration.yml @@ -22,7 +22,7 @@ properties: syntax: content: 'footer: GenericCardViewFooterConfiguration;' return: - type: '' + type: - name: header uid: '@microsoft/sp-adaptive-card-extension-base!IBasicTextCardViewConfiguration#header:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -34,7 +34,7 @@ properties: syntax: content: 'header: ICardTextConfiguration;' return: - type: '' + type: extends: >- Omit<, 'image' | 'body'> diff --git a/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml index 1157614a..5289d778 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icachedloadparameters.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'cardNavigatorState: string[];' return: - type: 'string[]' + type: string[] - name: state uid: '@microsoft/sp-adaptive-card-extension-base!ICachedLoadParameters#state:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml b/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml index 15aa62e7..e1af3178 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icachesettings.yml @@ -22,7 +22,7 @@ properties: syntax: content: 'cachedCardView?: () => BaseCardView;' return: - type: '() => ' + type: () => - name: expiryTimeInSeconds uid: '@microsoft/sp-adaptive-card-extension-base!ICacheSettings#expiryTimeInSeconds:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardbarchartparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icardbarchartparameters.yml index a3bc558e..4e175e6e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardbarchartparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardbarchartparameters.yml @@ -47,4 +47,4 @@ properties: content: 'showDataLabels?: boolean;' return: type: boolean -extends: '<T>' +extends: <T> diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardbarparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icardbarparameters.yml index 74991251..9d31522f 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardbarparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardbarparameters.yml @@ -32,7 +32,7 @@ properties: syntax: content: 'icon?: IAdaptiveCardExtensionIcon;' return: - type: '' + type: - name: title uid: '@microsoft/sp-adaptive-card-extension-base!ICardBarParameters#title:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -45,4 +45,4 @@ properties: content: 'title?: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml index 80164588..45980bcd 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardbutton.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'action: ICardAction;' return: - type: '' + type: - name: id uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#id:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -44,7 +44,7 @@ properties: syntax: content: 'style?: ActionStyle;' return: - type: '' + type: - name: title uid: '@microsoft/sp-adaptive-card-extension-base!ICardButton#title:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardbuttonbase.yml b/SP-Framework/sp-adaptive-card-extension-base/icardbuttonbase.yml index 9047fda7..d9ae8c0f 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardbuttonbase.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardbuttonbase.yml @@ -22,7 +22,7 @@ properties: syntax: content: 'action: ICardAction;' return: - type: '' + type: - name: id uid: '@microsoft/sp-adaptive-card-extension-base!ICardButtonBase#id:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardbuttonparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icardbuttonparameters.yml index 872e529c..deeaf48d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardbuttonparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardbuttonparameters.yml @@ -4,7 +4,7 @@ uid: '@microsoft/sp-adaptive-card-extension-base!ICardButtonParameters:interface package: '@microsoft/sp-adaptive-card-extension-base!' fullName: ICardButtonParameters summary: Card button component parameters. -remarks: 'Card buttons are used in the card view footer and used to invoke such actions as Submit, QuickView, etc.' +remarks: Card buttons are used in the card view footer and used to invoke such actions as Submit, QuickView, etc. isPreview: false isDeprecated: false type: interface @@ -45,4 +45,4 @@ properties: content: 'title: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardcomponentparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icardcomponentparameters.yml index 49d8a71c..79c13687 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardcomponentparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardcomponentparameters.yml @@ -13,14 +13,14 @@ properties: uid: '@microsoft/sp-adaptive-card-extension-base!ICardComponentParameters#componentName:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: componentName - summary: 'Unique component name. For example, "textInput"' + summary: Unique component name. For example, "textInput" remarks: '' isPreview: false isDeprecated: false syntax: content: 'componentName: CardComponentName;' return: - type: '' + type: - name: id uid: '@microsoft/sp-adaptive-card-extension-base!ICardComponentParameters#id:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardlinechartparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icardlinechartparameters.yml index d4cc5ae5..65884b2f 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardlinechartparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardlinechartparameters.yml @@ -35,4 +35,4 @@ properties: type: >- <<T>> -extends: '<T>' +extends: <T> diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardpiechartparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icardpiechartparameters.yml index 0440a0e3..b5fe370f 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardpiechartparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardpiechartparameters.yml @@ -45,4 +45,4 @@ properties: content: 'series: [IPieChartSeries];' return: type: '[]' -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardsearchboxbutton.yml b/SP-Framework/sp-adaptive-card-extension-base/icardsearchboxbutton.yml index 9ff09a1d..075b0c1e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardsearchboxbutton.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardsearchboxbutton.yml @@ -8,4 +8,4 @@ remarks: '' isPreview: false isDeprecated: false type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardsearchboxparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icardsearchboxparameters.yml index cbb11cea..cd1ad686 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardsearchboxparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardsearchboxparameters.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'button: ICardSearchBoxButton;' return: - type: '' + type: - name: componentName uid: '@microsoft/sp-adaptive-card-extension-base!ICardSearchBoxParameters#componentName:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardsearchfooterparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icardsearchfooterparameters.yml index fab6c008..e022454e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardsearchfooterparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardsearchfooterparameters.yml @@ -37,7 +37,7 @@ properties: uid: '@microsoft/sp-adaptive-card-extension-base!ICardSearchFooterParameters#imageUrl:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: imageUrl - summary: 'Url to the image to use, should be a square aspect ratio and big enough to fit in the image area.' + summary: Url to the image to use, should be a square aspect ratio and big enough to fit in the image area. remarks: '' isPreview: false isDeprecated: false @@ -56,12 +56,12 @@ properties: syntax: content: 'onSelection?: ICardAction;' return: - type: '' + type: - name: text uid: '@microsoft/sp-adaptive-card-extension-base!ICardSearchFooterParameters#text:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: text - summary: 'Primary text to display. For example, name of the person for people search.' + summary: Primary text to display. For example, name of the person for people search. remarks: '' isPreview: false isDeprecated: false @@ -81,4 +81,4 @@ properties: content: 'title: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardtextinputiconbutton.yml b/SP-Framework/sp-adaptive-card-extension-base/icardtextinputiconbutton.yml index 6836459c..47f70cd0 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardtextinputiconbutton.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardtextinputiconbutton.yml @@ -20,5 +20,5 @@ properties: syntax: content: 'icon: IAdaptiveCardExtensionIcon;' return: - type: '' -extends: '' + type: +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardtextinputparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icardtextinputparameters.yml index 6de2882e..8d2715f4 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardtextinputparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardtextinputparameters.yml @@ -65,26 +65,26 @@ properties: uid: '@microsoft/sp-adaptive-card-extension-base!ICardTextInputParameters#iconAfter:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: iconAfter - summary: 'Properties for an optional icon, displayed in the right end of the text input.' + summary: Properties for an optional icon, displayed in the right end of the text input. remarks: '' isPreview: false isDeprecated: false syntax: content: 'iconAfter?: IAdaptiveCardExtensionIcon;' return: - type: '' + type: - name: iconBefore uid: '@microsoft/sp-adaptive-card-extension-base!ICardTextInputParameters#iconBefore:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: iconBefore - summary: 'Properties for an optional icon, displayed in the left end of the text input.' + summary: Properties for an optional icon, displayed in the left end of the text input. remarks: '' isPreview: false isDeprecated: false syntax: content: 'iconBefore?: IAdaptiveCardExtensionIcon;' return: - type: '' + type: - name: onChange uid: '@microsoft/sp-adaptive-card-extension-base!ICardTextInputParameters#onChange:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardtextinputtitlebutton.yml b/SP-Framework/sp-adaptive-card-extension-base/icardtextinputtitlebutton.yml index 4235dbb6..b5762924 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardtextinputtitlebutton.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardtextinputtitlebutton.yml @@ -21,4 +21,4 @@ properties: content: 'title: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardtextparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icardtextparameters.yml index 1430a99c..3e912b8c 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardtextparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardtextparameters.yml @@ -33,4 +33,4 @@ properties: content: 'text: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardviewconfiguration.yml b/SP-Framework/sp-adaptive-card-extension-base/icardviewconfiguration.yml index 81caf951..38ebcf09 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardviewconfiguration.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardviewconfiguration.yml @@ -36,7 +36,7 @@ properties: syntax: content: 'cardBar: ICardBarConfiguration;' return: - type: '' + type: - name: footer uid: '@microsoft/sp-adaptive-card-extension-base!ICardViewConfiguration#footer:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -76,4 +76,4 @@ properties: syntax: content: 'image: IAdaptiveCardExtensionImage | undefined;' return: - type: ' | undefined' + type: | undefined diff --git a/SP-Framework/sp-adaptive-card-extension-base/icardviewparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icardviewparameters.yml index c8a622ec..3ebd9d33 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icardviewparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icardviewparameters.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'body: ICardComponentParameters[] | undefined;' return: - type: '[] | undefined' + type: [] | undefined - name: cardBar uid: '@microsoft/sp-adaptive-card-extension-base!ICardViewParameters#cardBar:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -56,7 +56,7 @@ properties: syntax: content: 'footer: ICardComponentParameters[] | undefined;' return: - type: '[] | undefined' + type: [] | undefined - name: header uid: '@microsoft/sp-adaptive-card-extension-base!ICardViewParameters#header:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -68,7 +68,7 @@ properties: syntax: content: 'header: ICardComponentParameters[] | undefined;' return: - type: '[] | undefined' + type: [] | undefined - name: image uid: '@microsoft/sp-adaptive-card-extension-base!ICardViewParameters#image:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -80,4 +80,4 @@ properties: syntax: content: 'image: IAdaptiveCardExtensionImage | undefined;' return: - type: ' | undefined' + type: | undefined diff --git a/SP-Framework/sp-adaptive-card-extension-base/icartesianchartparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/icartesianchartparameters.yml index 7279acc7..39156532 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/icartesianchartparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/icartesianchartparameters.yml @@ -14,23 +14,23 @@ properties: package: '@microsoft/sp-adaptive-card-extension-base!' fullName: xAxis summary: Parameters for the X axis of the chart. - remarks: 'This includes positions on xAxis to be represented as ticks, and a formatter function for the data point labels.' + remarks: This includes positions on xAxis to be represented as ticks, and a formatter function for the data point labels. isPreview: false isDeprecated: false syntax: content: 'xAxis?: IAxis;' return: - type: '<T>' + type: <T> - name: yAxis uid: '@microsoft/sp-adaptive-card-extension-base!ICartesianChartParameters#yAxis:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: yAxis summary: Parameters for the Y axis of the chart. - remarks: 'This includes positions on yAxis to be represented as ticks, and a formatter function for the data point labels.' + remarks: This includes positions on yAxis to be represented as ticks, and a formatter function for the data point labels. isPreview: false isDeprecated: false syntax: content: 'yAxis?: IAxis;' return: - type: '<number>' -extends: '' + type: <number> +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/idatavisualizationcardviewconfiguration.yml b/SP-Framework/sp-adaptive-card-extension-base/idatavisualizationcardviewconfiguration.yml index f15a8608..e4b9efe2 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/idatavisualizationcardviewconfiguration.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/idatavisualizationcardviewconfiguration.yml @@ -22,7 +22,7 @@ properties: syntax: content: 'footer?: ICardButtonConfiguration;' return: - type: '' + type: - name: header uid: '@microsoft/sp-adaptive-card-extension-base!IDataVisualizationCardViewConfiguration#header:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -34,7 +34,7 @@ properties: syntax: content: 'header?: ICardTextConfiguration;' return: - type: '' + type: extends: >- Omit<, 'image' | 'header' | 'footer'> diff --git a/SP-Framework/sp-adaptive-card-extension-base/idatavisualizationcardviewparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/idatavisualizationcardviewparameters.yml index 193ac56c..39dab8ab 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/idatavisualizationcardviewparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/idatavisualizationcardviewparameters.yml @@ -60,4 +60,4 @@ properties: content: 'header: [ICardTextParameters] | undefined;' return: type: '[] | undefined' -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexecuteactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iexecuteactionarguments.yml index e72ce3a3..7782c78d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iexecuteactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iexecuteactionarguments.yml @@ -49,4 +49,4 @@ properties: content: 'verb?: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexecutecardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iexecutecardaction.yml index b679cf92..ff1120e5 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iexecutecardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iexecutecardaction.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'parameters: IExecuteCardParameters;' return: - type: '' + type: - name: type uid: '@microsoft/sp-adaptive-card-extension-base!IExecuteCardAction#type:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkactionarguments.yml index 32ee342d..dcc411fc 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkactionarguments.yml @@ -36,4 +36,4 @@ properties: content: 'url: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml index 0f1f201d..63b88f52 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iexternallinkcardaction.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'parameters: IExternalLinkParameters;' return: - type: '' + type: - name: type uid: '@microsoft/sp-adaptive-card-extension-base!IExternalLinkCardAction#type:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml index 9ed71ecc..cab7e264 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationaction.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'parameters?: IGetLocationActionParameters;' return: - type: '' + type: - name: type uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationAction#type:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -33,4 +33,4 @@ properties: content: 'type: ''VivaAction.GetLocation'';' return: type: '''VivaAction.GetLocation''' -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml index 46af96e0..e7faa237 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionarguments.yml @@ -16,14 +16,14 @@ properties: uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments#location:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: location - summary: 'Coordinates of the location. In case of erroneous situation, location object will be undefined.' + summary: Coordinates of the location. In case of erroneous situation, location object will be undefined. remarks: '' isPreview: false isDeprecated: false syntax: content: 'location?: ILocation;' return: - type: '' + type: - name: type uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionArguments#type:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -36,4 +36,4 @@ properties: content: 'type: ''VivaAction.GetLocation'';' return: type: '''VivaAction.GetLocation''' -extends: 'Omit<, ''type''>' +extends: Omit<, 'type'> diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml index a773af88..d29d9461 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationactionparameters.yml @@ -13,7 +13,7 @@ properties: uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationActionParameters#chooseLocationOnMap:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: chooseLocationOnMap - summary: 'If true, allow the user to choose a location by opening a map. Otherwise, get the current location.' + summary: If true, allow the user to choose a location by opening a map. Otherwise, get the current location. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml index d3efe565..635d573e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/igetlocationcardaction.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'parameters?: IGetLocationActionParameters;' return: - type: '' + type: - name: type uid: '@microsoft/sp-adaptive-card-extension-base!IGetLocationCardAction#type:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml index a8a666ec..1d43117d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iimagecardparameters.yml @@ -47,4 +47,4 @@ properties: content: 'primaryText: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iimagecardviewconfiguration.yml b/SP-Framework/sp-adaptive-card-extension-base/iimagecardviewconfiguration.yml index 8c3eba7a..7366070c 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iimagecardviewconfiguration.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iimagecardviewconfiguration.yml @@ -22,7 +22,7 @@ properties: syntax: content: 'footer: GenericCardViewFooterConfiguration;' return: - type: '' + type: - name: header uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardViewConfiguration#header:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -34,7 +34,7 @@ properties: syntax: content: 'header: ICardTextConfiguration;' return: - type: '' + type: - name: image uid: '@microsoft/sp-adaptive-card-extension-base!IImageCardViewConfiguration#image:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -46,5 +46,5 @@ properties: syntax: content: 'image: IAdaptiveCardExtensionImage;' return: - type: '' -extends: 'Omit<, ''body''>' + type: +extends: Omit<, 'body'> diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilinechartcardviewconfiguration.yml b/SP-Framework/sp-adaptive-card-extension-base/ilinechartcardviewconfiguration.yml index 3dbc4c64..0b6b0335 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ilinechartcardviewconfiguration.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ilinechartcardviewconfiguration.yml @@ -27,4 +27,4 @@ properties: [<T>] | [, <T>] -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilinechartseries.yml b/SP-Framework/sp-adaptive-card-extension-base/ilinechartseries.yml index adfcbad0..2d6df16b 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ilinechartseries.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ilinechartseries.yml @@ -14,7 +14,7 @@ properties: package: '@microsoft/sp-adaptive-card-extension-base!' fullName: color summary: Color of the series. - remarks: 'If not provided, a color will be automatically assigned.' + remarks: If not provided, a color will be automatically assigned. isPreview: false isDeprecated: false syntax: @@ -32,7 +32,7 @@ properties: syntax: content: 'data: IDataPoint[];' return: - type: '<T>[]' + type: <T>[] - name: lastDataPointLabel uid: '@microsoft/sp-adaptive-card-extension-base!ILineChartSeries#lastDataPointLabel:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -45,4 +45,4 @@ properties: content: 'lastDataPointLabel?: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml index 9f6cb49e..80c2415a 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ilocationerrorarguments.yml @@ -39,4 +39,4 @@ properties: content: 'type: ''VivaAction.GetLocation'' | ''VivaAction.ShowLocation'';' return: type: '''VivaAction.GetLocation'' | ''VivaAction.ShowLocation''' -extends: 'Omit<, ''type''>' +extends: Omit<, 'type'> diff --git a/SP-Framework/sp-adaptive-card-extension-base/inotificationarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/inotificationarguments.yml index 06ebf54d..a7d40117 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/inotificationarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/inotificationarguments.yml @@ -35,4 +35,4 @@ properties: syntax: content: 'version: Version;' return: - type: '' + type: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ipartialmicrosoftteams.yml b/SP-Framework/sp-adaptive-card-extension-base/ipartialmicrosoftteams.yml index 3e084b64..62fc4f1a 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ipartialmicrosoftteams.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ipartialmicrosoftteams.yml @@ -23,4 +23,4 @@ properties: syntax: content: 'teamsJs: IPartialTeamsJs;' return: - type: '' + type: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ipartialsdks.yml b/SP-Framework/sp-adaptive-card-extension-base/ipartialsdks.yml index 581eb3c3..c5855365 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ipartialsdks.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ipartialsdks.yml @@ -30,4 +30,4 @@ properties: syntax: content: 'microsoftTeams?: IPartialMicrosoftTeams;' return: - type: '' + type: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ipiechartcardviewconfiguration.yml b/SP-Framework/sp-adaptive-card-extension-base/ipiechartcardviewconfiguration.yml index 3aeb9b10..d90c4b39 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ipiechartcardviewconfiguration.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ipiechartcardviewconfiguration.yml @@ -27,4 +27,4 @@ properties: uid="@microsoft/sp-adaptive-card-extension-base!ICardPieChartConfiguration:interface" />] | [, ] -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ipiechartseries.yml b/SP-Framework/sp-adaptive-card-extension-base/ipiechartseries.yml index c11bff59..0cd2a655 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ipiechartseries.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ipiechartseries.yml @@ -27,4 +27,4 @@ properties: syntax: content: 'data: IPieDataPoint[];' return: - type: '[]' + type: [] diff --git a/SP-Framework/sp-adaptive-card-extension-base/ipiedatapoint.yml b/SP-Framework/sp-adaptive-card-extension-base/ipiedatapoint.yml index 9f8ee2d9..264c281d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ipiedatapoint.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ipiedatapoint.yml @@ -14,7 +14,7 @@ properties: package: '@microsoft/sp-adaptive-card-extension-base!' fullName: color summary: 'Individual color of the data point. Example: ''red'', ''\#FF0000'', ''rgba(255, 0, 0, 1)''' - remarks: 'If not provided, a color will be automatically assigned.' + remarks: If not provided, a color will be automatically assigned. isPreview: false isDeprecated: false syntax: @@ -35,4 +35,4 @@ properties: content: 'showLabel?: boolean;' return: type: boolean -extends: '<string>' +extends: <string> diff --git a/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml index 38b95084..f71f8d30 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardparameters.yml @@ -35,4 +35,4 @@ properties: content: 'primaryText: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardviewconfiguration.yml b/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardviewconfiguration.yml index b8f35557..15fa62d1 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardviewconfiguration.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iprimarytextcardviewconfiguration.yml @@ -22,7 +22,7 @@ properties: syntax: content: 'body: ICardTextConfiguration;' return: - type: '' + type: - name: footer uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardViewConfiguration#footer:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -34,7 +34,7 @@ properties: syntax: content: 'footer: GenericCardViewFooterConfiguration;' return: - type: '' + type: - name: header uid: '@microsoft/sp-adaptive-card-extension-base!IPrimaryTextCardViewConfiguration#header:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -46,5 +46,5 @@ properties: syntax: content: 'header: ICardTextConfiguration;' return: - type: '' -extends: 'Omit<, ''image''>' + type: +extends: Omit<, 'image'> diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewactionarguments.yml index 50aa10ca..e55e2a78 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iquickviewactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewactionarguments.yml @@ -48,4 +48,4 @@ properties: content: 'viewId: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml index 2fd4f260..71248a6e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewcardaction.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'parameters: IQuickViewParameters;' return: - type: '' + type: - name: type uid: '@microsoft/sp-adaptive-card-extension-base!IQuickViewCardAction#type:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iquickviewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/iquickviewnavigator.yml index 36aa04fe..3b1e6934 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iquickviewnavigator.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iquickviewnavigator.yml @@ -21,4 +21,4 @@ properties: content: 'close: () => void;' return: type: () => void -extends: '<TView>' +extends: <TView> diff --git a/SP-Framework/sp-adaptive-card-extension-base/isearchcardviewconfiguration.yml b/SP-Framework/sp-adaptive-card-extension-base/isearchcardviewconfiguration.yml index 43abc9da..56bad2e2 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isearchcardviewconfiguration.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isearchcardviewconfiguration.yml @@ -22,7 +22,7 @@ properties: syntax: content: 'body: ICardSearchBoxConfiguration;' return: - type: '' + type: - name: footer uid: '@microsoft/sp-adaptive-card-extension-base!ISearchCardViewConfiguration#footer:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -34,7 +34,7 @@ properties: syntax: content: 'footer: ICardSearchFooterConfiguration | undefined;' return: - type: ' | undefined' + type: | undefined - name: header uid: '@microsoft/sp-adaptive-card-extension-base!ISearchCardViewConfiguration#header:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -46,5 +46,5 @@ properties: syntax: content: 'header: ICardTextConfiguration;' return: - type: '' -extends: 'Omit<, ''image''>' + type: +extends: Omit<, 'image'> diff --git a/SP-Framework/sp-adaptive-card-extension-base/isearchcardviewparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/isearchcardviewparameters.yml index 3e87523e..29a2a3cb 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isearchcardviewparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isearchcardviewparameters.yml @@ -59,4 +59,4 @@ properties: content: 'header: [ICardTextParameters];' return: type: '[]' -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml index 16cb3d5a..306e297e 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaaction.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'parameters: ISelectMediaActionParameters;' return: - type: '' + type: - name: type uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction#type:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -33,4 +33,4 @@ properties: content: 'type: ''VivaAction.SelectMedia'';' return: type: '''VivaAction.SelectMedia''' -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml index 5d8437db..fdd124e7 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionarguments.yml @@ -35,7 +35,7 @@ properties: syntax: content: 'media: ISelectMediaAttachment[];' return: - type: '[]' + type: [] - name: type uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionArguments#type:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -48,4 +48,4 @@ properties: content: 'type: ''VivaAction.SelectMedia'';' return: type: '''VivaAction.SelectMedia''' -extends: 'Omit<, ''type''>' +extends: Omit<, 'type'> diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml index ac3a882b..08c52efe 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionerrorarguments.yml @@ -50,7 +50,7 @@ properties: syntax: content: 'media: ISelectMediaAttachment[] | undefined;' return: - type: '[] | undefined' + type: [] | undefined - name: type uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionErrorArguments#type:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -63,4 +63,4 @@ properties: content: 'type: ''VivaAction.SelectMedia'';' return: type: '''VivaAction.SelectMedia''' -extends: 'Omit<, ''type''>' +extends: Omit<, 'type'> diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml index f0ec330b..fc41d8b3 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaactionparameters.yml @@ -44,7 +44,7 @@ properties: syntax: content: 'mediaType: MediaType;' return: - type: '' + type: - name: supportedFileFormats uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaActionParameters#supportedFileFormats:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -56,4 +56,4 @@ properties: syntax: content: 'supportedFileFormats?: string[];' return: - type: 'string[]' + type: string[] diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml index e6b1fcef..305b0491 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediaattachment.yml @@ -32,7 +32,7 @@ properties: syntax: content: 'error?: IAttachmentError;' return: - type: '' + type: - name: fileName uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaAttachment#fileName:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml index 3ea9c158..5955cc36 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iselectmediacardaction.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'parameters: ISelectMediaActionParameters;' return: - type: '' + type: - name: type uid: '@microsoft/sp-adaptive-card-extension-base!ISelectMediaCardAction#type:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml index 96bd6b58..3dbe3594 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowcardactionarguments.yml @@ -24,4 +24,4 @@ properties: content: 'type: ''ShowCard'';' return: type: '''ShowCard''' -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml index ed4563ca..ba3c0eeb 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationaction.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'parameters?: IShowLocationActionParameters;' return: - type: '' + type: - name: type uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationAction#type:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -33,4 +33,4 @@ properties: content: 'type: ''VivaAction.ShowLocation'';' return: type: '''VivaAction.ShowLocation''' -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionarguments.yml index c2668280..0d3a8dbb 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionarguments.yml @@ -11,4 +11,4 @@ remarks: '' isPreview: false isDeprecated: false type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml index a987b0aa..a67ec4b1 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationactionparameters.yml @@ -13,11 +13,11 @@ properties: uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationActionParameters#locationCoordinates:member' package: '@microsoft/sp-adaptive-card-extension-base!' fullName: locationCoordinates - summary: 'If set, show the coordinates that were passed. Otherwise, show the current location.' + summary: If set, show the coordinates that were passed. Otherwise, show the current location. remarks: '' isPreview: false isDeprecated: false syntax: content: 'locationCoordinates?: ILocation;' return: - type: '' + type: diff --git a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml index 9625b2c7..02c02d15 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ishowlocationcardaction.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'parameters?: IShowLocationActionParameters;' return: - type: '' + type: - name: type uid: '@microsoft/sp-adaptive-card-extension-base!IShowLocationCardAction#type:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml index 2658692e..309d09d1 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/ispfxadaptivecard.yml @@ -28,4 +28,4 @@ properties: uid="@microsoft/sp-adaptive-card-extension-base!ISelectMediaAction:interface" /> | | )[] -extends: 'Omit<, ''actions''>' +extends: Omit<, 'actions'> diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml index 473db2b7..dcf65f8a 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitactionarguments.yml @@ -36,4 +36,4 @@ properties: content: 'type: ''Submit'';' return: type: '''Submit''' -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml index 23b53f58..1e8836cb 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/isubmitcardaction.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'confirmationDialog?: IConfirmationDialog;' return: - type: '' + type: - name: parameters uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#parameters:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -32,7 +32,7 @@ properties: syntax: content: 'parameters: ISubmitCardParameters;' return: - type: '' + type: - name: type uid: '@microsoft/sp-adaptive-card-extension-base!ISubmitCardAction#type:member' package: '@microsoft/sp-adaptive-card-extension-base!' diff --git a/SP-Framework/sp-adaptive-card-extension-base/itextcardviewparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/itextcardviewparameters.yml index ac70dfbf..89a4e859 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/itextcardviewparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/itextcardviewparameters.yml @@ -44,7 +44,7 @@ properties: syntax: content: 'footer: GenericCardViewFooterParameters;' return: - type: '' + type: - name: header uid: '@microsoft/sp-adaptive-card-extension-base!ITextCardViewParameters#header:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -57,4 +57,4 @@ properties: content: 'header: [ICardTextParameters];' return: type: '[]' -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/itextinputcardviewconfiguration.yml b/SP-Framework/sp-adaptive-card-extension-base/itextinputcardviewconfiguration.yml index 74acdc23..02bf66f6 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/itextinputcardviewconfiguration.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/itextinputcardviewconfiguration.yml @@ -25,7 +25,7 @@ properties: syntax: content: 'body: ICardTextInputConfiguration;' return: - type: '' + type: - name: footer uid: '@microsoft/sp-adaptive-card-extension-base!ITextInputCardViewConfiguration#footer:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -37,7 +37,7 @@ properties: syntax: content: 'footer: CardViewActionsFooterConfiguration;' return: - type: '' + type: - name: header uid: '@microsoft/sp-adaptive-card-extension-base!ITextInputCardViewConfiguration#header:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -49,5 +49,5 @@ properties: syntax: content: 'header: ICardTextConfiguration;' return: - type: '' -extends: 'Omit<, ''image''>' + type: +extends: Omit<, 'image'> diff --git a/SP-Framework/sp-adaptive-card-extension-base/itextinputcardviewparameters.yml b/SP-Framework/sp-adaptive-card-extension-base/itextinputcardviewparameters.yml index 909906ed..499e7401 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/itextinputcardviewparameters.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/itextinputcardviewparameters.yml @@ -44,7 +44,7 @@ properties: syntax: content: 'footer: CardViewActionsFooterParameters;' return: - type: '' + type: - name: header uid: '@microsoft/sp-adaptive-card-extension-base!ITextInputCardViewParameters#header:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -57,4 +57,4 @@ properties: content: 'header: [ICardTextParameters];' return: type: '[]' -extends: '' +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/itextinputimagecardviewconfiguration.yml b/SP-Framework/sp-adaptive-card-extension-base/itextinputimagecardviewconfiguration.yml index f6e8e2f5..83666399 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/itextinputimagecardviewconfiguration.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/itextinputimagecardviewconfiguration.yml @@ -26,7 +26,7 @@ properties: syntax: content: 'body: ICardTextInputConfiguration;' return: - type: '' + type: - name: footer uid: '@microsoft/sp-adaptive-card-extension-base!ITextInputImageCardViewConfiguration#footer:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -38,7 +38,7 @@ properties: syntax: content: 'footer: CardViewActionsFooterConfiguration;' return: - type: '' + type: - name: header uid: '@microsoft/sp-adaptive-card-extension-base!ITextInputImageCardViewConfiguration#header:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -50,7 +50,7 @@ properties: syntax: content: 'header: ICardTextConfiguration;' return: - type: '' + type: - name: image uid: '@microsoft/sp-adaptive-card-extension-base!ITextInputImageCardViewConfiguration#image:member' package: '@microsoft/sp-adaptive-card-extension-base!' @@ -62,5 +62,5 @@ properties: syntax: content: 'image: IAdaptiveCardExtensionImage;' return: - type: '' -extends: '' + type: +extends: diff --git a/SP-Framework/sp-adaptive-card-extension-base/iviewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/iviewnavigator.yml index 4d8b8481..bc0051ab 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/iviewnavigator.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/iviewnavigator.yml @@ -14,7 +14,7 @@ properties: package: '@microsoft/sp-adaptive-card-extension-base!' fullName: currentId summary: Get the id of the currently rendered View from the top of the View stack - remarks: 'If the stack is empty, this will return undefined' + remarks: If the stack is empty, this will return undefined isPreview: false isDeprecated: false syntax: @@ -51,10 +51,10 @@ methods: return: type: void description: '' - - name: 'push(id, skipUpdate)' + - name: push(id, skipUpdate) uid: '@microsoft/sp-adaptive-card-extension-base!IViewNavigator#push:member(1)' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'push(id, skipUpdate)' + fullName: push(id, skipUpdate) summary: '' remarks: '' isPreview: false @@ -71,10 +71,10 @@ methods: return: type: void description: '' - - name: 'register(id, initializer)' + - name: register(id, initializer) uid: '@microsoft/sp-adaptive-card-extension-base!IViewNavigator#register:member(1)' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'register(id, initializer)' + fullName: register(id, initializer) summary: '' remarks: '' isPreview: false @@ -91,10 +91,10 @@ methods: return: type: void description: '' - - name: 'replace(id, skipUpdate)' + - name: replace(id, skipUpdate) uid: '@microsoft/sp-adaptive-card-extension-base!IViewNavigator#replace:member(1)' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'replace(id, skipUpdate)' + fullName: replace(id, skipUpdate) summary: '' remarks: '' isPreview: false diff --git a/SP-Framework/sp-adaptive-card-extension-base/linechartdata.yml b/SP-Framework/sp-adaptive-card-extension-base/linechartdata.yml index 0625855a..47693d69 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/linechartdata.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/linechartdata.yml @@ -9,4 +9,4 @@ remarks: >- for valid types. isPreview: false isDeprecated: false -syntax: 'export type LineChartData = ExtractFromSet;' +syntax: export type LineChartData = ExtractFromSet; diff --git a/SP-Framework/sp-adaptive-card-extension-base/maxthreetuple.yml b/SP-Framework/sp-adaptive-card-extension-base/maxthreetuple.yml index 4424807b..065cc3ba 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/maxthreetuple.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/maxthreetuple.yml @@ -7,4 +7,4 @@ summary: Utility type to enforce a tuple with a maximum length of 3. remarks: '' isPreview: false isDeprecated: false -syntax: 'export type MaxThreeTuple = [T] | [T, T] | [T, T, T];' +syntax: export type MaxThreeTuple = [T] | [T, T] | [T, T, T]; diff --git a/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml index a8a636ab..19152f4c 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/quickviewnavigator.yml @@ -27,4 +27,4 @@ methods: return: type: void description: '' -extends: '<TView>' +extends: <TView> diff --git a/SP-Framework/sp-adaptive-card-extension-base/supportedbarchartdatatypes.yml b/SP-Framework/sp-adaptive-card-extension-base/supportedbarchartdatatypes.yml index d9913975..b48f9737 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/supportedbarchartdatatypes.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/supportedbarchartdatatypes.yml @@ -7,4 +7,4 @@ summary: Set of supported types for the data used with the bar chart data visual remarks: '' isPreview: false isDeprecated: false -syntax: 'export type SupportedBarChartDataTypes = [string, number, Date];' +syntax: export type SupportedBarChartDataTypes = [string, number, Date]; diff --git a/SP-Framework/sp-adaptive-card-extension-base/supportedlinechartdatatypes.yml b/SP-Framework/sp-adaptive-card-extension-base/supportedlinechartdatatypes.yml index ad980300..58c6318d 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/supportedlinechartdatatypes.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/supportedlinechartdatatypes.yml @@ -7,4 +7,4 @@ summary: Set of supported types for the data used with the line chart data visua remarks: '' isPreview: false isDeprecated: false -syntax: 'export type SupportedLineChartDataTypes = [Date, number];' +syntax: export type SupportedLineChartDataTypes = [Date, number]; diff --git a/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml index 991fc985..133e713b 100644 --- a/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml +++ b/SP-Framework/sp-adaptive-card-extension-base/viewnavigator.yml @@ -9,10 +9,10 @@ isPreview: false isDeprecated: false type: class constructors: - - name: '(constructor)(handleStackChangedCallback, handleInitializeCallback)' + - name: (constructor)(handleStackChangedCallback, handleInitializeCallback) uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator:constructor(1)' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: '(constructor)(handleStackChangedCallback, handleInitializeCallback)' + fullName: (constructor)(handleStackChangedCallback, handleInitializeCallback) summary: Constructs a new instance of the `ViewNavigator` class remarks: '' isPreview: false @@ -34,7 +34,7 @@ properties: package: '@microsoft/sp-adaptive-card-extension-base!' fullName: currentId summary: Get the id of the currently rendered View from the top of the View stack - remarks: 'If the stack is empty, this will return undefined' + remarks: If the stack is empty, this will return undefined isPreview: false isDeprecated: false syntax: @@ -76,10 +76,10 @@ methods: return: type: void description: '' - - name: 'push(id, skipUpdate)' + - name: push(id, skipUpdate) uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#push:member(1)' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'push(id, skipUpdate)' + fullName: push(id, skipUpdate) summary: >- Pushes a new view to the top of the view stack. @@ -101,12 +101,12 @@ methods: return: type: void description: '' - - name: 'register(id, initializer)' + - name: register(id, initializer) uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#register:member(1)' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'register(id, initializer)' + fullName: register(id, initializer) summary: Registers a new view. - remarks: 'A View with a given `id` is only initialized once, and the instance is reused if it is pushed more than once' + remarks: A View with a given `id` is only initialized once, and the instance is reused if it is pushed more than once isPreview: false isDeprecated: false syntax: @@ -123,10 +123,10 @@ methods: return: type: void description: '' - - name: 'replace(id, skipUpdate)' + - name: replace(id, skipUpdate) uid: '@microsoft/sp-adaptive-card-extension-base!ViewNavigator#replace:member(1)' package: '@microsoft/sp-adaptive-card-extension-base!' - fullName: 'replace(id, skipUpdate)' + fullName: replace(id, skipUpdate) summary: >- Replaces the top view with a new view. diff --git a/SP-Framework/sp-application-base/applicationaccessor.yml b/SP-Framework/sp-application-base/applicationaccessor.yml index 9e791818..c1d78134 100644 --- a/SP-Framework/sp-application-base/applicationaccessor.yml +++ b/SP-Framework/sp-application-base/applicationaccessor.yml @@ -29,7 +29,6 @@ constructors: Third parties should not call this constructor. Instead, use the ApplicationAccessor instance from the component context, for example [BaseApplicationCustomizer.context](xref:@microsoft/sp-application-base!BaseApplicationCustomizer%23context:member). isPreview: false isDeprecated: false syntax: @@ -37,7 +36,7 @@ constructors: parameters: - id: serviceScope description: '' - type: '' + type: events: - name: navigatedEvent uid: '@microsoft/sp-application-base!ApplicationAccessor#navigatedEvent:member' diff --git a/SP-Framework/sp-application-base/applicationcustomizercontext.yml b/SP-Framework/sp-application-base/applicationcustomizercontext.yml index 8f6d242d..ed7b47ef 100644 --- a/SP-Framework/sp-application-base/applicationcustomizercontext.yml +++ b/SP-Framework/sp-application-base/applicationcustomizercontext.yml @@ -24,7 +24,7 @@ properties: syntax: content: 'get application(): ApplicationAccessor;' return: - type: '' + type: - name: placeholderProvider uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#placeholderProvider:member' package: '@microsoft/sp-application-base!' @@ -36,7 +36,7 @@ properties: syntax: content: 'get placeholderProvider(): PlaceholderProvider;' return: - type: '' + type: methods: - name: dispose() uid: '@microsoft/sp-application-base!ApplicationCustomizerContext#dispose:member(1)' @@ -53,4 +53,4 @@ methods: return: type: void description: '' -extends: '' +extends: diff --git a/SP-Framework/sp-application-base/baseapplication.yml b/SP-Framework/sp-application-base/baseapplication.yml index 36107657..ae21a86f 100644 --- a/SP-Framework/sp-application-base/baseapplication.yml +++ b/SP-Framework/sp-application-base/baseapplication.yml @@ -50,7 +50,7 @@ properties: syntax: content: 'protected readonly context: BaseApplicationContext;' return: - type: '' + type: - name: domElement uid: '@microsoft/sp-application-base!BaseApplication#domElement:member' package: '@microsoft/sp-application-base!' @@ -73,4 +73,4 @@ properties: protected set domElement(value: HTMLDivElement); return: type: HTMLDivElement -extends: '' +extends: diff --git a/SP-Framework/sp-application-base/baseapplicationcontext.yml b/SP-Framework/sp-application-base/baseapplicationcontext.yml index bb6dad79..419a6119 100644 --- a/SP-Framework/sp-application-base/baseapplicationcontext.yml +++ b/SP-Framework/sp-application-base/baseapplicationcontext.yml @@ -22,7 +22,7 @@ properties: syntax: content: 'get chrome(): _ISPPageChrome | undefined;' return: - type: ' | undefined' + type: | undefined - name: loadType uid: '@microsoft/sp-application-base!BaseApplicationContext#loadType:member' package: '@microsoft/sp-application-base!' @@ -34,7 +34,7 @@ properties: syntax: content: 'get loadType(): ApplicationLoadType;' return: - type: '' + type: - name: navigator uid: '@microsoft/sp-application-base!BaseApplicationContext#navigator:member' package: '@microsoft/sp-application-base!' @@ -46,7 +46,7 @@ properties: syntax: content: 'get navigator(): Navigator | undefined;' return: - type: ' | undefined' + type: | undefined - name: prefetchedDataEvent uid: '@microsoft/sp-application-base!BaseApplicationContext#prefetchedDataEvent:member' package: '@microsoft/sp-application-base!' @@ -72,7 +72,7 @@ properties: syntax: content: 'get preloadedData(): _IPreloadedData;' return: - type: '' + type: - name: suiteNavManager uid: '@microsoft/sp-application-base!BaseApplicationContext#suiteNavManager:member' package: '@microsoft/sp-application-base!' @@ -86,5 +86,5 @@ properties: syntax: content: 'get suiteNavManager(): ISuiteNavManager | undefined;' return: - type: ' | undefined' -extends: '' + type: | undefined +extends: diff --git a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml index c8060615..f103f28c 100644 --- a/SP-Framework/sp-application-base/baseapplicationcustomizer.yml +++ b/SP-Framework/sp-application-base/baseapplicationcustomizer.yml @@ -41,7 +41,7 @@ properties: syntax: content: 'protected readonly context: ApplicationCustomizerContext;' return: - type: '' + type: methods: - name: dispose() uid: '@microsoft/sp-application-base!BaseApplicationCustomizer#dispose:member(1)' @@ -73,8 +73,8 @@ methods: parameters: - id: placeholderProvider description: '' - type: '' + type: return: type: void description: '' -extends: '<TProperties>' +extends: <TProperties> diff --git a/SP-Framework/sp-application-base/placeholdercontent.yml b/SP-Framework/sp-application-base/placeholdercontent.yml index b77fa17a..5f027264 100644 --- a/SP-Framework/sp-application-base/placeholdercontent.yml +++ b/SP-Framework/sp-application-base/placeholdercontent.yml @@ -68,7 +68,7 @@ properties: syntax: content: 'get name(): PlaceholderName;' return: - type: '' + type: methods: - name: dispose() uid: '@microsoft/sp-application-base!PlaceholderContent#dispose:member(1)' diff --git a/SP-Framework/sp-application-base/placeholderprovider.yml b/SP-Framework/sp-application-base/placeholderprovider.yml index 80f20b21..61e2143c 100644 --- a/SP-Framework/sp-application-base/placeholderprovider.yml +++ b/SP-Framework/sp-application-base/placeholderprovider.yml @@ -50,7 +50,7 @@ properties: syntax: content: 'get placeholderNames(): ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: ReadonlyArray<> methods: - name: dispose() uid: '@microsoft/sp-application-base!PlaceholderProvider#dispose:member(1)' @@ -65,10 +65,10 @@ methods: return: type: void description: '' - - name: 'tryCreateContent(name, options)' + - name: tryCreateContent(name, options) uid: '@microsoft/sp-application-base!PlaceholderProvider#tryCreateContent:member(1)' package: '@microsoft/sp-application-base!' - fullName: 'tryCreateContent(name, options)' + fullName: tryCreateContent(name, options) summary: >- Tests whether the page contains the specified placeholder. If so, a new PlaceholderContent object is created, which allows the caller to render custom content inside the placeholder. @@ -85,13 +85,13 @@ methods: parameters: - id: name description: The requested placeholder - type: '' + type: - id: options - description: 'Additional options, for example to detect when the placeholder is disposed.' - type: '' + description: Additional options, for example to detect when the placeholder is disposed. + type: return: - type: ' | undefined' - description: 'A new PlaceholderContent object, or undefined if the requested placeholder does not exist.' + type: | undefined + description: A new PlaceholderContent object, or undefined if the requested placeholder does not exist. events: - name: changedEvent uid: '@microsoft/sp-application-base!PlaceholderProvider#changedEvent:member' diff --git a/SP-Framework/sp-component-base/basecomponent.yml b/SP-Framework/sp-component-base/basecomponent.yml index e7dfcc92..2fd279c1 100644 --- a/SP-Framework/sp-component-base/basecomponent.yml +++ b/SP-Framework/sp-component-base/basecomponent.yml @@ -40,7 +40,7 @@ properties: syntax: content: 'protected context?: BaseComponentContext;' return: - type: '' + type: - name: instanceId uid: '@microsoft/sp-component-base!BaseComponent#instanceId:member' package: '@microsoft/sp-component-base!' @@ -79,7 +79,7 @@ properties: syntax: content: 'get manifest(): IClientSideComponentManifest;' return: - type: '' + type: methods: - name: dispose() uid: '@microsoft/sp-component-base!BaseComponent#dispose:member(1)' diff --git a/SP-Framework/sp-component-base/basecomponentcontext.yml b/SP-Framework/sp-component-base/basecomponentcontext.yml index 6885bd65..1a825374 100644 --- a/SP-Framework/sp-component-base/basecomponentcontext.yml +++ b/SP-Framework/sp-component-base/basecomponentcontext.yml @@ -27,7 +27,7 @@ properties: syntax: content: 'get aadHttpClientFactory(): AadHttpClientFactory;' return: - type: '' + type: - name: aadTokenProviderFactory uid: '@microsoft/sp-component-base!BaseComponentContext#aadTokenProviderFactory:member' package: '@microsoft/sp-component-base!' @@ -39,7 +39,7 @@ properties: syntax: content: 'get aadTokenProviderFactory(): AadTokenProviderFactory;' return: - type: '' + type: - name: dynamicDataProvider uid: '@microsoft/sp-component-base!BaseComponentContext#dynamicDataProvider:member' package: '@microsoft/sp-component-base!' @@ -51,7 +51,7 @@ properties: syntax: content: 'get dynamicDataProvider(): DynamicDataProvider;' return: - type: '' + type: - name: dynamicDataSourceManager uid: '@microsoft/sp-component-base!BaseComponentContext#dynamicDataSourceManager:member' package: '@microsoft/sp-component-base!' @@ -63,7 +63,7 @@ properties: syntax: content: 'get dynamicDataSourceManager(): DynamicDataSourceManager;' return: - type: '' + type: - name: httpClient uid: '@microsoft/sp-component-base!BaseComponentContext#httpClient:member' package: '@microsoft/sp-component-base!' @@ -75,7 +75,7 @@ properties: syntax: content: 'get httpClient(): HttpClient;' return: - type: '' + type: - name: instanceId uid: '@microsoft/sp-component-base!BaseComponentContext#instanceId:member' package: '@microsoft/sp-component-base!' @@ -126,7 +126,7 @@ properties: syntax: content: 'readonly manifest: IClientSideComponentManifest;' return: - type: '' + type: - name: msGraphClientFactory uid: '@microsoft/sp-component-base!BaseComponentContext#msGraphClientFactory:member' package: '@microsoft/sp-component-base!' @@ -138,7 +138,7 @@ properties: syntax: content: 'get msGraphClientFactory(): MSGraphClientFactory;' return: - type: '' + type: - name: pageContext uid: '@microsoft/sp-component-base!BaseComponentContext#pageContext:member' package: '@microsoft/sp-component-base!' @@ -152,19 +152,19 @@ properties: syntax: content: 'get pageContext(): PageContext;' return: - type: '' + type: - name: serviceScope uid: '@microsoft/sp-component-base!BaseComponentContext#serviceScope:member' package: '@microsoft/sp-component-base!' fullName: serviceScope - summary: 'The associated [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) for this component.' + summary: The associated [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) for this component. remarks: A child service scope is created for each client-side component. isPreview: false isDeprecated: false syntax: content: 'get serviceScope(): ServiceScope;' return: - type: '' + type: - name: spHttpClient uid: '@microsoft/sp-component-base!BaseComponentContext#spHttpClient:member' package: '@microsoft/sp-component-base!' @@ -176,7 +176,7 @@ properties: syntax: content: 'get spHttpClient(): SPHttpClient;' return: - type: '' + type: methods: - name: dispose() uid: '@microsoft/sp-component-base!BaseComponentContext#dispose:member(1)' diff --git a/SP-Framework/sp-component-base/dynamicdataprovider.yml b/SP-Framework/sp-component-base/dynamicdataprovider.yml index e71293e0..85fa4014 100644 --- a/SP-Framework/sp-component-base/dynamicdataprovider.yml +++ b/SP-Framework/sp-component-base/dynamicdataprovider.yml @@ -48,7 +48,7 @@ methods: syntax: content: 'getAvailableSources(): ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: ReadonlyArray<> description: Read-only array with all available sources. - name: registerAvailableSourcesChanged(callback) uid: '@microsoft/sp-component-base!DynamicDataProvider#registerAvailableSourcesChanged:member(1)' @@ -67,10 +67,10 @@ methods: return: type: void description: '' - - name: 'registerPropertyChanged(sourceId, propertyId, callback)' + - name: registerPropertyChanged(sourceId, propertyId, callback) uid: '@microsoft/sp-component-base!DynamicDataProvider#registerPropertyChanged:member(1)' package: '@microsoft/sp-component-base!' - fullName: 'registerPropertyChanged(sourceId, propertyId, callback)' + fullName: registerPropertyChanged(sourceId, propertyId, callback) summary: Registers a callback for updates when a property is changed in a Dynamic Data source. remarks: '' isPreview: false @@ -90,10 +90,10 @@ methods: return: type: void description: '' - - name: 'registerSourceChanged(sourceId, callback)' + - name: registerSourceChanged(sourceId, callback) uid: '@microsoft/sp-component-base!DynamicDataProvider#registerSourceChanged:member(1)' package: '@microsoft/sp-component-base!' - fullName: 'registerSourceChanged(sourceId, callback)' + fullName: registerSourceChanged(sourceId, callback) summary: >- Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source. @@ -116,7 +116,7 @@ methods: uid: '@microsoft/sp-component-base!DynamicDataProvider#tryGetSource:member(1)' package: '@microsoft/sp-component-base!' fullName: tryGetSource(id) - summary: 'Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.' + summary: Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined. remarks: '' isPreview: false isDeprecated: false @@ -127,7 +127,7 @@ methods: description: Id of the Dynamic Data Source. type: string return: - type: ' | undefined' + type: | undefined description: '' - name: unregisterAvailableSourcesChanged(callback) uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterAvailableSourcesChanged:member(1)' @@ -146,10 +146,10 @@ methods: return: type: void description: '' - - name: 'unregisterPropertyChanged(sourceId, propertyId, callback)' + - name: unregisterPropertyChanged(sourceId, propertyId, callback) uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterPropertyChanged:member(1)' package: '@microsoft/sp-component-base!' - fullName: 'unregisterPropertyChanged(sourceId, propertyId, callback)' + fullName: unregisterPropertyChanged(sourceId, propertyId, callback) summary: Unregisters a callback for updates when a property is changed in a Dynamic Data source. remarks: '' isPreview: false @@ -169,10 +169,10 @@ methods: return: type: void description: '' - - name: 'unregisterSourceChanged(sourceId, callback)' + - name: unregisterSourceChanged(sourceId, callback) uid: '@microsoft/sp-component-base!DynamicDataProvider#unregisterSourceChanged:member(1)' package: '@microsoft/sp-component-base!' - fullName: 'unregisterSourceChanged(sourceId, callback)' + fullName: unregisterSourceChanged(sourceId, callback) summary: Unregisters a callback for updates when a Dynamic Data source is changed. remarks: '' isPreview: false diff --git a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml index 24f4b636..3ede8c34 100644 --- a/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml +++ b/SP-Framework/sp-component-base/dynamicdatasourcemanager.yml @@ -65,7 +65,7 @@ methods: parameters: - id: callableFunctions description: Set of methods that are exposed through the Dynamic Data Source - type: '' + type: return: type: void description: '' @@ -124,7 +124,7 @@ methods: parameters: - id: metadata description: Partial of the metadata. - type: 'Partial<>' + type: Partial<> return: type: void description: '' diff --git a/SP-Framework/sp-component-base/dynamicproperty.yml b/SP-Framework/sp-component-base/dynamicproperty.yml index 71fb4558..c8beba36 100644 --- a/SP-Framework/sp-component-base/dynamicproperty.yml +++ b/SP-Framework/sp-component-base/dynamicproperty.yml @@ -12,10 +12,10 @@ isPreview: false isDeprecated: false type: class constructors: - - name: '(constructor)(provider, callback)' + - name: (constructor)(provider, callback) uid: '@microsoft/sp-component-base!DynamicProperty:constructor(1)' package: '@microsoft/sp-component-base!' - fullName: '(constructor)(provider, callback)' + fullName: (constructor)(provider, callback) summary: Create a new DynamicProperty object. remarks: '' isPreview: false @@ -25,7 +25,7 @@ constructors: parameters: - id: provider description: DynamicDataProvider. - type: '' + type: - id: callback description: Optional. Default callback to be registered for updates in the DynamicDataSource. type: () => void @@ -37,7 +37,7 @@ properties: 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.' + remarks: After the object has been disposed, do not call its methods or access its properties. isPreview: false isDeprecated: false syntax: @@ -51,7 +51,7 @@ properties: 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.' + remarks: If the DynamicProperty is set up with static data, this returns undefined. isPreview: false isDeprecated: false syntax: @@ -64,7 +64,7 @@ methods: package: '@microsoft/sp-component-base!' fullName: dispose() summary: This method is called to permanently dispose the object. - remarks: 'After the object has been disposed, do not call its methods or access its properties.' + remarks: After the object has been disposed, do not call its methods or access its properties. isPreview: false isDeprecated: false syntax: @@ -164,7 +164,7 @@ methods: syntax: content: 'tryGetSource(): IDynamicDataSource | undefined;' return: - type: ' | undefined' + type: | undefined description: '' - name: tryGetValue() uid: '@microsoft/sp-component-base!DynamicProperty#tryGetValue:member(1)' @@ -203,7 +203,7 @@ methods: syntax: content: 'tryGetValues(): TValue[];' return: - type: 'TValue[]' + type: TValue[] description: the value associated with the dynamic property or an empty array if the source or the data doesn't exist. - name: unregister(callback) uid: '@microsoft/sp-component-base!DynamicProperty#unregister:member(1)' diff --git a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml index bd6b246a..5d92da55 100644 --- a/SP-Framework/sp-component-base/ireadonlyfontstyles.yml +++ b/SP-Framework/sp-component-base/ireadonlyfontstyles.yml @@ -8,4 +8,4 @@ remarks: '' isPreview: false isDeprecated: false type: interface -extends: 'Readonly<>' +extends: Readonly<> diff --git a/SP-Framework/sp-component-base/ireadonlytheme.yml b/SP-Framework/sp-component-base/ireadonlytheme.yml index cd75c638..41cee94f 100644 --- a/SP-Framework/sp-component-base/ireadonlytheme.yml +++ b/SP-Framework/sp-component-base/ireadonlytheme.yml @@ -8,4 +8,4 @@ remarks: '' isPreview: false isDeprecated: false type: interface -extends: 'Readonly<>' +extends: Readonly<> diff --git a/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml b/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml index f3f3add1..bdad756f 100644 --- a/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml +++ b/SP-Framework/sp-component-base/iserializedserverprocesseddata.yml @@ -27,9 +27,6 @@ properties: { 'layoutComponent': 'abfccb4d-fcbc-4720-8bcc-6183ce66c391', 'dataComponent': 'f0baf432-de3f-4f0f-8444-d1280b2f8cc5' - } - - ``` isPreview: true isDeprecated: false syntax: @@ -67,10 +64,6 @@ properties: customMetadata: { 'myImage1': {'height': '100', 'width': '100'} 'myImage2': {'height': '400', 'width': '600'} - } - } - - ``` isPreview: true isDeprecated: false syntax: @@ -105,9 +98,6 @@ properties: { 'myRichDescription': '
Some standard HTML contentA Link
' 'anotherRichText':
Some red text
- } - - ``` isPreview: false isDeprecated: false syntax: @@ -134,8 +124,6 @@ properties: { 'myImage1': 'http://res.contoso.com/path/to/file' 'myImage2': 'https://res.contoso.com/someName.jpg' - } - ``` isPreview: false isDeprecated: false syntax: @@ -162,8 +150,6 @@ properties: { 'myWebURL': 'http://contoso.com' 'myFileLink': 'https://res.contoso.com/file.docx' - } - ``` isPreview: false isDeprecated: false syntax: @@ -194,9 +180,6 @@ properties: { 'justSomeText': 'This is some plain text', 'anotherText': 'Can have characters here: "<>&\'' - } - - ``` isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-component-base/itheme.yml b/SP-Framework/sp-component-base/itheme.yml index d425f70d..41f59c78 100644 --- a/SP-Framework/sp-component-base/itheme.yml +++ b/SP-Framework/sp-component-base/itheme.yml @@ -3,9 +3,9 @@ name: ITheme uid: '@microsoft/sp-component-base!ITheme:interface' package: '@microsoft/sp-component-base!' fullName: ITheme -summary: 'Collection of theme values, which can be used to programatically style components.' +summary: Collection of theme values, which can be used to programatically style components. remarks: '' isPreview: false isDeprecated: false type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-component-base/themechangedeventargs.yml b/SP-Framework/sp-component-base/themechangedeventargs.yml index c0152741..2580b7ae 100644 --- a/SP-Framework/sp-component-base/themechangedeventargs.yml +++ b/SP-Framework/sp-component-base/themechangedeventargs.yml @@ -13,14 +13,14 @@ properties: uid: '@microsoft/sp-component-base!ThemeChangedEventArgs#theme:member' package: '@microsoft/sp-component-base!' fullName: theme - summary: 'The new theme. If the value is undefined, then the theme was cleared.' + summary: The new theme. If the value is undefined, then the theme was cleared. remarks: '' isPreview: false isDeprecated: false syntax: content: 'readonly theme: ITheme | undefined;' return: - type: ' | undefined' + type: | undefined - name: themeV2 uid: '@microsoft/sp-component-base!ThemeChangedEventArgs#themeV2:member' package: '@microsoft/sp-component-base!' @@ -32,5 +32,5 @@ properties: syntax: content: 'readonly themeV2: Theme | undefined;' return: - type: ' | undefined' -extends: '' + type: | undefined +extends: diff --git a/SP-Framework/sp-component-base/themeprovider.yml b/SP-Framework/sp-component-base/themeprovider.yml index 6c01e2b1..77e9a3d0 100644 --- a/SP-Framework/sp-component-base/themeprovider.yml +++ b/SP-Framework/sp-component-base/themeprovider.yml @@ -11,10 +11,10 @@ isPreview: false isDeprecated: false type: class constructors: - - name: '(constructor)(serviceScope, theme, themeV2)' + - name: (constructor)(serviceScope, theme, themeV2) uid: '@microsoft/sp-component-base!ThemeProvider:constructor(1)' package: '@microsoft/sp-component-base!' - fullName: '(constructor)(serviceScope, theme, themeV2)' + fullName: (constructor)(serviceScope, theme, themeV2) summary: Construct a new instance of the ThemeProvider class. remarks: '' isPreview: false @@ -24,13 +24,13 @@ constructors: parameters: - id: serviceScope description: The current service scope. - type: '' + type: - id: theme description: Theme to provide. - type: '' + type: - id: themeV2 description: '' - type: '' + type: properties: - name: serviceKey uid: '@microsoft/sp-component-base!ThemeProvider.serviceKey:member' @@ -51,14 +51,14 @@ methods: uid: '@microsoft/sp-component-base!ThemeProvider#tryGetTheme:member(1)' package: '@microsoft/sp-component-base!' fullName: tryGetTheme() - summary: 'If set, get the current scoped theme.' + summary: If set, get the current scoped theme. remarks: '' isPreview: false isDeprecated: false syntax: content: 'tryGetTheme(): IReadonlyTheme | undefined;' return: - type: ' | undefined' + type: | undefined description: '' - name: tryGetThemeV2() uid: '@microsoft/sp-component-base!ThemeProvider#tryGetThemeV2:member(1)' @@ -71,7 +71,7 @@ methods: syntax: content: 'tryGetThemeV2(): Theme | undefined;' return: - type: ' | undefined' + type: | undefined description: '' events: - name: themeChangedEvent diff --git a/SP-Framework/sp-core-library/_isnever.yml b/SP-Framework/sp-core-library/_isnever.yml index 15a57173..01b2cf50 100644 --- a/SP-Framework/sp-core-library/_isnever.yml +++ b/SP-Framework/sp-core-library/_isnever.yml @@ -4,7 +4,7 @@ uid: '@microsoft/sp-core-library!_IsNever:type' package: '@microsoft/sp-core-library!' fullName: _IsNever summary: Utility type to check if `Type` is `never`. -remarks: 'Since `never` is an empty set, the brackets are used to disable distribution over the generic type argument.' +remarks: Since `never` is an empty set, the brackets are used to disable distribution over the generic type argument. isPreview: false isDeprecated: false syntax: 'export type _IsNever = [Type] extends [never] ? true : false;' diff --git a/SP-Framework/sp-core-library/_nextvalue.yml b/SP-Framework/sp-core-library/_nextvalue.yml index fb7001be..c1cc39ff 100644 --- a/SP-Framework/sp-core-library/_nextvalue.yml +++ b/SP-Framework/sp-core-library/_nextvalue.yml @@ -9,4 +9,4 @@ remarks: >- Therefore, indexing into `Set` with `Current`'s length yields the next value to evaluate. isPreview: false isDeprecated: false -syntax: 'export type _NextValue = Set[Current[''length'']];' +syntax: export type _NextValue = Set[Current['length']]; diff --git a/SP-Framework/sp-core-library/_stop.yml b/SP-Framework/sp-core-library/_stop.yml index ccf7fdca..1a0cc82d 100644 --- a/SP-Framework/sp-core-library/_stop.yml +++ b/SP-Framework/sp-core-library/_stop.yml @@ -4,7 +4,7 @@ uid: '@microsoft/sp-core-library!_Stop:type' package: '@microsoft/sp-core-library!' fullName: _Stop summary: Utility type to evaluate if a recursive conditional evaluation should stop. -remarks: 'If `Set` and `Current` are the same length, then all values have been recursed upon.' +remarks: If `Set` and `Current` are the same length, then all values have been recursed upon. isPreview: false isDeprecated: false syntax: >- diff --git a/SP-Framework/sp-core-library/environment.yml b/SP-Framework/sp-core-library/environment.yml index 63f3feaf..be91d10a 100644 --- a/SP-Framework/sp-core-library/environment.yml +++ b/SP-Framework/sp-core-library/environment.yml @@ -20,4 +20,4 @@ properties: syntax: content: 'static get type(): EnvironmentType;' return: - type: '' + type: diff --git a/SP-Framework/sp-core-library/extractfromset.yml b/SP-Framework/sp-core-library/extractfromset.yml index 4c24b227..3f4712d9 100644 --- a/SP-Framework/sp-core-library/extractfromset.yml +++ b/SP-Framework/sp-core-library/extractfromset.yml @@ -7,4 +7,4 @@ summary: Utility type to extract `Type` from `Set` if and only if `Type` is in ` remarks: If `Type` is not within `Set` then `never` is assigned. isPreview: false isDeprecated: false -syntax: 'export type ExtractFromSet = _RecursivelyExtractFromSet;' +syntax: export type ExtractFromSet = _RecursivelyExtractFromSet; diff --git a/SP-Framework/sp-core-library/guid.yml b/SP-Framework/sp-core-library/guid.yml index 23049428..63b03944 100644 --- a/SP-Framework/sp-core-library/guid.yml +++ b/SP-Framework/sp-core-library/guid.yml @@ -3,7 +3,7 @@ name: Guid uid: '@microsoft/sp-core-library!Guid:class' package: '@microsoft/sp-core-library!' fullName: Guid -summary: 'This class represents a globally unique identifier, as described by IETF RFC 4122.' +summary: This class represents a globally unique identifier, as described by IETF RFC 4122. remarks: >- The input string is normalized and validated, which provides important guarantees that simplify other code that works with the GUID. This class also provides basic support for generating a pseudo-random GUID; however, be aware that the @@ -26,7 +26,7 @@ properties: syntax: content: 'static readonly empty: Guid;' return: - type: '' + type: methods: - name: equals(guid) uid: '@microsoft/sp-core-library!Guid#equals:member(1)' @@ -41,7 +41,7 @@ methods: parameters: - id: guid description: '' - type: '' + type: return: type: boolean description: True if this instance and the specified Guid object represent the same value. @@ -63,7 +63,7 @@ methods: type: string | undefined | null return: type: boolean - description: 'true, if the Guid is valid.' + description: true, if the Guid is valid. - name: newGuid(randomNumberGenerator) uid: '@microsoft/sp-core-library!Guid.newGuid:member(1)' package: '@microsoft/sp-core-library!' @@ -79,15 +79,15 @@ methods: parameters: - id: randomNumberGenerator description: '' - type: '' + type: return: - type: '' + type: description: A new unique Guid object - name: parse(guidString) uid: '@microsoft/sp-core-library!Guid.parse:member(1)' package: '@microsoft/sp-core-library!' fullName: parse(guidString) - summary: 'Parses the input string to construct a new Guid object. If the string cannot be parsed, then an error is thrown.' + 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: @@ -107,7 +107,7 @@ methods: description: The input string. type: string | undefined | null return: - type: '' + type: description: A valid Guid object - name: toString() uid: '@microsoft/sp-core-library!Guid#toString:member(1)' @@ -151,5 +151,5 @@ methods: description: The input string. type: string | undefined | null return: - type: ' | undefined' - description: 'The Guid object, or undefined if the string could not be parsed.' + type: | undefined + description: The Guid object, or undefined if the string could not be parsed. diff --git a/SP-Framework/sp-core-library/idisposable.yml b/SP-Framework/sp-core-library/idisposable.yml index 2fd58909..9163d714 100644 --- a/SP-Framework/sp-core-library/idisposable.yml +++ b/SP-Framework/sp-core-library/idisposable.yml @@ -16,7 +16,7 @@ properties: 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.' + remarks: After the object has been disposed, do not call its methods or access its properties. isPreview: false isDeprecated: false syntax: @@ -29,7 +29,7 @@ methods: package: '@microsoft/sp-core-library!' fullName: dispose() summary: This method is called to permanently dispose the object. - remarks: 'After the object has been disposed, do not call its methods or access its properties.' + remarks: After the object has been disposed, do not call its methods or access its properties. isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-core-library/iloghandler.yml b/SP-Framework/sp-core-library/iloghandler.yml index 0253ba18..75852c01 100644 --- a/SP-Framework/sp-core-library/iloghandler.yml +++ b/SP-Framework/sp-core-library/iloghandler.yml @@ -9,10 +9,10 @@ isPreview: true isDeprecated: false type: interface methods: - - name: 'error(source, error, scope)' + - name: error(source, error, scope) uid: '@microsoft/sp-core-library!ILogHandler#error:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'error(source, error, scope)' + fullName: error(source, error, scope) summary: '' remarks: '' isPreview: true @@ -28,14 +28,14 @@ methods: type: Error - id: scope description: '' - type: ' | undefined' + type: | undefined return: type: void description: '' - - name: 'info(source, message, scope)' + - name: info(source, message, scope) uid: '@microsoft/sp-core-library!ILogHandler#info:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'info(source, message, scope)' + fullName: info(source, message, scope) summary: '' remarks: '' isPreview: true @@ -51,14 +51,14 @@ methods: type: string - id: scope description: '' - type: ' | undefined' + type: | undefined return: type: void description: '' - - name: 'verbose(source, message, scope)' + - name: verbose(source, message, scope) uid: '@microsoft/sp-core-library!ILogHandler#verbose:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'verbose(source, message, scope)' + fullName: verbose(source, message, scope) summary: '' remarks: '' isPreview: true @@ -74,14 +74,14 @@ methods: type: string - id: scope description: '' - type: ' | undefined' + type: | undefined return: type: void description: '' - - name: 'warn(source, message, scope)' + - name: warn(source, message, scope) uid: '@microsoft/sp-core-library!ILogHandler#warn:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'warn(source, message, scope)' + fullName: warn(source, message, scope) summary: '' remarks: '' isPreview: true @@ -97,7 +97,7 @@ methods: type: string - id: scope description: '' - type: ' | undefined' + type: | undefined return: type: void description: '' diff --git a/SP-Framework/sp-core-library/irandomnumbergenerator.yml b/SP-Framework/sp-core-library/irandomnumbergenerator.yml index efc147ed..fb3dd2f1 100644 --- a/SP-Framework/sp-core-library/irandomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/irandomnumbergenerator.yml @@ -20,7 +20,7 @@ methods: uid: '@microsoft/sp-core-library!IRandomNumberGenerator#generate:member(1)' package: '@microsoft/sp-core-library!' fullName: generate() - summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' + summary: Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random(). remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-core-library/iservicecollection.yml b/SP-Framework/sp-core-library/iservicecollection.yml index fac83653..2de47842 100644 --- a/SP-Framework/sp-core-library/iservicecollection.yml +++ b/SP-Framework/sp-core-library/iservicecollection.yml @@ -23,4 +23,4 @@ properties: syntax: content: 'readonly serviceScope: ServiceScope;' return: - type: '' + type: diff --git a/SP-Framework/sp-core-library/iservicekey.yml b/SP-Framework/sp-core-library/iservicekey.yml index 4a9639a1..6bae7956 100644 --- a/SP-Framework/sp-core-library/iservicekey.yml +++ b/SP-Framework/sp-core-library/iservicekey.yml @@ -26,7 +26,7 @@ properties: syntax: content: 'readonly defaultCreator: ServiceCreator;' return: - type: '<T>' + type: <T> - name: id uid: '@microsoft/sp-core-library!IServiceKey#id:member' package: '@microsoft/sp-core-library!' diff --git a/SP-Framework/sp-core-library/iservicescope.yml b/SP-Framework/sp-core-library/iservicescope.yml index 8e18fce2..4dac03ae 100644 --- a/SP-Framework/sp-core-library/iservicescope.yml +++ b/SP-Framework/sp-core-library/iservicescope.yml @@ -63,14 +63,14 @@ methods: parameters: - id: serviceKey description: the key that was used when provide() was called to register the service - type: '<T>' + type: <T> return: type: T description: the service instance - - name: 'createAndProvide(serviceKey, simpleServiceClass)' + - name: createAndProvide(serviceKey, simpleServiceClass) uid: '@microsoft/sp-core-library!IServiceScope#createAndProvide:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'createAndProvide(serviceKey, simpleServiceClass)' + fullName: createAndProvide(serviceKey, simpleServiceClass) summary: >- This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then registering it by calling ServiceScope.provide(). @@ -85,7 +85,7 @@ methods: parameters: - id: serviceKey description: the key that can be used later to consume the service - type: '<T>' + type: <T> - id: simpleServiceClass description: the TypeScript class to be constructed type: |- @@ -110,7 +110,7 @@ methods: parameters: - id: serviceKey description: the key that can be used later to consume the service - type: '<T>' + type: <T> return: type: T description: a service instance that was constructed using ServiceKey.defaultCreator @@ -140,19 +140,19 @@ methods: uid: '@microsoft/sp-core-library!IServiceScope#getParent:member(1)' package: '@microsoft/sp-core-library!' fullName: getParent() - summary: 'Returns the parent of the current ServiceScope, or undefined if this is a root scope.' + summary: Returns the parent of the current ServiceScope, or undefined if this is a root scope. remarks: '' isPreview: false isDeprecated: false syntax: content: 'getParent(): IServiceScope | undefined;' return: - type: ' | undefined' + type: | undefined description: the parent service scope - - name: 'provide(serviceKey, service)' + - name: provide(serviceKey, service) uid: '@microsoft/sp-core-library!IServiceScope#provide:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'provide(serviceKey, service)' + fullName: provide(serviceKey, service) summary: Add a new service to a service scope. remarks: >- ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope, and an @@ -165,7 +165,7 @@ methods: parameters: - id: serviceKey description: the key that will later be used to consume the service - type: '<T>' + type: <T> - id: service description: the service instance that is being registered type: T @@ -185,7 +185,7 @@ methods: syntax: content: 'startNewChild(): IServiceScope;' return: - type: '' + type: description: the newly created root ServiceScope - name: whenFinished(callback) uid: '@microsoft/sp-core-library!IServiceScope#whenFinished:member(1)' diff --git a/SP-Framework/sp-core-library/ispeventobserver.yml b/SP-Framework/sp-core-library/ispeventobserver.yml index a6b3b32e..4714e8c2 100644 --- a/SP-Framework/sp-core-library/ispeventobserver.yml +++ b/SP-Framework/sp-core-library/ispeventobserver.yml @@ -19,8 +19,8 @@ properties: uid: '@microsoft/sp-core-library!ISPEventObserver#componentId:member' package: '@microsoft/sp-core-library!' fullName: componentId - summary: 'The component identifier, from the component''s manifest.' - remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' + summary: The component identifier, from the component's manifest. + remarks: This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception isPreview: false isDeprecated: false syntax: @@ -32,11 +32,11 @@ properties: package: '@microsoft/sp-core-library!' fullName: instanceId summary: The instance identifier for the component. - remarks: 'This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception' + remarks: This will be used for diagnostic reporting, e.g. if the callback function has an uncaught exception isPreview: false isDeprecated: false syntax: content: 'readonly instanceId: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-core-library/itimeprovider.yml b/SP-Framework/sp-core-library/itimeprovider.yml index 993757e7..b24b7bf3 100644 --- a/SP-Framework/sp-core-library/itimeprovider.yml +++ b/SP-Framework/sp-core-library/itimeprovider.yml @@ -3,7 +3,7 @@ name: ITimeProvider uid: '@microsoft/sp-core-library!ITimeProvider:interface' package: '@microsoft/sp-core-library!' fullName: ITimeProvider -summary: 'This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) contract for reading the system clock.' +summary: This is a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class) contract for reading the system clock. remarks: >- This interface abstracts the functionality of the system time APIs for usage with a [ServiceScope](xref:@microsoft/sp-core-library!ServiceScope:class). For example, a unit test might replace the @@ -17,7 +17,7 @@ methods: uid: '@microsoft/sp-core-library!ITimeProvider#getDate:member(1)' package: '@microsoft/sp-core-library!' fullName: getDate() - summary: 'Returns the current date/time, similar to the Date class constructor.' + summary: Returns the current date/time, similar to the Date class constructor. remarks: '' isPreview: false isDeprecated: false @@ -30,7 +30,7 @@ methods: uid: '@microsoft/sp-core-library!ITimeProvider#getTimestamp:member(1)' package: '@microsoft/sp-core-library!' fullName: getTimestamp() - summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' + summary: Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-core-library/log.yml b/SP-Framework/sp-core-library/log.yml index 165c3bdf..986fe450 100644 --- a/SP-Framework/sp-core-library/log.yml +++ b/SP-Framework/sp-core-library/log.yml @@ -12,10 +12,10 @@ isPreview: false isDeprecated: false type: class methods: - - name: 'error(source, error, scope)' + - name: error(source, error, scope) uid: '@microsoft/sp-core-library!Log.error:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'error(source, error, scope)' + fullName: error(source, error, scope) summary: Logs an error. remarks: '' isPreview: false @@ -35,14 +35,14 @@ methods: 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: '' + type: return: type: void description: '' - - name: 'info(source, message, scope)' + - name: info(source, message, scope) uid: '@microsoft/sp-core-library!Log.info:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'info(source, message, scope)' + fullName: info(source, message, scope) summary: Logs a general informational message. remarks: '' isPreview: false @@ -56,20 +56,20 @@ methods: for the logged message. If the source's length is more than 20, only the first 20 characters are kept. type: string - id: message - description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' + description: the message to be logged If the message's length is more than 100, only the first 100 characters are kept. type: string - id: scope description: >- the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message. - type: '' + type: return: type: void description: '' - - name: 'verbose(source, message, scope)' + - name: verbose(source, message, scope) uid: '@microsoft/sp-core-library!Log.verbose:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'verbose(source, message, scope)' + fullName: verbose(source, message, scope) summary: Logs a message which contains detailed information that is generally only needed for troubleshooting. remarks: '' isPreview: false @@ -83,20 +83,20 @@ methods: for the logged message. If the source's length is more than 20, only the first 20 characters are kept. type: string - id: message - description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' + description: the message to be logged If the message's length is more than 100, only the first 100 characters are kept. type: string - id: scope description: >- the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message. - type: '' + type: return: type: void description: '' - - name: 'warn(source, message, scope)' + - name: warn(source, message, scope) uid: '@microsoft/sp-core-library!Log.warn:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'warn(source, message, scope)' + fullName: warn(source, message, scope) summary: Logs a warning. remarks: '' isPreview: false @@ -110,13 +110,13 @@ methods: for the logged message. If the source's length is more than 20, only the first 20 characters are kept. type: string - id: message - description: 'the message to be logged If the message''s length is more than 100, only the first 100 characters are kept.' + description: the message to be logged If the message's length is more than 100, only the first 100 characters are kept. type: string - id: scope description: >- the service scope that the source uses. A service scope can provide more context information (e.g., web part information) to the logged message. - type: '' + type: return: type: void description: '' diff --git a/SP-Framework/sp-core-library/randomnumbergenerator.yml b/SP-Framework/sp-core-library/randomnumbergenerator.yml index 2b0af08d..bd9d7117 100644 --- a/SP-Framework/sp-core-library/randomnumbergenerator.yml +++ b/SP-Framework/sp-core-library/randomnumbergenerator.yml @@ -25,7 +25,7 @@ constructors: parameters: - id: serviceScope description: '' - type: '' + type: properties: - name: serviceKey uid: '@microsoft/sp-core-library!RandomNumberGenerator.serviceKey:member' @@ -46,7 +46,7 @@ methods: uid: '@microsoft/sp-core-library!RandomNumberGenerator#generate:member(1)' package: '@microsoft/sp-core-library!' fullName: generate() - summary: 'Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random().' + summary: Returns a pseudorandom number between 0 (inclusive) and 1 (exclusive), following the contract of Math.random(). remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-core-library/rootservicekey.yml b/SP-Framework/sp-core-library/rootservicekey.yml index 226129a2..6d28a727 100644 --- a/SP-Framework/sp-core-library/rootservicekey.yml +++ b/SP-Framework/sp-core-library/rootservicekey.yml @@ -14,4 +14,4 @@ remarks: >- isPreview: true isDeprecated: false type: class -extends: '<T>' +extends: <T> diff --git a/SP-Framework/sp-core-library/servicekey.yml b/SP-Framework/sp-core-library/servicekey.yml index 879025a9..8cb5702f 100644 --- a/SP-Framework/sp-core-library/servicekey.yml +++ b/SP-Framework/sp-core-library/servicekey.yml @@ -15,10 +15,10 @@ isPreview: false isDeprecated: false type: class constructors: - - name: '(constructor)(id, name, defaultCreator)' + - name: (constructor)(id, name, defaultCreator) uid: '@microsoft/sp-core-library!ServiceKey:constructor(1)' package: '@microsoft/sp-core-library!' - fullName: '(constructor)(id, name, defaultCreator)' + fullName: (constructor)(id, name, defaultCreator) summary: Constructs a new instance of the `ServiceKey` class remarks: '' isPreview: false @@ -34,7 +34,7 @@ constructors: type: string - id: defaultCreator description: '' - type: '<T>' + type: <T> properties: - name: defaultCreator uid: '@microsoft/sp-core-library!ServiceKey#defaultCreator:member' @@ -47,7 +47,7 @@ properties: syntax: content: 'readonly defaultCreator: ServiceCreator;' return: - type: '<T>' + type: <T> - name: id uid: '@microsoft/sp-core-library!ServiceKey#id:member' package: '@microsoft/sp-core-library!' @@ -89,10 +89,10 @@ properties: return: type: string methods: - - name: 'create(name, serviceClass)' + - name: create(name, serviceClass) uid: '@microsoft/sp-core-library!ServiceKey.create:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'create(name, serviceClass)' + fullName: create(name, serviceClass) summary: >- Constructs a new ServiceKey whose default implementation will be a new instance of a TypeScript class that accepts the standard constructor parameter. @@ -109,14 +109,14 @@ methods: type: string - id: serviceClass description: the TypeScript class that implements the service. - type: '<TKey>' + type: <TKey> return: - type: '<TKey>' + type: <TKey> description: the newly created ServiceKey - - name: 'createCustom(name, defaultCreator)' + - name: createCustom(name, defaultCreator) uid: '@microsoft/sp-core-library!ServiceKey.createCustom:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'createCustom(name, defaultCreator)' + fullName: createCustom(name, defaultCreator) summary: Constructs a new ServiceKey whose default implementation will be obtained by invoking the specified callback. remarks: '' isPreview: false @@ -129,7 +129,7 @@ methods: type: string - id: defaultCreator description: a callback that returns an object that implements the T interface - type: '<TKey>' + type: <TKey> return: - type: '<TKey>' + type: <TKey> description: the newly created service key diff --git a/SP-Framework/sp-core-library/servicescope.yml b/SP-Framework/sp-core-library/servicescope.yml index 1a1d51ce..3dc09548 100644 --- a/SP-Framework/sp-core-library/servicescope.yml +++ b/SP-Framework/sp-core-library/servicescope.yml @@ -60,7 +60,7 @@ constructors: parameters: - id: parent description: '' - type: ' | undefined' + type: | undefined methods: - name: consume(serviceKey) uid: '@microsoft/sp-core-library!ServiceScope#consume:member(1)' @@ -78,14 +78,14 @@ methods: parameters: - id: serviceKey description: the key that was used when provide() was called to register the service - type: '<T>' + type: <T> return: type: T description: the service instance - - name: 'createAndProvide(serviceKey, simpleServiceClass)' + - name: createAndProvide(serviceKey, simpleServiceClass) uid: '@microsoft/sp-core-library!ServiceScope#createAndProvide:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'createAndProvide(serviceKey, simpleServiceClass)' + fullName: createAndProvide(serviceKey, simpleServiceClass) summary: >- This is a shorthand function that is equivalent to constructing a new instance of the simpleServiceClass, then registering it by calling ServiceScope.provide(). @@ -97,10 +97,10 @@ methods: parameters: - id: serviceKey description: the key that can be used later to consume the service - type: '<T>' + type: <T> - id: simpleServiceClass description: the TypeScript class to be constructed - type: '<T>' + type: <T> return: type: T description: a newly constructed instance of simpleServiceClass @@ -119,7 +119,7 @@ methods: parameters: - id: serviceKey description: the key that can be used later to consume the service - type: '<T>' + type: <T> return: type: T description: a service instance that was constructed using ServiceKey.defaultCreator @@ -149,19 +149,19 @@ methods: uid: '@microsoft/sp-core-library!ServiceScope#getParent:member(1)' package: '@microsoft/sp-core-library!' fullName: getParent() - summary: 'Returns the parent of the current ServiceScope, or undefined if this is a root scope.' + summary: Returns the parent of the current ServiceScope, or undefined if this is a root scope. remarks: '' isPreview: false isDeprecated: false syntax: content: 'getParent(): ServiceScope | undefined;' return: - type: ' | undefined' + type: | undefined description: the parent service scope - - name: 'provide(serviceKey, service)' + - name: provide(serviceKey, service) uid: '@microsoft/sp-core-library!ServiceScope#provide:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'provide(serviceKey, service)' + fullName: provide(serviceKey, service) summary: Add a new service to a service scope. remarks: >- ServiceScope.provide() is used to register an implementation of the given serviceKey for the current scope, and an @@ -174,7 +174,7 @@ methods: parameters: - id: serviceKey description: the key that will later be used to consume the service - type: '<T>' + type: <T> - id: service description: the service instance that is being registered type: T @@ -194,7 +194,7 @@ methods: syntax: content: 'startNewChild(): ServiceScope;' return: - type: '' + type: description: the newly created root ServiceScope - name: startNewRoot() uid: '@microsoft/sp-core-library!ServiceScope.startNewRoot:member(1)' @@ -209,7 +209,7 @@ methods: syntax: content: 'static startNewRoot(): ServiceScope;' return: - type: '' + type: description: the newly created root ServiceScope - name: whenFinished(callback) uid: '@microsoft/sp-core-library!ServiceScope#whenFinished:member(1)' diff --git a/SP-Framework/sp-core-library/session.yml b/SP-Framework/sp-core-library/session.yml index 2d3f7ee7..9066dbf4 100644 --- a/SP-Framework/sp-core-library/session.yml +++ b/SP-Framework/sp-core-library/session.yml @@ -25,7 +25,7 @@ properties: syntax: content: 'static get applicationId(): Guid;' return: - type: '' + type: - name: clientSideApplicationId uid: '@microsoft/sp-core-library!Session.clientSideApplicationId:member' package: '@microsoft/sp-core-library!' @@ -62,4 +62,4 @@ properties: syntax: content: 'static get pageId(): Guid;' return: - type: '' + type: diff --git a/SP-Framework/sp-core-library/sperror.yml b/SP-Framework/sp-core-library/sperror.yml index adba18da..54c275e7 100644 --- a/SP-Framework/sp-core-library/sperror.yml +++ b/SP-Framework/sp-core-library/sperror.yml @@ -21,10 +21,10 @@ isPreview: true isDeprecated: false type: class constructors: - - name: '(constructor)(errorCode, message, logProperties)' + - name: (constructor)(errorCode, message, logProperties) uid: '@microsoft/sp-core-library!SPError:constructor(1)' package: '@microsoft/sp-core-library!' - fullName: '(constructor)(errorCode, message, logProperties)' + fullName: (constructor)(errorCode, message, logProperties) summary: Constructor for the SPError class. remarks: '' isPreview: true diff --git a/SP-Framework/sp-core-library/spevent.yml b/SP-Framework/sp-core-library/spevent.yml index bfadd94c..370ce14c 100644 --- a/SP-Framework/sp-core-library/spevent.yml +++ b/SP-Framework/sp-core-library/spevent.yml @@ -26,10 +26,10 @@ isPreview: false isDeprecated: false type: class methods: - - name: 'add(observer, eventHandler)' + - name: add(observer, eventHandler) uid: '@microsoft/sp-core-library!SPEvent#add:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'add(observer, eventHandler)' + fullName: add(observer, eventHandler) summary: Registers a callback that will be invoked whenever the event occurs. remarks: >- The same object can add multiple event handlers to the same event. Since BaseComponent implements the @@ -45,19 +45,19 @@ methods: Indicates the object that is subscribing to the event: When the object is disposed, the event handler will be automatically removed. This object is also used for diagnostic purposes, e.g. detecting if the event handler failed to catch an exception. - type: '' + type: - id: eventHandler description: A callback function that will be invoked whenever the event occurs type: '(eventArgs: TEventArgs) => void' return: type: void description: '' - - name: 'remove(observer, eventHandler)' + - name: remove(observer, eventHandler) uid: '@microsoft/sp-core-library!SPEvent#remove:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'remove(observer, eventHandler)' + fullName: remove(observer, eventHandler) summary: Unregisters a callback that was registered using add(). - remarks: 'If the event handler has already been removed, or if it was never added, then this method has no effect.' + remarks: If the event handler has already been removed, or if it was never added, then this method has no effect. isPreview: false isDeprecated: false syntax: @@ -65,7 +65,7 @@ methods: parameters: - id: observer description: This must be the same observer that was passed to the add() function. - type: '' + type: - id: eventHandler description: The event handler to remove; this must be the same object instance that was passed to the add() function. type: '(eventArgs: TEventArgs) => void' diff --git a/SP-Framework/sp-core-library/speventargs.yml b/SP-Framework/sp-core-library/speventargs.yml index e131601d..8ca6fbf6 100644 --- a/SP-Framework/sp-core-library/speventargs.yml +++ b/SP-Framework/sp-core-library/speventargs.yml @@ -3,8 +3,8 @@ name: SPEventArgs uid: '@microsoft/sp-core-library!SPEventArgs:class' package: '@microsoft/sp-core-library!' fullName: SPEventArgs -summary: 'The base class for event arguments used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) class.' -remarks: 'If certain event types need to provide additional details, they will define a subclass of SPEventArgs.' +summary: The base class for event arguments used with the [SPEvent](xref:@microsoft/sp-core-library!SPEvent:class) class. +remarks: If certain event types need to provide additional details, they will define a subclass of SPEventArgs. isPreview: false isDeprecated: false type: class diff --git a/SP-Framework/sp-core-library/text_2.yml b/SP-Framework/sp-core-library/text_2.yml index 5e658b1b..83764180 100644 --- a/SP-Framework/sp-core-library/text_2.yml +++ b/SP-Framework/sp-core-library/text_2.yml @@ -4,15 +4,15 @@ uid: '@microsoft/sp-core-library!Text_2:class' package: '@microsoft/sp-core-library!' fullName: Text_2 summary: Operations for working with strings that contain text. -remarks: 'The utilities provided by this class are intended to be simple, small, and very broadly applicable.' +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)' + - name: format(s, values) uid: '@microsoft/sp-core-library!Text_2.format:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'format(s, values)' + 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 @@ -34,16 +34,16 @@ methods: type: string - id: values description: '' - type: 'unknown[]' + type: unknown[] return: type: string description: '' - - name: 'replaceAll(input, searchValue, replaceValue)' + - name: replaceAll(input, searchValue, replaceValue) uid: '@microsoft/sp-core-library!Text_2.replaceAll:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'replaceAll(input, searchValue, replaceValue)' - summary: 'Returns the input string, with all instances of `searchValue` replaced by `replaceValue`.' - remarks: 'Note that JavaScript''s `string.replace()` only replaces the first match, unless a global RegExp is provided.' + 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: diff --git a/SP-Framework/sp-core-library/timeprovider.yml b/SP-Framework/sp-core-library/timeprovider.yml index 08376b3d..39a76510 100644 --- a/SP-Framework/sp-core-library/timeprovider.yml +++ b/SP-Framework/sp-core-library/timeprovider.yml @@ -24,7 +24,7 @@ constructors: parameters: - id: serviceScope description: '' - type: '' + type: properties: - name: serviceKey uid: '@microsoft/sp-core-library!TimeProvider.serviceKey:member' @@ -45,7 +45,7 @@ methods: uid: '@microsoft/sp-core-library!TimeProvider#getDate:member(1)' package: '@microsoft/sp-core-library!' fullName: getDate() - summary: 'Returns the current date/time, similar to the Date class constructor.' + summary: Returns the current date/time, similar to the Date class constructor. remarks: '' isPreview: false isDeprecated: false @@ -58,7 +58,7 @@ methods: uid: '@microsoft/sp-core-library!TimeProvider#getTimestamp:member(1)' package: '@microsoft/sp-core-library!' fullName: getTimestamp() - summary: 'Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API.' + summary: Returns a DOMHighResTimeStamp timing measurement, as defined by the standard performance.now() API. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-core-library/urlqueryparametercollection.yml b/SP-Framework/sp-core-library/urlqueryparametercollection.yml index 7800652a..f5a93364 100644 --- a/SP-Framework/sp-core-library/urlqueryparametercollection.yml +++ b/SP-Framework/sp-core-library/urlqueryparametercollection.yml @@ -52,7 +52,6 @@ methods: getValue('TEST') ---> 'done' getValue('debug') ---> 'false' getValue('lost') ---> undefined - ``` isPreview: false isDeprecated: false syntax: @@ -80,7 +79,6 @@ methods: getValues('TEST') ---> ['done', 'notdone'] getValues('debug') ---> ['false'] getValues('lost') ---> undefined - ``` isPreview: false isDeprecated: false syntax: @@ -90,5 +88,5 @@ methods: description: the case insensitive key for the desired query parameter value. type: string return: - type: '(string | undefined)[] | undefined' + type: (string | undefined)[] | undefined description: '' diff --git a/SP-Framework/sp-core-library/validate.yml b/SP-Framework/sp-core-library/validate.yml index 0322050b..63af1426 100644 --- a/SP-Framework/sp-core-library/validate.yml +++ b/SP-Framework/sp-core-library/validate.yml @@ -12,11 +12,11 @@ isPreview: false isDeprecated: false type: class methods: - - name: 'isNonemptyString(value, variableName)' + - name: isNonemptyString(value, variableName) uid: '@microsoft/sp-core-library!Validate.isNonemptyString:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'isNonemptyString(value, variableName)' - summary: 'Throws an exception if the specified string is null, undefined, or an empty string.' + fullName: isNonemptyString(value, variableName) + summary: Throws an exception if the specified string is null, undefined, or an empty string. remarks: '' isPreview: false isDeprecated: false @@ -27,15 +27,15 @@ methods: description: the value to check type: string | undefined | null - id: variableName - description: 'the program variable name, which will be mentioned in the error message' + description: the program variable name, which will be mentioned in the error message type: string return: type: void description: '' - - name: 'isNotDisposed(value, className)' + - name: isNotDisposed(value, className) uid: '@microsoft/sp-core-library!Validate.isNotDisposed:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'isNotDisposed(value, className)' + fullName: isNotDisposed(value, className) summary: Throws an exception if the specified object has been disposed. remarks: '' isPreview: false @@ -45,17 +45,17 @@ methods: parameters: - id: value description: the value to check - type: '' + type: - id: className - description: 'the class name, which will be mentioned in the error message' + description: the class name, which will be mentioned in the error message type: string return: type: void description: '' - - name: 'isNotNullOrUndefined(value, variableName)' + - name: isNotNullOrUndefined(value, variableName) uid: '@microsoft/sp-core-library!Validate.isNotNullOrUndefined:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'isNotNullOrUndefined(value, variableName)' + fullName: isNotNullOrUndefined(value, variableName) summary: Throws an exception if the specified value is null or undefined. remarks: '' isPreview: false @@ -67,15 +67,15 @@ methods: description: the value to check type: unknown - id: variableName - description: 'the program variable name, which will be mentioned in the error message' + description: the program variable name, which will be mentioned in the error message type: string return: type: void description: '' - - name: 'isTrue(value, variableName)' + - name: isTrue(value, variableName) uid: '@microsoft/sp-core-library!Validate.isTrue:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'isTrue(value, variableName)' + fullName: isTrue(value, variableName) summary: Throws an exception if the specified value is not true. remarks: '' isPreview: false @@ -87,7 +87,7 @@ methods: description: the value to check type: boolean | undefined | null - id: variableName - description: 'the program variable name, which will be mentioned in the error message' + description: the program variable name, which will be mentioned in the error message type: string return: type: void diff --git a/SP-Framework/sp-core-library/version.yml b/SP-Framework/sp-core-library/version.yml index f109ccc2..0bcd6a35 100644 --- a/SP-Framework/sp-core-library/version.yml +++ b/SP-Framework/sp-core-library/version.yml @@ -3,7 +3,7 @@ name: Version uid: '@microsoft/sp-core-library!Version:class' package: '@microsoft/sp-core-library!' fullName: Version -summary: 'Represents a version number with two, three, or four parts.' +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 @@ -45,7 +45,7 @@ properties: uid: '@microsoft/sp-core-library!Version#patch:member' package: '@microsoft/sp-core-library!' fullName: patch - summary: 'The third number in the version string, or undefined if unspecified.' + 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. @@ -59,7 +59,7 @@ properties: uid: '@microsoft/sp-core-library!Version#revision:member' package: '@microsoft/sp-core-library!' fullName: revision - summary: 'The fourth number in the version string, or undefined if unspecified.' + 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. @@ -70,10 +70,10 @@ properties: return: type: number | undefined methods: - - name: 'compare(v1, v2)' + - name: compare(v1, v2) uid: '@microsoft/sp-core-library!Version.compare:member(1)' package: '@microsoft/sp-core-library!' - fullName: 'compare(v1, v2)' + fullName: compare(v1, v2) summary: Compares two Version objects to determine which version is newer. remarks: '' isPreview: false @@ -83,10 +83,10 @@ methods: parameters: - id: v1 description: The first version class for comparison - type: '' + type: - id: v2 description: The second version class for comparison - type: '' + type: return: type: number description: >- @@ -105,7 +105,6 @@ methods: 2.0.1 equals 2.0.0 -> false; 3.0 equals 3.0.0 -> true; 04.01 equals 4.1 -> true - ``` isPreview: false isDeprecated: false syntax: @@ -113,7 +112,7 @@ methods: parameters: - id: compareWith description: The version to compare with - type: '' + type: return: type: boolean description: A boolean indicating if this version is equal to the input parameter @@ -129,7 +128,6 @@ methods: 1.0.0 greaterThan 0.0.9 -> true; 2.0 greaterThan 2.0.0 -> false; 3.0.1 greaterThan 3.0 -> true - ``` isPreview: false isDeprecated: false syntax: @@ -137,7 +135,7 @@ methods: parameters: - id: compareWith description: The version to compare with - type: '' + type: return: type: boolean description: A boolean indicating if this version is greater than the input parameter @@ -171,7 +169,6 @@ methods: 2.0 lessThan 2.0.0 -> false; 3.0 lessThan 3.0.1 -> true; 04.01 lessThan 4.1 -> false - ``` isPreview: false isDeprecated: false syntax: @@ -179,7 +176,7 @@ methods: parameters: - id: compareWith description: The version to compare with - type: '' + type: return: type: boolean description: A boolean indicating if this version is less than the input parameter @@ -198,7 +195,7 @@ methods: description: A version string type: string | undefined | null return: - type: '' + type: description: a new Version object - name: satisfies(compareWith) uid: '@microsoft/sp-core-library!Version#satisfies:member(1)' @@ -224,8 +221,6 @@ methods: 2.0.0 satisfies 1.0.0 -> false; 1.0.0 satisfies 1.1.0 -> false - - ``` isPreview: false isDeprecated: false syntax: @@ -233,7 +228,7 @@ methods: parameters: - id: compareWith description: The version to compare with - type: '' + type: return: type: boolean description: A boolean indicating if this version is compatible with the input parameter @@ -269,5 +264,5 @@ methods: description: A version string type: string | undefined | null return: - type: ' | undefined' - description: 'The Version object, or undefined if the string could not be parsed.' + type: | undefined + description: The Version object, or undefined if the string could not be parsed. diff --git a/SP-Framework/sp-dialog/basedialog.yml b/SP-Framework/sp-dialog/basedialog.yml index 072ea4fc..0d671433 100644 --- a/SP-Framework/sp-dialog/basedialog.yml +++ b/SP-Framework/sp-dialog/basedialog.yml @@ -44,8 +44,6 @@ constructors: this._cache = cacheReference; // This is okay. Keeping a reference to my internal cache. this._cache.refresh(); // This is bad practice. // If you need to refresh the cache (or fetch data) for rendering, do it in onBeforeOpen() - } - ``` isPreview: false isDeprecated: false syntax: @@ -53,7 +51,7 @@ constructors: parameters: - id: config description: the dialog configuration that affects how the dialog is displayed \* - type: '' + type: properties: - name: domElement uid: '@microsoft/sp-dialog!BaseDialog#domElement:member' @@ -125,7 +123,7 @@ properties: syntax: content: 'get secondaryDialogProvider(): ISecondaryDialogProvider | undefined;' return: - type: ' | undefined' + type: | undefined methods: - name: close() uid: '@microsoft/sp-dialog!BaseDialog#close:member(1)' @@ -141,7 +139,7 @@ methods: content: 'close(): Promise;' return: type: Promise<void> - description: 'A promise that resolves when the dialog is visually closed, or if it was already closed' + description: A promise that resolves when the dialog is visually closed, or if it was already closed - name: onAfterClose() uid: '@microsoft/sp-dialog!BaseDialog#onAfterClose:member(1)' package: '@microsoft/sp-dialog!' @@ -215,7 +213,7 @@ methods: description: >- Dialog showing options. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. - type: '' + type: return: type: Promise<void> description: >- diff --git a/SP-Framework/sp-dialog/dialog.yml b/SP-Framework/sp-dialog/dialog.yml index d632447d..169f4162 100644 --- a/SP-Framework/sp-dialog/dialog.yml +++ b/SP-Framework/sp-dialog/dialog.yml @@ -9,10 +9,10 @@ isPreview: false isDeprecated: false type: class methods: - - name: 'alert(message, options)' + - name: alert(message, options) uid: '@microsoft/sp-dialog!Dialog.alert:member(1)' package: '@microsoft/sp-dialog!' - fullName: 'alert(message, options)' + fullName: alert(message, options) summary: >- Alerts a message to the user with a user-friendly interface. Calling this method sends a request to application to show the alert dialog. @@ -30,14 +30,14 @@ methods: type: string - id: options description: '' - type: '' + type: return: type: Promise<void> description: '' - - name: 'prompt(message, options)' + - name: prompt(message, options) uid: '@microsoft/sp-dialog!Dialog.prompt:member(1)' package: '@microsoft/sp-dialog!' - fullName: 'prompt(message, options)' + fullName: prompt(message, options) summary: >- Prompts the user for a string value with a user-friendly interface. Calling this method sends a request to application to show the dialog. @@ -55,7 +55,7 @@ methods: type: string - id: options description: '' - type: '' + type: return: type: Promise<string | undefined> description: The input string or undefined if the dialog was canceled diff --git a/SP-Framework/sp-dialog/ialertoptions.yml b/SP-Framework/sp-dialog/ialertoptions.yml index 2b172728..c11e6ec5 100644 --- a/SP-Framework/sp-dialog/ialertoptions.yml +++ b/SP-Framework/sp-dialog/ialertoptions.yml @@ -8,4 +8,4 @@ remarks: '' isPreview: false isDeprecated: false type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-dialog/ipromptoptions.yml b/SP-Framework/sp-dialog/ipromptoptions.yml index f8c1dcae..2fe37df1 100644 --- a/SP-Framework/sp-dialog/ipromptoptions.yml +++ b/SP-Framework/sp-dialog/ipromptoptions.yml @@ -21,4 +21,4 @@ properties: content: 'defaultValue?: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-dialog/isecondarydialogprovider.yml b/SP-Framework/sp-dialog/isecondarydialogprovider.yml index 93b74635..7ecf7185 100644 --- a/SP-Framework/sp-dialog/isecondarydialogprovider.yml +++ b/SP-Framework/sp-dialog/isecondarydialogprovider.yml @@ -19,10 +19,10 @@ isPreview: false isDeprecated: false type: interface methods: - - name: 'alert(message, options)' + - name: alert(message, options) uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#alert:member(1)' package: '@microsoft/sp-dialog!' - fullName: 'alert(message, options)' + fullName: alert(message, options) summary: >- Similar to [Dialog.alert()](xref:@microsoft/sp-dialog!Dialog.alert:member(1)). The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. @@ -39,14 +39,14 @@ methods: description: >- Dialog showing options. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. - type: '' + type: return: type: Promise<void> description: '' - - name: 'prompt(message, options)' + - name: prompt(message, options) uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#prompt:member(1)' package: '@microsoft/sp-dialog!' - fullName: 'prompt(message, options)' + fullName: prompt(message, options) summary: >- Similar to [Dialog.prompt()](xref:@microsoft/sp-dialog!Dialog.prompt:member(1)). The only difference is that the dialog is immediately shown if there are no other secondary dialogs. Otherwise, the promise rejects. @@ -63,14 +63,14 @@ methods: description: >- Dialog showing options. The confirmOpen option will be ignored. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. - type: '' + type: return: type: Promise<string | undefined> description: '' - - name: 'show(dialog, options)' + - name: show(dialog, options) uid: '@microsoft/sp-dialog!ISecondaryDialogProvider#show:member(1)' package: '@microsoft/sp-dialog!' - fullName: 'show(dialog, options)' + fullName: show(dialog, options) summary: >- Similar to [BaseDialog.show()](xref:@microsoft/sp-dialog!BaseDialog%23show:member(1)). The dialog to show is passed in as parameter and the dialog is immediately shown if there are no other secondary dialogs. Otherwise, @@ -83,12 +83,12 @@ methods: parameters: - id: dialog description: '' - type: '' + type: - id: options description: >- Dialog showing options. The confirmOpen option will be ignored. See [IDialogShowOptions](xref:@microsoft/sp-dialog!IDialogShowOptions:interface) for more information. - type: '' + type: return: type: Promise<void> description: '' diff --git a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml index b0e70cbb..697dd329 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataannotatedpropertyvalue.yml @@ -22,7 +22,7 @@ properties: syntax: content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' return: - type: '' + type: - name: sampleValue uid: '@microsoft/sp-dynamic-data!IDynamicDataAnnotatedPropertyValue#sampleValue:member' package: '@microsoft/sp-dynamic-data!' diff --git a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml index 39adbf0b..c37aa7eb 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatacallables.yml @@ -27,7 +27,7 @@ methods: syntax: content: 'allowedEvents?(): ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: ReadonlyArray<> description: '' - name: getAnnotatedPropertyValue(propertyId) uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getAnnotatedPropertyValue:member(1)' @@ -46,7 +46,7 @@ methods: description: One of the property ids exposed from the dynamic data source. type: string return: - type: ' | undefined' + type: | undefined description: '' - name: getPropertyDefinitions() uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyDefinitions:member(1)' @@ -59,14 +59,14 @@ methods: syntax: content: 'getPropertyDefinitions(): ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: ReadonlyArray<> description: '' - name: getPropertyValue(propertyId) uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#getPropertyValue:member(1)' package: '@microsoft/sp-dynamic-data!' fullName: getPropertyValue(propertyId) - summary: 'Given a property id, returns the value of the property.' - remarks: 'It is assumed that when this function returns an array, it is homogeneous.' + summary: Given a property id, returns the value of the property. + remarks: It is assumed that when this function returns an array, it is homogeneous. isPreview: false isDeprecated: false syntax: @@ -78,10 +78,10 @@ methods: return: type: any description: '' - - name: 'sendEvent(eventName, data)' + - name: sendEvent(eventName, data) uid: '@microsoft/sp-dynamic-data!IDynamicDataCallables#sendEvent:member(1)' package: '@microsoft/sp-dynamic-data!' - fullName: 'sendEvent(eventName, data)' + fullName: sendEvent(eventName, data) summary: >- If defined, enables the consumer to send data to the associated dynamic data source. Then source can act accordingly. diff --git a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml index 7208490d..93562e65 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdataeventdefinition.yml @@ -16,7 +16,7 @@ properties: uid: '@microsoft/sp-dynamic-data!IDynamicDataEventDefinition#description:member' package: '@microsoft/sp-dynamic-data!' fullName: description - summary: 'User-friendly, localized description of the event.' + summary: User-friendly, localized description of the event. remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml index 3c7a374b..beaa5f6b 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertydefinition.yml @@ -25,4 +25,4 @@ properties: content: 'id: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml index df35e22f..20d7bd85 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadata.yml @@ -20,5 +20,5 @@ properties: syntax: content: 'metadata?: IDynamicDataPropertyValueMetadataCollection;' return: - type: '' -extends: '' + type: +extends: diff --git a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml index ef701e5f..332de7f0 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatapropertyvaluemetadatacollection.yml @@ -70,10 +70,6 @@ remarks: >- metadataCollection: { 'city': { title: 'City' }, 'state': { title: 'State' } - } - } - } - ``` isPreview: false isDeprecated: false type: interface diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml index 453c6a7d..7f189e65 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasource.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasource.yml @@ -34,7 +34,7 @@ properties: syntax: content: 'metadata: IDynamicDataSourceMetadata;' return: - type: '' + type: methods: - name: allowedEventsAsync() uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#allowedEventsAsync:member(1)' @@ -74,7 +74,7 @@ methods: description: One of the property ids exposed from the dynamic data source. type: string return: - type: '' + type: description: '' - name: getAnnotatedPropertyValueAsync(propertyId) uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getAnnotatedPropertyValueAsync:member(1)' @@ -93,7 +93,7 @@ methods: description: Property id for which the value is requested. type: string return: - type: 'Promise<>' + type: Promise<> description: '' - name: getPropertyDefinitions() uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitions:member(1)' @@ -109,7 +109,7 @@ methods: syntax: content: 'getPropertyDefinitions(): ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: ReadonlyArray<> description: '' - name: getPropertyDefinitionsAsync() uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#getPropertyDefinitionsAsync:member(1)' @@ -167,10 +167,10 @@ methods: return: type: Promise<any> description: '' - - name: 'sendEvent(eventName, data)' + - name: sendEvent(eventName, data) uid: '@microsoft/sp-dynamic-data!IDynamicDataSource#sendEvent:member(1)' package: '@microsoft/sp-dynamic-data!' - fullName: 'sendEvent(eventName, data)' + fullName: sendEvent(eventName, data) summary: >- If defined, enables the consumer to send data to the associated dynamic data source. Then source can act accordingly. diff --git a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml index 2ec749b1..881be00f 100644 --- a/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml +++ b/SP-Framework/sp-dynamic-data/idynamicdatasourcemetadata.yml @@ -41,7 +41,7 @@ properties: uid: '@microsoft/sp-dynamic-data!IDynamicDataSourceMetadata#description:member' package: '@microsoft/sp-dynamic-data!' fullName: description - summary: 'User-friendly, localized description of the Dynamic Data Source.' + summary: User-friendly, localized description of the Dynamic Data Source. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-extension-base/baseextension.yml b/SP-Framework/sp-extension-base/baseextension.yml index 4937ded5..ca366daf 100644 --- a/SP-Framework/sp-extension-base/baseextension.yml +++ b/SP-Framework/sp-extension-base/baseextension.yml @@ -25,7 +25,7 @@ properties: syntax: content: 'protected readonly context: ExtensionContext;' return: - type: '' + type: - name: properties uid: '@microsoft/sp-extension-base!BaseExtension#properties:member' package: '@microsoft/sp-extension-base!' @@ -55,4 +55,4 @@ methods: return: type: Promise<void> description: '' -extends: '' +extends: diff --git a/SP-Framework/sp-extension-base/extensioncontext.yml b/SP-Framework/sp-extension-base/extensioncontext.yml index 9af3d712..7a90f60f 100644 --- a/SP-Framework/sp-extension-base/extensioncontext.yml +++ b/SP-Framework/sp-extension-base/extensioncontext.yml @@ -10,4 +10,4 @@ remarks: >- isPreview: false isDeprecated: false type: class -extends: '' +extends: diff --git a/SP-Framework/sp-http-base.yml b/SP-Framework/sp-http-base.yml index 5651c6b7..42324edc 100644 --- a/SP-Framework/sp-http-base.yml +++ b/SP-Framework/sp-http-base.yml @@ -10,6 +10,7 @@ classes: - '@microsoft/sp-http-base!AadHttpClientResponse:class' - '@microsoft/sp-http-base!AadTokenProvider:class' - '@microsoft/sp-http-base!AadTokenProviderFactory:class' + - '@microsoft/sp-http-base!BeforeFullPageRedirectEventArgs:class' - '@microsoft/sp-http-base!BeforeRedirectEventArgs:class' - '@microsoft/sp-http-base!DigestCache:class' - '@microsoft/sp-http-base!HttpClient:class' @@ -17,6 +18,7 @@ classes: - '@microsoft/sp-http-base!HttpClientResponse:class' - '@microsoft/sp-http-base!ODataVersion:class' - '@microsoft/sp-http-base!PopupEventArgs:class' + - '@microsoft/sp-http-base!PopupRequestEventArgs:class' - '@microsoft/sp-http-base!SPHttpClient:class' - '@microsoft/sp-http-base!SPHttpClientBatch:class' - '@microsoft/sp-http-base!SPHttpClientBatchConfiguration:class' diff --git a/SP-Framework/sp-http-base/aadhttpclient.yml b/SP-Framework/sp-http-base/aadhttpclient.yml index e3bfeef5..e1f1faf8 100644 --- a/SP-Framework/sp-http-base/aadhttpclient.yml +++ b/SP-Framework/sp-http-base/aadhttpclient.yml @@ -15,10 +15,10 @@ isPreview: false isDeprecated: false type: class constructors: - - name: '(constructor)(serviceScope, resourceEndpoint, options)' + - name: (constructor)(serviceScope, resourceEndpoint, options) uid: '@microsoft/sp-http-base!AadHttpClient:constructor(1)' package: '@microsoft/sp-http-base!' - fullName: '(constructor)(serviceScope, resourceEndpoint, options)' + fullName: (constructor)(serviceScope, resourceEndpoint, options) summary: Constructs a new instance of the `AadHttpClient` class remarks: '' isPreview: false @@ -28,13 +28,13 @@ constructors: parameters: - id: serviceScope description: The service scope is needed to retrieve some of the class's internal components. - type: '' + type: - id: resourceEndpoint description: The resource for which the token should be obtained. type: string - id: options description: Configuration options for the request to get an access token. - type: '' + type: properties: - name: configurations uid: '@microsoft/sp-http-base!AadHttpClient.configurations:member' @@ -47,12 +47,12 @@ properties: syntax: content: 'static readonly configurations: IAadHttpClientConfigurations;' return: - type: '' + type: methods: - - name: 'fetch(url, configuration, options)' + - name: fetch(url, configuration, options) uid: '@microsoft/sp-http-base!AadHttpClient#fetch:member(1)' package: '@microsoft/sp-http-base!' - fullName: 'fetch(url, configuration, options)' + fullName: fetch(url, configuration, options) summary: Performs a REST service call. remarks: >- Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for @@ -72,18 +72,18 @@ methods: description: >- Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations. - type: '' + type: - id: options description: Additional options that affect the request. - type: '' + type: return: - type: 'Promise<>' + type: Promise<> description: A promise that will return the result. - - name: 'get(url, configuration, options)' + - name: get(url, configuration, options) uid: '@microsoft/sp-http-base!AadHttpClient#get:member(1)' package: '@microsoft/sp-http-base!' - fullName: 'get(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to "GET".' + fullName: get(url, configuration, options) + summary: Calls fetch(), but sets the method to "GET". remarks: '' isPreview: false isDeprecated: false @@ -99,18 +99,18 @@ methods: description: >- Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations. - type: '' + type: - id: options description: Additional options that affect the request. - type: '' + type: return: - type: 'Promise<>' + type: Promise<> description: A promise that will return the result. - - name: 'post(url, configuration, options)' + - name: post(url, configuration, options) uid: '@microsoft/sp-http-base!AadHttpClient#post:member(1)' package: '@microsoft/sp-http-base!' - fullName: 'post(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to "POST".' + fullName: post(url, configuration, options) + summary: Calls fetch(), but sets the method to "POST". remarks: '' isPreview: false isDeprecated: false @@ -126,10 +126,10 @@ methods: description: >- Determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations. - type: '' + type: - id: options description: Additional options that affect the request. - type: '' + type: return: - type: 'Promise<>' + type: Promise<> description: A promise that will return the result. diff --git a/SP-Framework/sp-http-base/aadhttpclientconfiguration.yml b/SP-Framework/sp-http-base/aadhttpclientconfiguration.yml index 29f3d142..756f0a13 100644 --- a/SP-Framework/sp-http-base/aadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http-base/aadhttpclientconfiguration.yml @@ -13,10 +13,10 @@ isPreview: false isDeprecated: false type: class constructors: - - name: '(constructor)(flags, overrideFlags)' + - name: (constructor)(flags, overrideFlags) uid: '@microsoft/sp-http-base!AadHttpClientConfiguration:constructor(1)' package: '@microsoft/sp-http-base!' - fullName: '(constructor)(flags, overrideFlags)' + fullName: (constructor)(flags, overrideFlags) summary: >- Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. @@ -28,10 +28,10 @@ constructors: parameters: - id: flags description: '' - type: '' + type: - id: overrideFlags description: '' - type: '' + type: properties: - name: flags uid: '@microsoft/sp-http-base!AadHttpClientConfiguration#flags:member' @@ -44,7 +44,7 @@ properties: syntax: content: 'protected flags: IAadHttpClientConfiguration;' return: - type: '' + type: methods: - name: overrideWith(sourceFlags) uid: '@microsoft/sp-http-base!AadHttpClientConfiguration#overrideWith:member(1)' @@ -61,8 +61,8 @@ methods: parameters: - id: sourceFlags description: '' - type: '' + type: return: - type: '' + type: description: '' -extends: '' +extends: diff --git a/SP-Framework/sp-http-base/aadhttpclientfactory.yml b/SP-Framework/sp-http-base/aadhttpclientfactory.yml index fcba5ae3..ad869899 100644 --- a/SP-Framework/sp-http-base/aadhttpclientfactory.yml +++ b/SP-Framework/sp-http-base/aadhttpclientfactory.yml @@ -45,5 +45,5 @@ methods: description: The target AAD application's resource endpoint. type: string return: - type: 'Promise<>' + type: Promise<> description: '' diff --git a/SP-Framework/sp-http-base/aadhttpclientresponse.yml b/SP-Framework/sp-http-base/aadhttpclientresponse.yml index cfa9ad32..d22bbee2 100644 --- a/SP-Framework/sp-http-base/aadhttpclientresponse.yml +++ b/SP-Framework/sp-http-base/aadhttpclientresponse.yml @@ -11,10 +11,10 @@ isPreview: false isDeprecated: false type: class constructors: - - name: '(constructor)(response, tokenFetchRequestTime)' + - name: (constructor)(response, tokenFetchRequestTime) uid: '@microsoft/sp-http-base!AadHttpClientResponse:constructor(1)' package: '@microsoft/sp-http-base!' - fullName: '(constructor)(response, tokenFetchRequestTime)' + fullName: (constructor)(response, tokenFetchRequestTime) summary: Constructs a new instance of the `AadHttpClientResponse` class remarks: '' isPreview: false @@ -28,4 +28,4 @@ constructors: - id: tokenFetchRequestTime description: '' type: number -extends: '' +extends: diff --git a/SP-Framework/sp-http-base/aadtokenprovider.yml b/SP-Framework/sp-http-base/aadtokenprovider.yml index faca870c..3c852b9b 100644 --- a/SP-Framework/sp-http-base/aadtokenprovider.yml +++ b/SP-Framework/sp-http-base/aadtokenprovider.yml @@ -19,10 +19,10 @@ isPreview: false isDeprecated: false type: class methods: - - name: 'getToken(resourceEndpoint, options)' + - name: getToken(resourceEndpoint, options) uid: '@microsoft/sp-http-base!AadTokenProvider#getToken:member(1)' package: '@microsoft/sp-http-base!' - fullName: 'getToken(resourceEndpoint, options)' + fullName: getToken(resourceEndpoint, options) summary: |- Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. @@ -38,14 +38,14 @@ methods: type: string - id: options description: '' - type: '' + type: return: type: Promise<string> description: A promise that will be fulfilled with the token or that will reject with an error message - - name: 'getToken(resourceEndpoint, useCachedToken)' + - name: getToken(resourceEndpoint, useCachedToken) uid: '@microsoft/sp-http-base!AadTokenProvider#getToken:member(2)' package: '@microsoft/sp-http-base!' - fullName: 'getToken(resourceEndpoint, useCachedToken)' + fullName: getToken(resourceEndpoint, useCachedToken) summary: '' remarks: '' isPreview: false diff --git a/SP-Framework/sp-http-base/aadtokenproviderfactory.yml b/SP-Framework/sp-http-base/aadtokenproviderfactory.yml index 53115f5f..9f43a64f 100644 --- a/SP-Framework/sp-http-base/aadtokenproviderfactory.yml +++ b/SP-Framework/sp-http-base/aadtokenproviderfactory.yml @@ -37,5 +37,5 @@ methods: syntax: content: 'getTokenProvider(): Promise;' return: - type: 'Promise<>' + type: Promise<> description: '' diff --git a/SP-Framework/sp-http-base/beforefullpageredirecteventargs.yml b/SP-Framework/sp-http-base/beforefullpageredirecteventargs.yml new file mode 100644 index 00000000..ab473ec2 --- /dev/null +++ b/SP-Framework/sp-http-base/beforefullpageredirecteventargs.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: BeforeFullPageRedirectEventArgs +uid: '@microsoft/sp-http-base!BeforeFullPageRedirectEventArgs:class' +package: '@microsoft/sp-http-base!' +fullName: BeforeFullPageRedirectEventArgs +summary: Arguments for a full page redirect event if interaction is required during the login flow. +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(redirectUrl, cancel) + uid: '@microsoft/sp-http-base!BeforeFullPageRedirectEventArgs:constructor(1)' + package: '@microsoft/sp-http-base!' + fullName: (constructor)(redirectUrl, cancel) + summary: Constructs a new instance of the `BeforeFullPageRedirectEventArgs` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(redirectUrl: string, cancel: () => void);' + parameters: + - id: redirectUrl + description: '' + type: string + - id: cancel + description: '' + type: () => void +properties: + - name: cancel + uid: '@microsoft/sp-http-base!BeforeFullPageRedirectEventArgs#cancel:member' + package: '@microsoft/sp-http-base!' + fullName: cancel + summary: Call this method if the redirect should be cancelled because it is being handled by code in the cancelling class. + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'cancel: () => void;' + return: + type: () => void + - name: redirectUrl + uid: '@microsoft/sp-http-base!BeforeFullPageRedirectEventArgs#redirectUrl:member' + package: '@microsoft/sp-http-base!' + fullName: redirectUrl + summary: The url of the page to redirect to if automatic redirect is cancelled and you want the entire window redirected + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'redirectUrl: string;' + return: + type: string diff --git a/SP-Framework/sp-http-base/beforeredirecteventargs.yml b/SP-Framework/sp-http-base/beforeredirecteventargs.yml index fe7bde06..61ba3e76 100644 --- a/SP-Framework/sp-http-base/beforeredirecteventargs.yml +++ b/SP-Framework/sp-http-base/beforeredirecteventargs.yml @@ -9,10 +9,10 @@ isPreview: false isDeprecated: false type: class constructors: - - name: '(constructor)(redirectUrl, cancel, configuration)' + - name: (constructor)(redirectUrl, cancel, configuration) uid: '@microsoft/sp-http-base!BeforeRedirectEventArgs:constructor(1)' package: '@microsoft/sp-http-base!' - fullName: '(constructor)(redirectUrl, cancel, configuration)' + fullName: (constructor)(redirectUrl, cancel, configuration) summary: Constructs a new instance of the `BeforeRedirectEventArgs` class remarks: '' isPreview: false @@ -30,7 +30,7 @@ constructors: type: () => void - id: configuration description: '' - type: ' | undefined' + type: | undefined properties: - name: cancel uid: '@microsoft/sp-http-base!BeforeRedirectEventArgs#cancel:member' @@ -55,7 +55,7 @@ properties: syntax: content: 'configuration?: IAadTokenProviderConfiguration;' return: - type: '' + type: - name: redirectUrl uid: '@microsoft/sp-http-base!BeforeRedirectEventArgs#redirectUrl:member' package: '@microsoft/sp-http-base!' @@ -68,4 +68,4 @@ properties: content: 'redirectUrl: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-http-base/digestcache.yml b/SP-Framework/sp-http-base/digestcache.yml index e84bbc39..355a9df4 100644 --- a/SP-Framework/sp-http-base/digestcache.yml +++ b/SP-Framework/sp-http-base/digestcache.yml @@ -30,7 +30,7 @@ constructors: parameters: - id: serviceScope description: '' - type: '' + type: properties: - name: serviceKey uid: '@microsoft/sp-http-base!DigestCache.serviceKey:member' @@ -47,10 +47,10 @@ properties: <> methods: - - name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + - name: addDigestToCache(webUrl, digestValue, expirationTimestamp) uid: '@microsoft/sp-http-base!DigestCache#addDigestToCache:member(1)' package: '@microsoft/sp-http-base!' - fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + fullName: addDigestToCache(webUrl, digestValue, expirationTimestamp) summary: >- Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios diff --git a/SP-Framework/sp-http-base/httpclient.yml b/SP-Framework/sp-http-base/httpclient.yml index 24612112..324cda3d 100644 --- a/SP-Framework/sp-http-base/httpclient.yml +++ b/SP-Framework/sp-http-base/httpclient.yml @@ -24,7 +24,7 @@ constructors: parameters: - id: serviceScope description: '' - type: '' + type: properties: - name: configurations uid: '@microsoft/sp-http-base!HttpClient.configurations:member' @@ -37,7 +37,7 @@ properties: syntax: content: 'static readonly configurations: IHttpClientConfigurations;' return: - type: '' + type: - name: serviceKey uid: '@microsoft/sp-http-base!HttpClient.serviceKey:member' package: '@microsoft/sp-http-base!' @@ -53,10 +53,10 @@ properties: <> methods: - - name: 'fetch(url, configuration, options)' + - name: fetch(url, configuration, options) uid: '@microsoft/sp-http-base!HttpClient#fetch:member(1)' package: '@microsoft/sp-http-base!' - fullName: 'fetch(url, configuration, options)' + fullName: fetch(url, configuration, options) summary: Performs a REST service call. remarks: >- Although the SPHttpClient subclass adds additional enhancements, the parameters and semantics for @@ -76,22 +76,22 @@ methods: description: >- determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations - type: '' + type: - id: options description: additional options that affect the request - type: '' + type: return: - type: 'Promise<>' + type: Promise<> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with [HttpClientResponse.ok](xref:@microsoft/sp-http-base!HttpClientResponse%23ok:member) being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server. - - name: 'get(url, configuration, options)' + - name: get(url, configuration, options) uid: '@microsoft/sp-http-base!HttpClient#get:member(1)' package: '@microsoft/sp-http-base!' - fullName: 'get(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to "GET".' + fullName: get(url, configuration, options) + summary: Calls fetch(), but sets the method to "GET". remarks: '' isPreview: false isDeprecated: false @@ -107,22 +107,22 @@ methods: description: >- determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations - type: '' + type: - id: options description: additional options that affect the request - type: '' + type: return: - type: 'Promise<>' + type: Promise<> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with [HttpClientResponse.ok](xref:@microsoft/sp-http-base!HttpClientResponse%23ok:member) being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server. - - name: 'post(url, configuration, options)' + - name: post(url, configuration, options) uid: '@microsoft/sp-http-base!HttpClient#post:member(1)' package: '@microsoft/sp-http-base!' - fullName: 'post(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to "POST".' + fullName: post(url, configuration, options) + summary: Calls fetch(), but sets the method to "POST". remarks: '' isPreview: false isDeprecated: false @@ -138,12 +138,12 @@ methods: description: >- determines the default behavior of HttpClient; normally this should be the latest version number from HttpClientConfigurations - type: '' + type: - id: options description: additional options that affect the request - type: '' + type: return: - type: 'Promise<>' + type: Promise<> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with [HttpClientResponse.ok](xref:@microsoft/sp-http-base!HttpClientResponse%23ok:member) being false) for error diff --git a/SP-Framework/sp-http-base/httpclientconfiguration.yml b/SP-Framework/sp-http-base/httpclientconfiguration.yml index 8ed68fa5..dccba87e 100644 --- a/SP-Framework/sp-http-base/httpclientconfiguration.yml +++ b/SP-Framework/sp-http-base/httpclientconfiguration.yml @@ -13,10 +13,10 @@ isPreview: false isDeprecated: false type: class constructors: - - name: '(constructor)(flags, overrideFlags)' + - name: (constructor)(flags, overrideFlags) uid: '@microsoft/sp-http-base!HttpClientConfiguration:constructor(1)' package: '@microsoft/sp-http-base!' - fullName: '(constructor)(flags, overrideFlags)' + fullName: (constructor)(flags, overrideFlags) summary: >- Constructs a new instance of HttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. @@ -28,10 +28,10 @@ constructors: parameters: - id: flags description: '' - type: '' + type: - id: overrideFlags description: '' - type: '' + type: properties: - name: flags uid: '@microsoft/sp-http-base!HttpClientConfiguration#flags:member' @@ -44,7 +44,7 @@ properties: syntax: content: 'protected flags: IHttpClientConfiguration;' return: - type: '' + type: methods: - name: initializeFlags() uid: '@microsoft/sp-http-base!HttpClientConfiguration#initializeFlags:member(1)' @@ -65,7 +65,7 @@ methods: uid: '@microsoft/sp-http-base!HttpClientConfiguration#overrideWith:member(1)' package: '@microsoft/sp-http-base!' fullName: overrideWith(sourceFlags) - summary: 'Child classes should override this method to construct the child class type, rather than the base class type.' + summary: Child classes should override this method to construct the child class type, rather than the base class type. remarks: '' isPreview: false isDeprecated: false @@ -76,7 +76,7 @@ methods: parameters: - id: sourceFlags description: '' - type: '' + type: return: - type: '' + type: description: '' diff --git a/SP-Framework/sp-http-base/httpclientresponse.yml b/SP-Framework/sp-http-base/httpclientresponse.yml index 9e642648..1c29003d 100644 --- a/SP-Framework/sp-http-base/httpclientresponse.yml +++ b/SP-Framework/sp-http-base/httpclientresponse.yml @@ -30,7 +30,7 @@ properties: uid: '@microsoft/sp-http-base!HttpClientResponse#bodyUsed:member' package: '@microsoft/sp-http-base!' fullName: bodyUsed - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + summary: See documentation for the browser's [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API remarks: '' isPreview: false isDeprecated: false @@ -42,7 +42,7 @@ properties: uid: '@microsoft/sp-http-base!HttpClientResponse#headers:member' package: '@microsoft/sp-http-base!' fullName: headers - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + summary: See documentation for the browser's [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API remarks: '' isPreview: false isDeprecated: false @@ -66,7 +66,7 @@ properties: uid: '@microsoft/sp-http-base!HttpClientResponse#ok:member' package: '@microsoft/sp-http-base!' fullName: ok - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + summary: See documentation for the browser's [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API remarks: '' isPreview: false isDeprecated: false @@ -90,7 +90,7 @@ properties: uid: '@microsoft/sp-http-base!HttpClientResponse#status:member' package: '@microsoft/sp-http-base!' fullName: status - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + summary: See documentation for the browser's [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API remarks: '' isPreview: false isDeprecated: false @@ -102,7 +102,7 @@ properties: uid: '@microsoft/sp-http-base!HttpClientResponse#statusText:member' package: '@microsoft/sp-http-base!' fullName: statusText - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + summary: See documentation for the browser's [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API remarks: '' isPreview: false isDeprecated: false @@ -129,7 +129,7 @@ properties: uid: '@microsoft/sp-http-base!HttpClientResponse#type:member' package: '@microsoft/sp-http-base!' fullName: type - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + summary: See documentation for the browser's [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API remarks: '' isPreview: false isDeprecated: false @@ -141,7 +141,7 @@ properties: uid: '@microsoft/sp-http-base!HttpClientResponse#url:member' package: '@microsoft/sp-http-base!' fullName: url - summary: 'See documentation for the browser''s [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API' + summary: See documentation for the browser's [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) API remarks: '' isPreview: false isDeprecated: false @@ -154,7 +154,7 @@ methods: uid: '@microsoft/sp-http-base!HttpClientResponse#arrayBuffer:member(1)' package: '@microsoft/sp-http-base!' fullName: arrayBuffer() - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + summary: See documentation for the browser's [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API remarks: '' isPreview: false isDeprecated: false @@ -167,7 +167,7 @@ methods: uid: '@microsoft/sp-http-base!HttpClientResponse#blob:member(1)' package: '@microsoft/sp-http-base!' fullName: blob() - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + summary: See documentation for the browser's [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API remarks: '' isPreview: false isDeprecated: false @@ -189,13 +189,13 @@ methods: /** @virtual */ clone(): HttpClientResponse; return: - type: '' + type: description: '' - name: formData() uid: '@microsoft/sp-http-base!HttpClientResponse#formData:member(1)' package: '@microsoft/sp-http-base!' fullName: formData() - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + summary: See documentation for the browser's [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API remarks: '' isPreview: false isDeprecated: false @@ -208,7 +208,7 @@ methods: uid: '@microsoft/sp-http-base!HttpClientResponse#json:member(1)' package: '@microsoft/sp-http-base!' fullName: json() - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + summary: See documentation for the browser's [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API remarks: '' isPreview: false isDeprecated: false @@ -221,7 +221,7 @@ methods: uid: '@microsoft/sp-http-base!HttpClientResponse#text:member(1)' package: '@microsoft/sp-http-base!' fullName: text() - summary: 'See documentation for the browser''s [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API' + summary: See documentation for the browser's [Body](https://developer.mozilla.org/en-US/docs/Web/API/Body) API remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-http-base/iaadhttpclientconfiguration.yml b/SP-Framework/sp-http-base/iaadhttpclientconfiguration.yml index e5ec34dc..cbf00fef 100644 --- a/SP-Framework/sp-http-base/iaadhttpclientconfiguration.yml +++ b/SP-Framework/sp-http-base/iaadhttpclientconfiguration.yml @@ -8,4 +8,4 @@ remarks: '' isPreview: false isDeprecated: false type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-http-base/iaadhttpclientconfigurations.yml b/SP-Framework/sp-http-base/iaadhttpclientconfigurations.yml index 45d64158..c7c6e7b1 100644 --- a/SP-Framework/sp-http-base/iaadhttpclientconfigurations.yml +++ b/SP-Framework/sp-http-base/iaadhttpclientconfigurations.yml @@ -26,4 +26,4 @@ properties: syntax: content: 'readonly v1: AadHttpClientConfiguration;' return: - type: '' + type: diff --git a/SP-Framework/sp-http-base/iaadhttpclientoptions.yml b/SP-Framework/sp-http-base/iaadhttpclientoptions.yml index 179ef973..95d98f5c 100644 --- a/SP-Framework/sp-http-base/iaadhttpclientoptions.yml +++ b/SP-Framework/sp-http-base/iaadhttpclientoptions.yml @@ -21,7 +21,7 @@ properties: syntax: content: 'configuration?: IAadTokenProviderConfiguration;' return: - type: '' + type: - name: tokenProvider uid: '@microsoft/sp-http-base!IAadHttpClientOptions#tokenProvider:member' package: '@microsoft/sp-http-base!' @@ -34,7 +34,7 @@ properties: syntax: content: 'tokenProvider?: IAadTokenProvider;' return: - type: '' + type: - name: useCachedToken uid: '@microsoft/sp-http-base!IAadHttpClientOptions#useCachedToken:member' package: '@microsoft/sp-http-base!' diff --git a/SP-Framework/sp-http-base/iaadtokenprovider.yml b/SP-Framework/sp-http-base/iaadtokenprovider.yml index 474f1f08..07b24c29 100644 --- a/SP-Framework/sp-http-base/iaadtokenprovider.yml +++ b/SP-Framework/sp-http-base/iaadtokenprovider.yml @@ -17,10 +17,10 @@ isPreview: false isDeprecated: false type: interface methods: - - name: 'getToken(resourceEndpoint, options)' + - name: getToken(resourceEndpoint, options) uid: '@microsoft/sp-http-base!IAadTokenProvider#getToken:member(1)' package: '@microsoft/sp-http-base!' - fullName: 'getToken(resourceEndpoint, options)' + fullName: getToken(resourceEndpoint, options) summary: |- Fetches the AAD OAuth2 token for a resource if the user that's currently logged in has access to that resource. @@ -38,14 +38,14 @@ methods: type: string - id: options description: '' - type: '' + type: return: type: Promise<string> description: A promise that will be fullfiled with the token or that will reject with an error message - - name: 'getToken(resourceEndpoint, useCachedToken)' + - name: getToken(resourceEndpoint, useCachedToken) uid: '@microsoft/sp-http-base!IAadTokenProvider#getToken:member(2)' package: '@microsoft/sp-http-base!' - fullName: 'getToken(resourceEndpoint, useCachedToken)' + fullName: getToken(resourceEndpoint, useCachedToken) summary: '' remarks: '' isPreview: false diff --git a/SP-Framework/sp-http-base/ibeforeredirecteventargs.yml b/SP-Framework/sp-http-base/ibeforeredirecteventargs.yml index 37a3afb2..4b865bf2 100644 --- a/SP-Framework/sp-http-base/ibeforeredirecteventargs.yml +++ b/SP-Framework/sp-http-base/ibeforeredirecteventargs.yml @@ -33,4 +33,4 @@ properties: content: 'redirectUrl: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-http-base/idigestcache.yml b/SP-Framework/sp-http-base/idigestcache.yml index 9749f672..edbcc47d 100644 --- a/SP-Framework/sp-http-base/idigestcache.yml +++ b/SP-Framework/sp-http-base/idigestcache.yml @@ -17,10 +17,10 @@ isPreview: false isDeprecated: false type: interface methods: - - name: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + - name: addDigestToCache(webUrl, digestValue, expirationTimestamp) uid: '@microsoft/sp-http-base!IDigestCache#addDigestToCache:member(1)' package: '@microsoft/sp-http-base!' - fullName: 'addDigestToCache(webUrl, digestValue, expirationTimestamp)' + fullName: addDigestToCache(webUrl, digestValue, expirationTimestamp) summary: >- Inserts a specific request digest value into the cache. Normally this is unnecessary because the framework will automatically issue a REST request to fetch the digest when necessary; however, in advanced scenarios diff --git a/SP-Framework/sp-http-base/ifetchprovider.yml b/SP-Framework/sp-http-base/ifetchprovider.yml index a47c2fcf..c4529212 100644 --- a/SP-Framework/sp-http-base/ifetchprovider.yml +++ b/SP-Framework/sp-http-base/ifetchprovider.yml @@ -6,7 +6,7 @@ fullName: IFetchProvider summary: >- This is a ServiceScope interface that represents the basic contract of the ES6 Fetch API, without any additional SharePoint logic. -remarks: 'See the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) documentation for details.' +remarks: See the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) documentation for details. isPreview: true isDeprecated: false type: interface @@ -16,7 +16,7 @@ methods: package: '@microsoft/sp-http-base!' fullName: fetch(request) summary: The parameters and semantics for this function are the same as the ES6 GlobalFetch.fetch() standard. - remarks: 'See the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) documentation for details.' + remarks: See the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) documentation for details. isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-http-base/igettokenoptions.yml b/SP-Framework/sp-http-base/igettokenoptions.yml index fffbef38..d1f73c7e 100644 --- a/SP-Framework/sp-http-base/igettokenoptions.yml +++ b/SP-Framework/sp-http-base/igettokenoptions.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'authenticationScheme?: IAuthenticationScheme;' return: - type: '' + type: - name: claims uid: '@microsoft/sp-http-base!IGetTokenOptions#claims:member' package: '@microsoft/sp-http-base!' diff --git a/SP-Framework/sp-http-base/ihttpclientconfigurations.yml b/SP-Framework/sp-http-base/ihttpclientconfigurations.yml index 030b921d..c77fc08d 100644 --- a/SP-Framework/sp-http-base/ihttpclientconfigurations.yml +++ b/SP-Framework/sp-http-base/ihttpclientconfigurations.yml @@ -26,4 +26,4 @@ properties: syntax: content: 'readonly v1: HttpClientConfiguration;' return: - type: '' + type: diff --git a/SP-Framework/sp-http-base/ipopupeventargs.yml b/SP-Framework/sp-http-base/ipopupeventargs.yml index 9f160509..e7dd0b85 100644 --- a/SP-Framework/sp-http-base/ipopupeventargs.yml +++ b/SP-Framework/sp-http-base/ipopupeventargs.yml @@ -32,7 +32,7 @@ properties: syntax: content: 'options: IGetTokenDataOptions;' return: - type: '' + type: - name: requestPopup uid: '@microsoft/sp-http-base!IPopupEventArgs#requestPopup:member' package: '@microsoft/sp-http-base!' @@ -61,7 +61,7 @@ properties: uid: '@microsoft/sp-http-base!IPopupEventArgs#showPopup:member' package: '@microsoft/sp-http-base!' fullName: showPopup - summary: 'A handler should call this when ready, to indicate that the login flow should now continue and launch the popup.' + summary: A handler should call this when ready, to indicate that the login flow should now continue and launch the popup. remarks: '' isPreview: false isDeprecated: false @@ -69,4 +69,4 @@ properties: content: 'showPopup: () => Promise | void;' return: type: () => Promise<void> | void -extends: '' +extends: diff --git a/SP-Framework/sp-http-base/isphttpclientbatchconfiguration.yml b/SP-Framework/sp-http-base/isphttpclientbatchconfiguration.yml index d52be250..5079d9f4 100644 --- a/SP-Framework/sp-http-base/isphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http-base/isphttpclientbatchconfiguration.yml @@ -8,4 +8,4 @@ remarks: '' isPreview: true isDeprecated: false type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-http-base/isphttpclientbatchconfigurations.yml b/SP-Framework/sp-http-base/isphttpclientbatchconfigurations.yml index 9bc4e424..eda56bc5 100644 --- a/SP-Framework/sp-http-base/isphttpclientbatchconfigurations.yml +++ b/SP-Framework/sp-http-base/isphttpclientbatchconfigurations.yml @@ -24,4 +24,4 @@ properties: syntax: content: 'readonly v1: SPHttpClientBatchConfiguration;' return: - type: '' + type: diff --git a/SP-Framework/sp-http-base/isphttpclientbatchoptions.yml b/SP-Framework/sp-http-base/isphttpclientbatchoptions.yml index c4f79207..d7d4e7a7 100644 --- a/SP-Framework/sp-http-base/isphttpclientbatchoptions.yml +++ b/SP-Framework/sp-http-base/isphttpclientbatchoptions.yml @@ -10,4 +10,4 @@ remarks: '' isPreview: true isDeprecated: false type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-http-base/isphttpclientcommonconfiguration.yml b/SP-Framework/sp-http-base/isphttpclientcommonconfiguration.yml index c573c2f3..dc03eec1 100644 --- a/SP-Framework/sp-http-base/isphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http-base/isphttpclientcommonconfiguration.yml @@ -51,4 +51,18 @@ properties: content: 'jsonResponse?: boolean;' return: type: boolean -extends: '' + - name: usePopupForCookieRefresh + uid: '@microsoft/sp-http-base!ISPHttpClientCommonConfiguration#usePopupForCookieRefresh:member' + package: '@microsoft/sp-http-base!' + fullName: usePopupForCookieRefresh + summary: Handle cookie refresh with a popup dialog + remarks: >- + When this switch is true popup auth will be used for handling a cookie refresh. This means the caller must handle + the popup events. If it is undefined or false full page redirect will be defaulted to. + isPreview: false + isDeprecated: false + syntax: + content: 'usePopupForCookieRefresh?: boolean;' + return: + type: boolean +extends: diff --git a/SP-Framework/sp-http-base/isphttpclientconfiguration.yml b/SP-Framework/sp-http-base/isphttpclientconfiguration.yml index 3bbb5b91..060c98ab 100644 --- a/SP-Framework/sp-http-base/isphttpclientconfiguration.yml +++ b/SP-Framework/sp-http-base/isphttpclientconfiguration.yml @@ -26,7 +26,7 @@ properties: syntax: content: 'defaultODataVersion?: ODataVersion;' return: - type: '' + type: - name: defaultSameOriginCredentials uid: '@microsoft/sp-http-base!ISPHttpClientConfiguration#defaultSameOriginCredentials:member' package: '@microsoft/sp-http-base!' @@ -65,4 +65,18 @@ properties: content: 'requestDigest?: boolean;' return: type: boolean -extends: '' + - name: usePopupForCookieRefresh + uid: '@microsoft/sp-http-base!ISPHttpClientConfiguration#usePopupForCookieRefresh:member' + package: '@microsoft/sp-http-base!' + fullName: usePopupForCookieRefresh + summary: Handle cookie refresh with a popup dialog + remarks: >- + When this switch is true popup auth will be used for handling a cookie refresh. This means the caller must handle + the popup events. If it is undefined or false full page redirect will be defaulted to. + isPreview: false + isDeprecated: false + syntax: + content: 'usePopupForCookieRefresh?: boolean;' + return: + type: boolean +extends: diff --git a/SP-Framework/sp-http-base/isphttpclientconfigurations.yml b/SP-Framework/sp-http-base/isphttpclientconfigurations.yml index 1996ac57..92edef64 100644 --- a/SP-Framework/sp-http-base/isphttpclientconfigurations.yml +++ b/SP-Framework/sp-http-base/isphttpclientconfigurations.yml @@ -29,4 +29,4 @@ properties: syntax: content: 'readonly v1: SPHttpClientConfiguration;' return: - type: '' + type: diff --git a/SP-Framework/sp-http-base/isphttpclientoptions.yml b/SP-Framework/sp-http-base/isphttpclientoptions.yml index 5e2edc8c..95110004 100644 --- a/SP-Framework/sp-http-base/isphttpclientoptions.yml +++ b/SP-Framework/sp-http-base/isphttpclientoptions.yml @@ -28,4 +28,4 @@ properties: content: 'webUrl?: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-http-base/itokenacquisitioneventargs.yml b/SP-Framework/sp-http-base/itokenacquisitioneventargs.yml index b89bcc1f..4d8d26f8 100644 --- a/SP-Framework/sp-http-base/itokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http-base/itokenacquisitioneventargs.yml @@ -33,4 +33,4 @@ properties: content: 'redirectUrl?: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-http-base/odataversion.yml b/SP-Framework/sp-http-base/odataversion.yml index 5cdb515d..bc869fbc 100644 --- a/SP-Framework/sp-http-base/odataversion.yml +++ b/SP-Framework/sp-http-base/odataversion.yml @@ -3,7 +3,7 @@ name: ODataVersion uid: '@microsoft/sp-http-base!ODataVersion:class' package: '@microsoft/sp-http-base!' fullName: ODataVersion -summary: 'Represents supported version of the "OData-Version" header, which is part of the Open Data Protocol standard.' +summary: Represents supported version of the "OData-Version" header, which is part of the Open Data Protocol standard. remarks: '' isPreview: false isDeprecated: false @@ -20,7 +20,7 @@ properties: syntax: content: 'static v3: ODataVersion;' return: - type: '' + type: - name: v4 uid: '@microsoft/sp-http-base!ODataVersion.v4:member' package: '@microsoft/sp-http-base!' @@ -32,13 +32,13 @@ properties: syntax: content: 'static v4: ODataVersion;' return: - type: '' + type: methods: - name: toString() uid: '@microsoft/sp-http-base!ODataVersion#toString:member(1)' package: '@microsoft/sp-http-base!' fullName: toString() - summary: 'Returns the "OData-Version" value, for example "4.0".' + summary: Returns the "OData-Version" value, for example "4.0". remarks: '' isPreview: false isDeprecated: false @@ -64,5 +64,5 @@ methods: description: '' type: Headers return: - type: ' | undefined' + type: | undefined description: '' diff --git a/SP-Framework/sp-http-base/popupeventargs.yml b/SP-Framework/sp-http-base/popupeventargs.yml index 214d619f..405cdd4d 100644 --- a/SP-Framework/sp-http-base/popupeventargs.yml +++ b/SP-Framework/sp-http-base/popupeventargs.yml @@ -9,10 +9,10 @@ isPreview: false isDeprecated: false type: class constructors: - - name: '(constructor)(cancel, requestPopup, showPopup, resource, options)' + - name: (constructor)(cancel, requestPopup, showPopup, resource, options) uid: '@microsoft/sp-http-base!PopupEventArgs:constructor(1)' package: '@microsoft/sp-http-base!' - fullName: '(constructor)(cancel, requestPopup, showPopup, resource, options)' + fullName: (constructor)(cancel, requestPopup, showPopup, resource, options) summary: Constructs a new instance of the `PopupEventArgs` class remarks: '' isPreview: false @@ -36,7 +36,7 @@ constructors: type: string - id: options description: '' - type: '' + type: properties: - name: cancel uid: '@microsoft/sp-http-base!PopupEventArgs#cancel:member' @@ -61,7 +61,7 @@ properties: syntax: content: 'options: IGetTokenDataOptions;' return: - type: '' + type: - name: requestPopup uid: '@microsoft/sp-http-base!PopupEventArgs#requestPopup:member' package: '@microsoft/sp-http-base!' @@ -90,7 +90,7 @@ properties: uid: '@microsoft/sp-http-base!PopupEventArgs#showPopup:member' package: '@microsoft/sp-http-base!' fullName: showPopup - summary: 'A handler should call this when ready, to indicate that the login flow should now continue and launch the popup.' + summary: A handler should call this when ready, to indicate that the login flow should now continue and launch the popup. remarks: '' isPreview: false isDeprecated: false @@ -98,4 +98,4 @@ properties: content: 'showPopup: () => Promise | void;' return: type: () => Promise<void> | void -extends: '' +extends: diff --git a/SP-Framework/sp-http-base/popuprequesteventargs.yml b/SP-Framework/sp-http-base/popuprequesteventargs.yml new file mode 100644 index 00000000..a4e3b020 --- /dev/null +++ b/SP-Framework/sp-http-base/popuprequesteventargs.yml @@ -0,0 +1,38 @@ +### YamlMime:TSType +name: PopupRequestEventArgs +uid: '@microsoft/sp-http-base!PopupRequestEventArgs:class' +package: '@microsoft/sp-http-base!' +fullName: PopupRequestEventArgs +summary: Arguments for a popup event if interaction is required during the login flow. +remarks: '' +isPreview: false +isDeprecated: false +type: class +constructors: + - name: (constructor)(showPopup) + uid: '@microsoft/sp-http-base!PopupRequestEventArgs:constructor(1)' + package: '@microsoft/sp-http-base!' + fullName: (constructor)(showPopup) + summary: Constructs a new instance of the `PopupRequestEventArgs` class + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'constructor(showPopup: () => void);' + parameters: + - id: showPopup + description: '' + type: () => void +properties: + - name: showPopup + uid: '@microsoft/sp-http-base!PopupRequestEventArgs#showPopup:member' + package: '@microsoft/sp-http-base!' + fullName: showPopup + summary: A handler should call this from user interaction to ensure the browser does not block the popup window + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'showPopup: () => void;' + return: + type: () => void diff --git a/SP-Framework/sp-http-base/sphttpclient.yml b/SP-Framework/sp-http-base/sphttpclient.yml index 4609e1ca..f2082563 100644 --- a/SP-Framework/sp-http-base/sphttpclient.yml +++ b/SP-Framework/sp-http-base/sphttpclient.yml @@ -29,7 +29,7 @@ constructors: parameters: - id: serviceScope description: '' - type: '' + type: properties: - name: configurations uid: '@microsoft/sp-http-base!SPHttpClient.configurations:member' @@ -42,7 +42,7 @@ properties: syntax: content: 'static readonly configurations: ISPHttpClientConfigurations;' return: - type: '' + type: - name: isNavigate uid: '@microsoft/sp-http-base!SPHttpClient#isNavigate:member' package: '@microsoft/sp-http-base!' @@ -58,6 +58,34 @@ properties: set isNavigate(isNavigate: boolean); return: type: boolean + - name: onBeforeRedirectEvent + uid: '@microsoft/sp-http-base!SPHttpClient#onBeforeRedirectEvent:member' + package: '@microsoft/sp-http-base!' + fullName: onBeforeRedirectEvent + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly onBeforeRedirectEvent: SPEvent;' + return: + type: >- + <> + - name: onPopupRequestedEvent + uid: '@microsoft/sp-http-base!SPHttpClient#onPopupRequestedEvent:member' + package: '@microsoft/sp-http-base!' + fullName: onPopupRequestedEvent + summary: '' + remarks: '' + isPreview: false + isDeprecated: false + syntax: + content: 'readonly onPopupRequestedEvent: SPEvent;' + return: + type: >- + <> - name: serviceKey uid: '@microsoft/sp-http-base!SPHttpClient.serviceKey:member' package: '@microsoft/sp-http-base!' @@ -73,10 +101,10 @@ properties: <> methods: - - name: '_fetch(url, configuration, options)' + - name: _fetch(url, configuration, options) uid: '@microsoft/sp-http-base!SPHttpClient#_fetch:member(1)' package: '@microsoft/sp-http-base!' - fullName: '_fetch(url, configuration, options)' + fullName: _fetch(url, configuration, options) summary: '' remarks: '' isPreview: false @@ -91,18 +119,18 @@ methods: type: string - id: configuration description: '' - type: '' + type: - id: options description: '' - type: '' + type: return: - type: 'Promise<>' + type: Promise<> description: '' - name: beginBatch(batchCreationOptions) uid: '@microsoft/sp-http-base!SPHttpClient#beginBatch:member(1)' package: '@microsoft/sp-http-base!' fullName: beginBatch(batchCreationOptions) - summary: 'Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request.' + summary: Begins an ODATA batch, which allows multiple REST queries to be bundled into a single web request. remarks: '' isPreview: true isDeprecated: false @@ -111,16 +139,16 @@ methods: parameters: - id: batchCreationOptions description: '' - type: '' + type: return: - type: '' + type: description: >- An [SPHttpClientBatch](xref:@microsoft/sp-http-base!SPHttpClientBatch:class) object used to manage the batch operation. - - name: 'fetch(url, configuration, options)' + - name: fetch(url, configuration, options) uid: '@microsoft/sp-http-base!SPHttpClient#fetch:member(1)' package: '@microsoft/sp-http-base!' - fullName: 'fetch(url, configuration, options)' + fullName: fetch(url, configuration, options) summary: Perform a REST service call. remarks: >- Generally, the parameters and semantics for SPHttpClient.fetch() are essentially the same as the WHATWG API @@ -158,22 +186,22 @@ methods: description: >- determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations - type: '' + type: - id: options description: additional options that affect the request - type: '' + type: return: - type: 'Promise<>' + type: Promise<> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with [HttpClientResponse.ok](xref:@microsoft/sp-http-base!HttpClientResponse%23ok:member) being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server. - - name: 'get(url, configuration, options)' + - name: get(url, configuration, options) uid: '@microsoft/sp-http-base!SPHttpClient#get:member(1)' package: '@microsoft/sp-http-base!' - fullName: 'get(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to "GET".' + fullName: get(url, configuration, options) + summary: Calls fetch(), but sets the method to "GET". remarks: '' isPreview: false isDeprecated: false @@ -189,12 +217,12 @@ methods: description: >- determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations - type: '' + type: - id: options description: additional options that affect the request - type: '' + type: return: - type: 'Promise<>' + type: Promise<> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with [HttpClientResponse.ok](xref:@microsoft/sp-http-base!HttpClientResponse%23ok:member) being false) for error @@ -228,11 +256,11 @@ methods: return: type: string description: the inferred SPWeb URL - - name: 'post(url, configuration, options)' + - name: post(url, configuration, options) uid: '@microsoft/sp-http-base!SPHttpClient#post:member(1)' package: '@microsoft/sp-http-base!' - fullName: 'post(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to "POST".' + fullName: post(url, configuration, options) + summary: Calls fetch(), but sets the method to "POST". remarks: '' isPreview: false isDeprecated: false @@ -248,12 +276,12 @@ methods: description: >- determines the default behavior of SPHttpClient; normally this should be the latest version number from SPHttpClientConfigurations - type: '' + type: - id: options description: additional options that affect the request - type: '' + type: return: - type: 'Promise<>' + type: Promise<> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with [HttpClientResponse.ok](xref:@microsoft/sp-http-base!HttpClientResponse%23ok:member) being false) for error diff --git a/SP-Framework/sp-http-base/sphttpclientbatch.yml b/SP-Framework/sp-http-base/sphttpclientbatch.yml index 70e43b7a..343d6e60 100644 --- a/SP-Framework/sp-http-base/sphttpclientbatch.yml +++ b/SP-Framework/sp-http-base/sphttpclientbatch.yml @@ -30,7 +30,7 @@ properties: syntax: content: 'static readonly configurations: ISPHttpClientBatchConfigurations;' return: - type: '' + type: methods: - name: execute() uid: '@microsoft/sp-http-base!SPHttpClientBatch#execute:member(1)' @@ -43,12 +43,12 @@ methods: syntax: content: 'execute(): Promise;' return: - type: 'Promise<>' + type: Promise<> description: '' - - name: 'fetch(url, configuration, options)' + - name: fetch(url, configuration, options) uid: '@microsoft/sp-http-base!SPHttpClientBatch#fetch:member(1)' package: '@microsoft/sp-http-base!' - fullName: 'fetch(url, configuration, options)' + fullName: fetch(url, configuration, options) summary: >- Queues a new request, and returns a promise that can be used to access the server response (after execute() has completed). @@ -81,22 +81,22 @@ methods: description: >- determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations - type: '' + type: - id: options description: additional options that affect the request - type: '' + type: return: - type: 'Promise<>' + type: Promise<> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with [HttpClientResponse.ok](xref:@microsoft/sp-http-base!HttpClientResponse%23ok:member) being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server. - - name: 'get(url, configuration, options)' + - name: get(url, configuration, options) uid: '@microsoft/sp-http-base!SPHttpClientBatch#get:member(1)' package: '@microsoft/sp-http-base!' - fullName: 'get(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to ''GET''.' + fullName: get(url, configuration, options) + summary: Calls fetch(), but sets the method to 'GET'. remarks: '' isPreview: true isDeprecated: false @@ -112,22 +112,22 @@ methods: description: >- determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations - type: '' + type: - id: options description: additional options that affect the request - type: '' + type: return: - type: 'Promise<>' + type: Promise<> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with [HttpClientResponse.ok](xref:@microsoft/sp-http-base!HttpClientResponse%23ok:member) being false) for error status codes such as HTTP 404 or 500. The promise will only reject for network failures or other errors that prevent communication with the server. - - name: 'post(url, configuration, options)' + - name: post(url, configuration, options) uid: '@microsoft/sp-http-base!SPHttpClientBatch#post:member(1)' package: '@microsoft/sp-http-base!' - fullName: 'post(url, configuration, options)' - summary: 'Calls fetch(), but sets the method to ''POST''.' + fullName: post(url, configuration, options) + summary: Calls fetch(), but sets the method to 'POST'. remarks: '' isPreview: true isDeprecated: false @@ -143,12 +143,12 @@ methods: description: >- determines the default behavior of this request; normally this should be the latest version number from SPHttpClientBatchConfigurations - type: '' + type: - id: options description: additional options that affect the request - type: '' + type: return: - type: 'Promise<>' + type: Promise<> description: >- A promise with behavior similar to WHATWG fetch(). This promise will resolve normally (with [HttpClientResponse.ok](xref:@microsoft/sp-http-base!HttpClientResponse%23ok:member) being false) for error diff --git a/SP-Framework/sp-http-base/sphttpclientbatchconfiguration.yml b/SP-Framework/sp-http-base/sphttpclientbatchconfiguration.yml index b76c38b2..a3199047 100644 --- a/SP-Framework/sp-http-base/sphttpclientbatchconfiguration.yml +++ b/SP-Framework/sp-http-base/sphttpclientbatchconfiguration.yml @@ -13,10 +13,10 @@ isPreview: true isDeprecated: false type: class constructors: - - name: '(constructor)(flags, overrideFlags)' + - name: (constructor)(flags, overrideFlags) uid: '@microsoft/sp-http-base!SPHttpClientBatchConfiguration:constructor(1)' package: '@microsoft/sp-http-base!' - fullName: '(constructor)(flags, overrideFlags)' + fullName: (constructor)(flags, overrideFlags) summary: >- Constructs a new instance of SPHttpClientBatchConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. @@ -28,10 +28,10 @@ constructors: parameters: - id: flags description: '' - type: '' + type: - id: overrideFlags description: '' - type: '' + type: properties: - name: flags uid: '@microsoft/sp-http-base!SPHttpClientBatchConfiguration#flags:member' @@ -44,7 +44,7 @@ properties: syntax: content: 'protected flags: ISPHttpClientBatchConfiguration;' return: - type: '' + type: methods: - name: initializeFlags() uid: '@microsoft/sp-http-base!SPHttpClientBatchConfiguration#initializeFlags:member(1)' @@ -76,8 +76,8 @@ methods: parameters: - id: sourceFlags description: '' - type: '' + type: return: - type: '' + type: description: '' -extends: '' +extends: diff --git a/SP-Framework/sp-http-base/sphttpclientcommonconfiguration.yml b/SP-Framework/sp-http-base/sphttpclientcommonconfiguration.yml index 0adb3b93..8dfb52ef 100644 --- a/SP-Framework/sp-http-base/sphttpclientcommonconfiguration.yml +++ b/SP-Framework/sp-http-base/sphttpclientcommonconfiguration.yml @@ -9,10 +9,10 @@ isPreview: false isDeprecated: false type: class constructors: - - name: '(constructor)(flags, overrideFlags)' + - name: (constructor)(flags, overrideFlags) uid: '@microsoft/sp-http-base!SPHttpClientCommonConfiguration:constructor(1)' package: '@microsoft/sp-http-base!' - fullName: '(constructor)(flags, overrideFlags)' + fullName: (constructor)(flags, overrideFlags) summary: Constructs a new instance of SPHttpClientCommonConfiguration with the specified flags. remarks: >- The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it @@ -24,10 +24,10 @@ constructors: parameters: - id: flags description: '' - type: '' + type: - id: overrideFlags description: '' - type: '' + type: properties: - name: flags uid: '@microsoft/sp-http-base!SPHttpClientCommonConfiguration#flags:member' @@ -40,7 +40,7 @@ properties: syntax: content: 'protected flags: ISPHttpClientCommonConfiguration;' return: - type: '' + type: - name: jsonRequest uid: '@microsoft/sp-http-base!SPHttpClientCommonConfiguration#jsonRequest:member' package: '@microsoft/sp-http-base!' @@ -114,8 +114,8 @@ methods: parameters: - id: sourceFlags description: '' - type: '' + type: return: - type: '' + type: description: '' -extends: '' +extends: diff --git a/SP-Framework/sp-http-base/sphttpclientconfiguration.yml b/SP-Framework/sp-http-base/sphttpclientconfiguration.yml index c1973f22..fbca7373 100644 --- a/SP-Framework/sp-http-base/sphttpclientconfiguration.yml +++ b/SP-Framework/sp-http-base/sphttpclientconfiguration.yml @@ -3,7 +3,7 @@ name: SPHttpClientConfiguration uid: '@microsoft/sp-http-base!SPHttpClientConfiguration:class' package: '@microsoft/sp-http-base!' fullName: SPHttpClientConfiguration -summary: 'Configuration for [SPHttpClient](xref:@microsoft/sp-http-base!SPHttpClient:class).' +summary: Configuration for [SPHttpClient](xref:@microsoft/sp-http-base!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 @@ -13,10 +13,10 @@ isPreview: false isDeprecated: false type: class constructors: - - name: '(constructor)(flags, overrideFlags)' + - name: (constructor)(flags, overrideFlags) uid: '@microsoft/sp-http-base!SPHttpClientConfiguration:constructor(1)' package: '@microsoft/sp-http-base!' - fullName: '(constructor)(flags, overrideFlags)' + fullName: (constructor)(flags, overrideFlags) summary: >- Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags. @@ -28,10 +28,10 @@ constructors: parameters: - id: flags description: '' - type: '' + type: - id: overrideFlags description: '' - type: '' + type: properties: - name: defaultODataVersion uid: '@microsoft/sp-http-base!SPHttpClientConfiguration#defaultODataVersion:member' @@ -50,7 +50,7 @@ properties: syntax: content: 'get defaultODataVersion(): ODataVersion;' return: - type: '' + type: - name: defaultSameOriginCredentials uid: '@microsoft/sp-http-base!SPHttpClientConfiguration#defaultSameOriginCredentials:member' package: '@microsoft/sp-http-base!' @@ -82,7 +82,7 @@ properties: syntax: content: 'protected flags: ISPHttpClientConfiguration;' return: - type: '' + type: - name: requestDigest uid: '@microsoft/sp-http-base!SPHttpClientConfiguration#requestDigest:member' package: '@microsoft/sp-http-base!' @@ -101,6 +101,20 @@ properties: content: 'get requestDigest(): boolean;' return: type: boolean + - name: usePopupForCookieRefresh + uid: '@microsoft/sp-http-base!SPHttpClientConfiguration#usePopupForCookieRefresh:member' + package: '@microsoft/sp-http-base!' + fullName: usePopupForCookieRefresh + summary: Handle cookie refresh with a popup dialog + remarks: >- + When this switch is true popup auth will be used for handling a cookie refresh. This means the caller must handle + the popup events. If it is undefined or false full page redirect will be defaulted to. + isPreview: false + isDeprecated: false + syntax: + content: 'get usePopupForCookieRefresh(): boolean;' + return: + type: boolean methods: - name: initializeFlags() uid: '@microsoft/sp-http-base!SPHttpClientConfiguration#initializeFlags:member(1)' @@ -132,8 +146,8 @@ methods: parameters: - id: sourceFlags description: '' - type: '' + type: return: - type: '' + type: description: '' -extends: '' +extends: diff --git a/SP-Framework/sp-http-base/sphttpclientresponse.yml b/SP-Framework/sp-http-base/sphttpclientresponse.yml index 430a3c4d..eed539e9 100644 --- a/SP-Framework/sp-http-base/sphttpclientresponse.yml +++ b/SP-Framework/sp-http-base/sphttpclientresponse.yml @@ -41,12 +41,12 @@ properties: syntax: content: 'get correlationId(): Guid | undefined;' return: - type: ' | undefined' + type: | undefined - name: statusMessage uid: '@microsoft/sp-http-base!SPHttpClientResponse#statusMessage:member' package: '@microsoft/sp-http-base!' fullName: statusMessage - summary: 'User-friendly status message that includes the HTTP status, with the correlation id and version of the server.' + summary: User-friendly status message that includes the HTTP status, with the correlation id and version of the server. remarks: '' isPreview: true isDeprecated: false @@ -68,6 +68,6 @@ methods: /** @override */ clone(): SPHttpClientResponse; return: - type: '' + type: description: '' -extends: '' +extends: diff --git a/SP-Framework/sp-http-base/sphttpheader.yml b/SP-Framework/sp-http-base/sphttpheader.yml index 97a93245..bd57ceec 100644 --- a/SP-Framework/sp-http-base/sphttpheader.yml +++ b/SP-Framework/sp-http-base/sphttpheader.yml @@ -3,7 +3,7 @@ name: SPHttpHeader uid: '@microsoft/sp-http-base!SPHttpHeader:enum' package: '@microsoft/sp-http-base!' fullName: SPHttpHeader -summary: 'Standard HTTP headers used with [SPHttpClient](xref:@microsoft/sp-http-base!SPHttpClient:class)' +summary: Standard HTTP headers used with [SPHttpClient](xref:@microsoft/sp-http-base!SPHttpClient:class) remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-http-base/tokenacquisitioneventargs.yml b/SP-Framework/sp-http-base/tokenacquisitioneventargs.yml index 2dd42e5d..bfba69f3 100644 --- a/SP-Framework/sp-http-base/tokenacquisitioneventargs.yml +++ b/SP-Framework/sp-http-base/tokenacquisitioneventargs.yml @@ -9,10 +9,10 @@ isPreview: false isDeprecated: false type: class constructors: - - name: '(constructor)(message, redirectUrl)' + - name: (constructor)(message, redirectUrl) uid: '@microsoft/sp-http-base!TokenAcquisitionEventArgs:constructor(1)' package: '@microsoft/sp-http-base!' - fullName: '(constructor)(message, redirectUrl)' + fullName: (constructor)(message, redirectUrl) summary: Constructs a new instance of the `TokenAcquisitionEventArgs` class remarks: '' isPreview: false @@ -51,4 +51,4 @@ properties: content: 'redirectUrl?: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-http-msgraph/graphrequest.yml b/SP-Framework/sp-http-msgraph/graphrequest.yml index 8bf0b355..4d9aed9f 100644 --- a/SP-Framework/sp-http-msgraph/graphrequest.yml +++ b/SP-Framework/sp-http-msgraph/graphrequest.yml @@ -52,7 +52,7 @@ properties: syntax: content: 'config: Options;' return: - type: '' + type: - name: urlComponents uid: '@microsoft/sp-http-msgraph!GraphRequest#urlComponents:member' package: '@microsoft/sp-http-msgraph!' @@ -64,7 +64,7 @@ properties: syntax: content: 'urlComponents: URLComponents;' return: - type: '' + type: methods: - name: buildFullUrl() uid: '@microsoft/sp-http-msgraph!GraphRequest#buildFullUrl:member(1)' @@ -79,10 +79,10 @@ methods: return: type: string description: '' - - name: 'constructor(config, path)' + - name: constructor(config, path) uid: '@microsoft/sp-http-msgraph!GraphRequest#constructor:member(1)' package: '@microsoft/sp-http-msgraph!' - fullName: 'constructor(config, path)' + fullName: constructor(config, path) summary: '' remarks: '' isPreview: false @@ -92,12 +92,12 @@ methods: parameters: - id: config description: '' - type: '' + type: - id: path description: '' type: string return: - type: '' + type: description: '' - name: count(count) uid: '@microsoft/sp-http-msgraph!GraphRequest#count:member(1)' @@ -114,12 +114,12 @@ methods: description: '' type: boolean return: - type: '' + type: description: '' - - name: 'create(content, callback)' + - name: create(content, callback) uid: '@microsoft/sp-http-msgraph!GraphRequest#create:member(1)' package: '@microsoft/sp-http-msgraph!' - fullName: 'create(content, callback)' + fullName: create(content, callback) summary: '' remarks: '' isPreview: false @@ -132,7 +132,7 @@ methods: type: any - id: callback description: '' - type: '' + type: return: type: Promise<any> description: '' @@ -149,7 +149,7 @@ methods: parameters: - id: callback description: '' - type: '' + type: return: type: Promise<any> description: '' @@ -166,7 +166,7 @@ methods: parameters: - id: callback description: '' - type: '' + type: return: type: Promise<any> description: '' @@ -183,9 +183,9 @@ methods: parameters: - id: properties description: '' - type: 'string | string[]' + type: string | string[] return: - type: '' + type: description: '' - name: filter(filterStr) uid: '@microsoft/sp-http-msgraph!GraphRequest#filter:member(1)' @@ -202,7 +202,7 @@ methods: description: '' type: string return: - type: '' + type: description: '' - name: get(callback) uid: '@microsoft/sp-http-msgraph!GraphRequest#get:member(1)' @@ -217,7 +217,7 @@ methods: parameters: - id: callback description: '' - type: '' + type: return: type: Promise<any> description: '' @@ -234,14 +234,14 @@ methods: parameters: - id: callback description: '' - type: '' + type: return: type: void description: '' - - name: 'header(headerKey, headerValue)' + - name: header(headerKey, headerValue) uid: '@microsoft/sp-http-msgraph!GraphRequest#header:member(1)' package: '@microsoft/sp-http-msgraph!' - fullName: 'header(headerKey, headerValue)' + fullName: header(headerKey, headerValue) summary: '' remarks: '' isPreview: false @@ -294,9 +294,9 @@ methods: parameters: - id: properties description: '' - type: 'string | string[]' + type: string | string[] return: - type: '' + type: description: '' - name: parsePath(rawPath) uid: '@microsoft/sp-http-msgraph!GraphRequest#parsePath:member(1)' @@ -315,10 +315,10 @@ methods: return: type: void description: '' - - name: 'patch(content, callback)' + - name: patch(content, callback) uid: '@microsoft/sp-http-msgraph!GraphRequest#patch:member(1)' package: '@microsoft/sp-http-msgraph!' - fullName: 'patch(content, callback)' + fullName: patch(content, callback) summary: '' remarks: '' isPreview: false @@ -331,14 +331,14 @@ methods: type: any - id: callback description: '' - type: '' + type: return: type: Promise<any> description: '' - - name: 'post(content, callback)' + - name: post(content, callback) uid: '@microsoft/sp-http-msgraph!GraphRequest#post:member(1)' package: '@microsoft/sp-http-msgraph!' - fullName: 'post(content, callback)' + fullName: post(content, callback) summary: '' remarks: '' isPreview: false @@ -351,14 +351,14 @@ methods: type: any - id: callback description: '' - type: '' + type: return: type: Promise<any> description: '' - - name: 'put(content, callback)' + - name: put(content, callback) uid: '@microsoft/sp-http-msgraph!GraphRequest#put:member(1)' package: '@microsoft/sp-http-msgraph!' - fullName: 'put(content, callback)' + fullName: put(content, callback) summary: '' remarks: '' isPreview: false @@ -371,14 +371,14 @@ methods: type: any - id: callback description: '' - type: '' + type: return: type: Promise<any> description: '' - - name: 'putStream(stream, callback)' + - name: putStream(stream, callback) uid: '@microsoft/sp-http-msgraph!GraphRequest#putStream:member(1)' package: '@microsoft/sp-http-msgraph!' - fullName: 'putStream(stream, callback)' + fullName: putStream(stream, callback) summary: '' remarks: '' isPreview: false @@ -391,7 +391,7 @@ methods: type: any - id: callback description: '' - type: '' + type: return: type: void description: '' @@ -416,7 +416,7 @@ methods: [key: string]: string | number; } return: - type: '' + type: description: '' - name: responseType(responseType) uid: '@microsoft/sp-http-msgraph!GraphRequest#responseType:member(1)' @@ -433,7 +433,7 @@ methods: description: '' type: string return: - type: '' + type: description: '' - name: select(properties) uid: '@microsoft/sp-http-msgraph!GraphRequest#select:member(1)' @@ -448,9 +448,9 @@ methods: parameters: - id: properties description: '' - type: 'string | string[]' + type: string | string[] return: - type: '' + type: description: '' - name: skip(n) uid: '@microsoft/sp-http-msgraph!GraphRequest#skip:member(1)' @@ -467,7 +467,7 @@ methods: description: '' type: number return: - type: '' + type: description: '' - name: skipToken(token) uid: '@microsoft/sp-http-msgraph!GraphRequest#skipToken:member(1)' @@ -484,7 +484,7 @@ methods: description: '' type: string return: - type: '' + type: description: '' - name: top(n) uid: '@microsoft/sp-http-msgraph!GraphRequest#top:member(1)' @@ -501,12 +501,12 @@ methods: description: '' type: number return: - type: '' + type: description: '' - - name: 'update(content, callback)' + - name: update(content, callback) uid: '@microsoft/sp-http-msgraph!GraphRequest#update:member(1)' package: '@microsoft/sp-http-msgraph!' - fullName: 'update(content, callback)' + fullName: update(content, callback) summary: '' remarks: '' isPreview: false @@ -519,7 +519,7 @@ methods: type: any - id: callback description: '' - type: '' + type: return: type: Promise<any> description: '' @@ -538,5 +538,5 @@ methods: description: '' type: string return: - type: '' + type: description: '' diff --git a/SP-Framework/sp-http-msgraph/msgraphclient.yml b/SP-Framework/sp-http-msgraph/msgraphclient.yml index 3386c606..f1848b01 100644 --- a/SP-Framework/sp-http-msgraph/msgraphclient.yml +++ b/SP-Framework/sp-http-msgraph/msgraphclient.yml @@ -21,10 +21,10 @@ isPreview: false isDeprecated: false type: class methods: - - name: 'api(path, config)' + - name: api(path, config) uid: '@microsoft/sp-http-msgraph!MSGraphClient#api:member(1)' package: '@microsoft/sp-http-msgraph!' - fullName: 'api(path, config)' + fullName: api(path, config) summary: All calls to Microsoft Graph are chained together starting with the api function. remarks: >- Path supports the following formats: \* me \* /me \* https://graph.microsoft.com/v1.0/me \* @@ -43,7 +43,7 @@ methods: type: string - id: config description: Sets the configuration for this request. - type: '' + type: return: - type: '' + type: description: '' diff --git a/SP-Framework/sp-http-msgraph/msgraphclientfactory.yml b/SP-Framework/sp-http-msgraph/msgraphclientfactory.yml index 5f6c12c0..51b27e50 100644 --- a/SP-Framework/sp-http-msgraph/msgraphclientfactory.yml +++ b/SP-Framework/sp-http-msgraph/msgraphclientfactory.yml @@ -45,12 +45,12 @@ methods: description: '' type: '''3''' return: - type: 'Promise<>' + type: Promise<> description: '' - - name: 'getClientWithMiddleware(version, options)' + - name: getClientWithMiddleware(version, options) uid: '@microsoft/sp-http-msgraph!MSGraphClientFactory#getClientWithMiddleware:member(1)' package: '@microsoft/sp-http-msgraph!' - fullName: 'getClientWithMiddleware(version, options)' + fullName: getClientWithMiddleware(version, options) summary: >- Returns an instance of the MSGraphClient that communicates with the current tenant's configurable Service Pricipal. Allows to specify custom middleware options. @@ -65,7 +65,7 @@ methods: type: '''3''' - id: options description: Client options for the Graph API. - type: '' + type: return: - type: 'Promise<>' + type: Promise<> description: '' diff --git a/SP-Framework/sp-http-msgraph/msgraphclientv3.yml b/SP-Framework/sp-http-msgraph/msgraphclientv3.yml index 42639d25..2a995b4f 100644 --- a/SP-Framework/sp-http-msgraph/msgraphclientv3.yml +++ b/SP-Framework/sp-http-msgraph/msgraphclientv3.yml @@ -32,7 +32,7 @@ properties: syntax: content: 'get client(): Client;' return: - type: '' + type: methods: - name: api(path) uid: '@microsoft/sp-http-msgraph!MSGraphClientV3#api:member(1)' @@ -55,5 +55,5 @@ methods: description: The path for the request to MSGraph. type: string return: - type: '' + type: description: '' diff --git a/SP-Framework/sp-image-helper/iimagehelperrequest.yml b/SP-Framework/sp-image-helper/iimagehelperrequest.yml index 4ef18244..8a5c2cce 100644 --- a/SP-Framework/sp-image-helper/iimagehelperrequest.yml +++ b/SP-Framework/sp-image-helper/iimagehelperrequest.yml @@ -53,7 +53,7 @@ properties: package: '@microsoft/sp-image-helper!' fullName: width summary: Width of the image requested. - remarks: 'When the height is unspecified, the width is mapped to nearest larger resolution breakpoint with a maximum size.' + remarks: When the height is unspecified, the width is mapped to nearest larger resolution breakpoint with a maximum size. isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-image-helper/imagehelper.yml b/SP-Framework/sp-image-helper/imagehelper.yml index 5bbb871a..e126fa0f 100644 --- a/SP-Framework/sp-image-helper/imagehelper.yml +++ b/SP-Framework/sp-image-helper/imagehelper.yml @@ -26,7 +26,7 @@ methods: parameters: - id: request description: IImageHelperRequest for the bundled parameters. - type: '' + type: return: type: string description: >- diff --git a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml index afaff990..94e01d1d 100644 --- a/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml +++ b/SP-Framework/sp-list-subscription/icreatesubscriptionsettings.yml @@ -27,12 +27,12 @@ properties: syntax: content: 'callbacks: ISubscriptionCallbacks;' return: - type: '' + type: - name: domain uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#domain:member' package: '@microsoft/sp-list-subscription!' fullName: domain - summary: 'In the case of a multi-geography tenancy, you need to provide the domain that the site collection lives in.' + summary: In the case of a multi-geography tenancy, you need to provide the domain that the site collection lives in. remarks: '' isPreview: false isDeprecated: false @@ -44,14 +44,14 @@ properties: uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#listId:member' package: '@microsoft/sp-list-subscription!' fullName: listId - summary: 'The Guid of the Sharepoint List. At this point, it needs to be a document library, and not just a list.' + summary: The Guid of the Sharepoint List. At this point, it needs to be a document library, and not just a list. remarks: '' isPreview: false isDeprecated: false syntax: content: 'listId?: Guid;' return: - type: '' + type: - name: siteId uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#siteId:member' package: '@microsoft/sp-list-subscription!' @@ -65,7 +65,7 @@ properties: syntax: content: 'siteId?: Guid;' return: - type: '' + type: - name: webId uid: '@microsoft/sp-list-subscription!ICreateSubscriptionSettings#webId:member' package: '@microsoft/sp-list-subscription!' @@ -79,4 +79,4 @@ properties: syntax: content: 'webId?: Guid;' return: - type: '' + type: diff --git a/SP-Framework/sp-list-subscription/ilistsubscription.yml b/SP-Framework/sp-list-subscription/ilistsubscription.yml index 8d7a766d..d7027675 100644 --- a/SP-Framework/sp-list-subscription/ilistsubscription.yml +++ b/SP-Framework/sp-list-subscription/ilistsubscription.yml @@ -20,4 +20,4 @@ properties: syntax: content: 'id: Guid;' return: - type: '' + type: diff --git a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml index 0c147391..be5f5199 100644 --- a/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml +++ b/SP-Framework/sp-list-subscription/listsubscriptionfactory.yml @@ -24,7 +24,7 @@ constructors: parameters: - id: component description: '' - type: '' + type: methods: - name: createSubscription(settings) uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#createSubscription:member(1)' @@ -39,9 +39,9 @@ methods: parameters: - id: settings description: The various parameters - type: '' + type: return: - type: 'Promise<>' + type: Promise<> description: Promise of the subscription to the list. - name: deleteSubscription(subscription) uid: '@microsoft/sp-list-subscription!ListSubscriptionFactory#deleteSubscription:member(1)' @@ -56,7 +56,7 @@ methods: parameters: - id: subscription description: The subscription to delete. - type: '' + type: return: type: void description: '' diff --git a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml index 4d1821fb..9cf2fd6a 100644 --- a/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/basefieldcustomizer.yml @@ -28,7 +28,7 @@ properties: syntax: content: 'protected readonly context: FieldCustomizerContext;' return: - type: '' + type: methods: - name: onDisposeCell(event) uid: '@microsoft/sp-listview-extensibility!BaseFieldCustomizer#onDisposeCell:member(1)' @@ -43,7 +43,7 @@ methods: parameters: - id: event description: '' - type: '' + type: return: type: void description: '' @@ -60,8 +60,8 @@ methods: parameters: - id: event description: '' - type: '' + type: return: type: void description: '' -extends: '<TProperties>' +extends: <TProperties> diff --git a/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml b/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml index 1711f3b2..03d8ed04 100644 --- a/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml +++ b/SP-Framework/sp-listview-extensibility/baseformcustomizer.yml @@ -25,7 +25,7 @@ properties: syntax: content: 'readonly context: FormCustomizerContext;' return: - type: '' + type: - name: displayMode uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#displayMode:member' package: '@microsoft/sp-listview-extensibility!' @@ -37,7 +37,7 @@ properties: syntax: content: 'protected get displayMode(): FormDisplayMode;' return: - type: '' + type: - name: domElement uid: '@microsoft/sp-listview-extensibility!BaseFormCustomizer#domElement:member' package: '@microsoft/sp-listview-extensibility!' @@ -58,7 +58,7 @@ methods: package: '@microsoft/sp-listview-extensibility!' fullName: dispose() summary: Disposes the component. - remarks: 'Please, do not override this method. Override the `onDispose` method instead.' + remarks: Please, do not override this method. Override the `onDispose` method instead. isPreview: false isDeprecated: false syntax: @@ -107,4 +107,4 @@ methods: return: type: void description: '' -extends: '<TProperties>' +extends: <TProperties> diff --git a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml index d9c73113..c9bc24e5 100644 --- a/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml +++ b/SP-Framework/sp-listview-extensibility/baselistviewcommandset.yml @@ -6,7 +6,7 @@ fullName: BaseListViewCommandSet summary: >- This is the base class that third parties should extend when implementing a client-side extension that provides a command set for a SharePoint list view. -remarks: 'In the component manifest, the "extensionType" should be set to "ListViewCommandSet".' +remarks: In the component manifest, the "extensionType" should be set to "ListViewCommandSet". isPreview: false isDeprecated: false type: class @@ -25,7 +25,7 @@ properties: syntax: content: 'readonly context: ListViewCommandSetContext;' return: - type: '' + type: methods: - name: onExecute(event) uid: '@microsoft/sp-listview-extensibility!BaseListViewCommandSet#onExecute:member(1)' @@ -42,7 +42,7 @@ methods: parameters: - id: event description: '' - type: '' + type: return: type: void description: '' @@ -60,7 +60,7 @@ methods: parameters: - id: event description: '' - type: '' + type: return: type: void description: '' @@ -92,6 +92,6 @@ methods: description: Id of the command type: string return: - type: '' + type: description: '' -extends: '<TProperties>' +extends: <TProperties> diff --git a/SP-Framework/sp-listview-extensibility/columnaccessor.yml b/SP-Framework/sp-listview-extensibility/columnaccessor.yml index 8d62ec6f..71d766ac 100644 --- a/SP-Framework/sp-listview-extensibility/columnaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/columnaccessor.yml @@ -3,7 +3,7 @@ name: ColumnAccessor uid: '@microsoft/sp-listview-extensibility!ColumnAccessor:class' package: '@microsoft/sp-listview-extensibility!' fullName: ColumnAccessor -summary: 'Provides access to a ListView column, which is the visual presentation of a field.' +summary: Provides access to a ListView column, which is the visual presentation of a field. remarks: >- A SharePoint "field" (SPField) defines the data storage for a property of a list item. (If the list item represents a document, then the field is sometimes called a "property".) @@ -29,7 +29,7 @@ properties: syntax: content: 'abstract get field(): SPField;' return: - type: '' + type: - name: visible uid: '@microsoft/sp-listview-extensibility!ColumnAccessor#visible:member' package: '@microsoft/sp-listview-extensibility!' diff --git a/SP-Framework/sp-listview-extensibility/command.yml b/SP-Framework/sp-listview-extensibility/command.yml index b3bdd3f6..b1d7ac1e 100644 --- a/SP-Framework/sp-listview-extensibility/command.yml +++ b/SP-Framework/sp-listview-extensibility/command.yml @@ -71,7 +71,7 @@ properties: uid: '@microsoft/sp-listview-extensibility!Command#title:member' package: '@microsoft/sp-listview-extensibility!' fullName: title - summary: 'A short label to be displayed by the associated button, menu item, etc.' + summary: A short label to be displayed by the associated button, menu item, etc. remarks: >- Example: "Show information" diff --git a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml index 90829714..3aa39af6 100644 --- a/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/fieldcustomizercontext.yml @@ -22,7 +22,7 @@ properties: syntax: content: 'get field(): SPField;' return: - type: '' + type: methods: - name: tryGetListView() uid: '@microsoft/sp-listview-extensibility!FieldCustomizerContext#tryGetListView:member(1)' @@ -39,6 +39,6 @@ methods: syntax: content: 'tryGetListView(): ListViewAccessor | undefined;' return: - type: ' | undefined' - description: 'the SharePoint list view, or undefined if there is none.' -extends: '' + type: | undefined + description: the SharePoint list view, or undefined if there is none. +extends: diff --git a/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml index e0fa190a..a5ff95c8 100644 --- a/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/formcustomizercontext.yml @@ -9,10 +9,10 @@ isPreview: false isDeprecated: false type: class constructors: - - name: '(constructor)(extensionContextParameters, formCustomizerContextParameters)' + - name: (constructor)(extensionContextParameters, formCustomizerContextParameters) uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext:constructor(1)' package: '@microsoft/sp-listview-extensibility!' - fullName: '(constructor)(extensionContextParameters, formCustomizerContextParameters)' + fullName: (constructor)(extensionContextParameters, formCustomizerContextParameters) summary: Constructs a new instance of the `FormCustomizerContext` class remarks: '' isPreview: false @@ -24,10 +24,10 @@ constructors: parameters: - id: extensionContextParameters description: '' - type: '' + type: - id: formCustomizerContextParameters description: '' - type: '' + type: properties: - name: contentType uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#contentType:member' @@ -40,7 +40,7 @@ properties: syntax: content: 'get contentType(): IContentType;' return: - type: '' + type: - name: domElement uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#domElement:member' package: '@microsoft/sp-listview-extensibility!' @@ -64,7 +64,7 @@ properties: syntax: content: 'get folderInfo(): IFolderInfo;' return: - type: '' + type: - name: item uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#item:member' package: '@microsoft/sp-listview-extensibility!' @@ -76,7 +76,7 @@ properties: syntax: content: 'get item(): IListItem | undefined;' return: - type: ' | undefined' + type: | undefined - name: itemId uid: '@microsoft/sp-listview-extensibility!FormCustomizerContext#itemId:member' package: '@microsoft/sp-listview-extensibility!' @@ -100,5 +100,5 @@ properties: syntax: content: 'get list(): IList;' return: - type: '' -extends: '' + type: +extends: diff --git a/SP-Framework/sp-listview-extensibility/icolumn.yml b/SP-Framework/sp-listview-extensibility/icolumn.yml index 6452dcb3..cf585b6a 100644 --- a/SP-Framework/sp-listview-extensibility/icolumn.yml +++ b/SP-Framework/sp-listview-extensibility/icolumn.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'readonly clientSideComponentId: Guid | undefined;' return: - type: ' | undefined' + type: | undefined - name: clientSideComponentProperties uid: '@microsoft/sp-listview-extensibility!IColumn#clientSideComponentProperties:member' package: '@microsoft/sp-listview-extensibility!' @@ -70,7 +70,7 @@ properties: syntax: content: 'readonly id: Guid;' return: - type: '' + type: - name: internalName uid: '@microsoft/sp-listview-extensibility!IColumn#internalName:member' package: '@microsoft/sp-listview-extensibility!' diff --git a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml index f412a1b3..99ba3389 100644 --- a/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ifieldcustomizercelleventparameters.yml @@ -46,7 +46,7 @@ properties: syntax: content: 'readonly listItem: ListItemAccessor;' return: - type: '' + type: - name: userData uid: '@microsoft/sp-listview-extensibility!IFieldCustomizerCellEventParameters#userData:member' package: '@microsoft/sp-listview-extensibility!' diff --git a/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml b/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml index 39cb2322..a3e1e606 100644 --- a/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml +++ b/SP-Framework/sp-listview-extensibility/iformcustomizercontext.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'readonly contentType: IContentType;' return: - type: '' + type: - name: domElement uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#domElement:member' package: '@microsoft/sp-listview-extensibility!' @@ -44,7 +44,7 @@ properties: syntax: content: 'readonly folderInfo: IFolderInfo;' return: - type: '' + type: - name: item uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#item:member' package: '@microsoft/sp-listview-extensibility!' @@ -56,7 +56,7 @@ properties: syntax: content: 'readonly item?: IListItem;' return: - type: '' + type: - name: itemId uid: '@microsoft/sp-listview-extensibility!IFormCustomizerContext#itemId:member' package: '@microsoft/sp-listview-extensibility!' @@ -80,4 +80,4 @@ properties: syntax: content: 'readonly list: IList;' return: - type: '' + type: diff --git a/SP-Framework/sp-listview-extensibility/ilist.yml b/SP-Framework/sp-listview-extensibility/ilist.yml index 7eefb88d..f7b4b848 100644 --- a/SP-Framework/sp-listview-extensibility/ilist.yml +++ b/SP-Framework/sp-listview-extensibility/ilist.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'readonly guid: Guid;' return: - type: '' + type: - name: serverRelativeUrl uid: '@microsoft/sp-listview-extensibility!IList#serverRelativeUrl:member' package: '@microsoft/sp-listview-extensibility!' diff --git a/SP-Framework/sp-listview-extensibility/ilistitem.yml b/SP-Framework/sp-listview-extensibility/ilistitem.yml index efe1a163..3de2203a 100644 --- a/SP-Framework/sp-listview-extensibility/ilistitem.yml +++ b/SP-Framework/sp-listview-extensibility/ilistitem.yml @@ -8,4 +8,4 @@ remarks: '' isPreview: false isDeprecated: false type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml b/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml index 6906f700..719ca75e 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewaccessorstate.yml @@ -38,7 +38,7 @@ properties: syntax: content: 'readonly columns: ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: ReadonlyArray<> - name: folderInfo uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#folderInfo:member' package: '@microsoft/sp-listview-extensibility!' @@ -50,7 +50,7 @@ properties: syntax: content: 'readonly folderInfo?: IFolderInfo;' return: - type: '' + type: - name: list uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#list:member' package: '@microsoft/sp-listview-extensibility!' @@ -62,7 +62,7 @@ properties: syntax: content: 'readonly list?: IList;' return: - type: '' + type: - name: rows uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#rows:member' package: '@microsoft/sp-listview-extensibility!' @@ -74,7 +74,7 @@ properties: syntax: content: 'readonly rows: ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: ReadonlyArray<> - name: selectedRows uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#selectedRows:member' package: '@microsoft/sp-listview-extensibility!' @@ -86,7 +86,7 @@ properties: syntax: content: 'readonly selectedRows?: ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: ReadonlyArray<> - name: sortAscending uid: '@microsoft/sp-listview-extensibility!IListViewAccessorState#sortAscending:member' package: '@microsoft/sp-listview-extensibility!' @@ -122,4 +122,4 @@ properties: syntax: content: 'readonly view?: IView;' return: - type: '' + type: diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml index badadd67..80e63ab8 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetexecuteeventparameters.yml @@ -29,11 +29,11 @@ properties: uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetExecuteEventParameters#selectedRows:member' package: '@microsoft/sp-listview-extensibility!' fullName: selectedRows - summary: 'The currently selected ListView rows, at the time when the event occurred.' + summary: The currently selected ListView rows, at the time when the event occurred. remarks: '' isPreview: false isDeprecated: false syntax: content: 'readonly selectedRows: ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: ReadonlyArray<> diff --git a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml index c95c3b25..36ad1c80 100644 --- a/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml +++ b/SP-Framework/sp-listview-extensibility/ilistviewcommandsetlistviewupdatedparameters.yml @@ -15,11 +15,11 @@ properties: uid: '@microsoft/sp-listview-extensibility!IListViewCommandSetListViewUpdatedParameters#selectedRows:member' package: '@microsoft/sp-listview-extensibility!' fullName: selectedRows - summary: 'The currently selected ListView rows, at the time when the event occurred.' + summary: The currently selected ListView rows, at the time when the event occurred. remarks: '' isPreview: false isDeprecated: false syntax: content: 'readonly selectedRows: ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: ReadonlyArray<> diff --git a/SP-Framework/sp-listview-extensibility/iview.yml b/SP-Framework/sp-listview-extensibility/iview.yml index 9f411449..453afc05 100644 --- a/SP-Framework/sp-listview-extensibility/iview.yml +++ b/SP-Framework/sp-listview-extensibility/iview.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'readonly id: Guid;' return: - type: '' + type: - name: title uid: '@microsoft/sp-listview-extensibility!IView#title:member' package: '@microsoft/sp-listview-extensibility!' diff --git a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml index 9074d0ee..97f710ab 100644 --- a/SP-Framework/sp-listview-extensibility/listitemaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listitemaccessor.yml @@ -36,7 +36,7 @@ properties: syntax: content: 'abstract get fields(): ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: ReadonlyArray<> methods: - name: getValue(field) uid: '@microsoft/sp-listview-extensibility!ListItemAccessor#getValue:member(1)' @@ -53,7 +53,7 @@ methods: parameters: - id: field description: '' - type: '' + type: return: type: any description: '' diff --git a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml index 84915bf5..f6cb05e8 100644 --- a/SP-Framework/sp-listview-extensibility/listviewaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/listviewaccessor.yml @@ -33,14 +33,14 @@ properties: uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#columns:member' package: '@microsoft/sp-listview-extensibility!' fullName: columns - summary: 'The columns in associated with this view, including hidden columns.' + summary: The columns in associated with this view, including hidden columns. remarks: '' isPreview: false isDeprecated: false syntax: content: 'abstract get columns(): ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: ReadonlyArray<> - name: folderInfo uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#folderInfo:member' package: '@microsoft/sp-listview-extensibility!' @@ -52,7 +52,7 @@ properties: syntax: content: 'abstract get folderInfo(): IFolderInfo | undefined;' return: - type: ' | undefined' + type: | undefined - name: list uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#list:member' package: '@microsoft/sp-listview-extensibility!' @@ -64,7 +64,7 @@ properties: syntax: content: 'abstract get list(): IList | undefined;' return: - type: ' | undefined' + type: | undefined - name: rows uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#rows:member' package: '@microsoft/sp-listview-extensibility!' @@ -76,7 +76,7 @@ properties: syntax: content: 'abstract get rows(): ReadonlyArray;' return: - type: 'ReadonlyArray<>' + type: ReadonlyArray<> - name: selectedRows uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#selectedRows:member' package: '@microsoft/sp-listview-extensibility!' @@ -88,7 +88,7 @@ properties: syntax: content: 'abstract get selectedRows(): ReadonlyArray | undefined;' return: - type: 'ReadonlyArray<> | undefined' + type: ReadonlyArray<> | undefined - name: sortAscending uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#sortAscending:member' package: '@microsoft/sp-listview-extensibility!' @@ -124,7 +124,7 @@ properties: syntax: content: 'abstract get view(): IView | undefined;' return: - type: ' | undefined' + type: | undefined methods: - name: tryGetColumnByName(internalName) uid: '@microsoft/sp-listview-extensibility!ListViewAccessor#tryGetColumnByName:member(1)' @@ -143,7 +143,7 @@ methods: description: '' type: string return: - type: ' | undefined' + type: | undefined description: '' events: - name: listViewStateChangedEvent diff --git a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml index b773cab2..beb5e0b1 100644 --- a/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml +++ b/SP-Framework/sp-listview-extensibility/listviewcommandsetcontext.yml @@ -22,7 +22,7 @@ properties: syntax: content: 'get listView(): ListViewAccessor;' return: - type: '' + type: - name: manifest uid: '@microsoft/sp-listview-extensibility!ListViewCommandSetContext#manifest:member' package: '@microsoft/sp-listview-extensibility!' @@ -34,5 +34,5 @@ properties: syntax: content: 'readonly manifest: ICommandSetExtensionManifest;' return: - type: '' -extends: '' + type: +extends: diff --git a/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml b/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml index ef89950f..8e0650ad 100644 --- a/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/listviewstatechangedeventargs.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'prevState: Readonly;' return: - type: 'Readonly<>' + type: Readonly<> - name: stateChanges uid: '@microsoft/sp-listview-extensibility!ListViewStateChangedEventArgs#stateChanges:member' package: '@microsoft/sp-listview-extensibility!' @@ -32,5 +32,5 @@ properties: syntax: content: 'stateChanges: ListViewAccessorStateChanges;' return: - type: '' -extends: '' + type: +extends: diff --git a/SP-Framework/sp-listview-extensibility/rowaccessor.yml b/SP-Framework/sp-listview-extensibility/rowaccessor.yml index 899f1567..c2d064c2 100644 --- a/SP-Framework/sp-listview-extensibility/rowaccessor.yml +++ b/SP-Framework/sp-listview-extensibility/rowaccessor.yml @@ -3,7 +3,7 @@ name: RowAccessor uid: '@microsoft/sp-listview-extensibility!RowAccessor:class' package: '@microsoft/sp-listview-extensibility!' fullName: RowAccessor -summary: 'Provides access to a ListView row, which is the visual presentation of a SharePoint list item.' +summary: Provides access to a ListView row, which is the visual presentation of a SharePoint list item. remarks: >- A SharePoint "list item" (SPListItem) is a data storage record in the content management system; it stores an array of values for the associated fields. @@ -18,4 +18,4 @@ remarks: >- isPreview: false isDeprecated: false type: class -extends: '' +extends: diff --git a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml index 44757881..c8c1e5ca 100644 --- a/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml +++ b/SP-Framework/sp-listview-extensibility/selectedrowschangedeventargs.yml @@ -20,5 +20,5 @@ properties: syntax: content: 'selectedRows: ReadonlyArray;' return: - type: 'ReadonlyArray<>' -extends: '' + type: ReadonlyArray<> +extends: diff --git a/SP-Framework/sp-loader/iloadscriptoptions.yml b/SP-Framework/sp-loader/iloadscriptoptions.yml index 8033ab61..1dfc0b8b 100644 --- a/SP-Framework/sp-loader/iloadscriptoptions.yml +++ b/SP-Framework/sp-loader/iloadscriptoptions.yml @@ -13,7 +13,7 @@ properties: uid: '@microsoft/sp-loader!ILoadScriptOptions#globalExportsName:member' package: '@microsoft/sp-loader!' fullName: globalExportsName - summary: 'If set, the loaded script will be stored in a global variable under this name.' + summary: If set, the loaded script will be stored in a global variable under this name. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-loader/spcomponentloader.yml b/SP-Framework/sp-loader/spcomponentloader.yml index f6ffa70a..70a408be 100644 --- a/SP-Framework/sp-loader/spcomponentloader.yml +++ b/SP-Framework/sp-loader/spcomponentloader.yml @@ -21,7 +21,7 @@ methods: syntax: content: 'static getManifests(): IClientSideComponentManifest[];' return: - type: '[]' + type: [] description: '' - name: loadComponent(manifest) uid: '@microsoft/sp-loader!SPComponentLoader.loadComponent:member(1)' @@ -36,15 +36,15 @@ methods: parameters: - id: manifest description: Manifest of the module to load. - type: '' + type: return: type: Promise<TComponent> description: A promise containing the loaded module. - - name: 'loadComponentById(id, version)' + - name: loadComponentById(id, version) uid: '@microsoft/sp-loader!SPComponentLoader.loadComponentById:member(1)' package: '@microsoft/sp-loader!' - fullName: 'loadComponentById(id, version)' - summary: 'Resolve a component id and version, and load it.' + fullName: loadComponentById(id, version) + summary: Resolve a component id and version, and load it. remarks: '' isPreview: false isDeprecated: false @@ -79,11 +79,11 @@ methods: return: type: void description: '' - - name: 'loadScript(url, options)' + - name: loadScript(url, options) uid: '@microsoft/sp-loader!SPComponentLoader.loadScript:member(1)' package: '@microsoft/sp-loader!' - fullName: 'loadScript(url, options)' - summary: 'Given a URL, load a script.' + fullName: loadScript(url, options) + summary: Given a URL, load a script. remarks: >- If a script with a global variable is being loaded, the global variable already exists, and the script fails to load (because of a syntax error, for example), the original global variable may be returned and an error may not @@ -100,7 +100,7 @@ methods: 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: '' + type: return: type: Promise<TModule> description: A promise containing the loaded module. diff --git a/SP-Framework/sp-module-interfaces.yml b/SP-Framework/sp-module-interfaces.yml index 31430115..f60fc3dd 100644 --- a/SP-Framework/sp-module-interfaces.yml +++ b/SP-Framework/sp-module-interfaces.yml @@ -12,6 +12,7 @@ typeAliases: interfaces: - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' - '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' + - '@microsoft/sp-module-interfaces!IAIProperties:interface' - '@microsoft/sp-module-interfaces!ICapabilityCollection:interface' - '@microsoft/sp-module-interfaces!IClientSideApplicationManifest:interface' - '@microsoft/sp-module-interfaces!IClientSideAssemblyManifest:interface' diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml index 34cbeba5..d675c987 100644 --- a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifest.yml @@ -31,7 +31,7 @@ properties: uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest#hiddenFromToolbox:member' package: '@microsoft/sp-module-interfaces!' fullName: hiddenFromToolbox - summary: 'If true, this AdaptiveCardExtension should not be displayed in the modern SharePoint toolbox.' + 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 @@ -97,9 +97,6 @@ properties: "primaryText": "Basic card", "description": "This is an example.", "cardSize": "Medium" - } - }] - ``` isPreview: true isDeprecated: false syntax: @@ -156,4 +153,4 @@ properties: content: 'useFallbackWhenPropertiesUpdatedExternally?: boolean;' return: type: boolean -extends: '' +extends: diff --git a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml index 79a797fd..e78bccc8 100644 --- a/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iadaptivecardextensionmanifestentry.yml @@ -83,14 +83,12 @@ properties: "en-us": "A tool for displaying neat information.", "fr-fr": "Un outil d'affichage des informations soignées.", "zh": "用於顯示整潔資訊的工具。" - } - ``` isPreview: true isDeprecated: false syntax: content: 'description: ILocalizedString;' return: - type: '' + type: - name: groupId uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#groupId:member' package: '@microsoft/sp-module-interfaces!' @@ -108,7 +106,7 @@ properties: syntax: content: 'groupId: PredefinedGroup | string;' return: - type: ' | string' + type: | string - name: iconImageUrl uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#iconImageUrl:member' package: '@microsoft/sp-module-interfaces!' @@ -198,7 +196,7 @@ properties: syntax: content: 'tags?: ILocalizedString[];' return: - type: '[]' + type: [] - name: title uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry#title:member' package: '@microsoft/sp-module-interfaces!' @@ -227,11 +225,9 @@ properties: "en-us": "My WebPart", "fr-fr": "Ma WebPart", "zh": "我的 web 部件" - } - ``` isPreview: true isDeprecated: false syntax: content: 'title: ILocalizedString;' return: - type: '' + type: diff --git a/SP-Framework/sp-module-interfaces/iaiproperties.yml b/SP-Framework/sp-module-interfaces/iaiproperties.yml new file mode 100644 index 00000000..90884fe9 --- /dev/null +++ b/SP-Framework/sp-module-interfaces/iaiproperties.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: IAIProperties +uid: '@microsoft/sp-module-interfaces!IAIProperties:interface' +package: '@microsoft/sp-module-interfaces!' +fullName: IAIProperties +summary: >- + Defines the AI properties for the web part, including their structure and the mapping to the web part's property bag. + When provided, AI scenarios such as an LLM agent in SharePoint Pages can interact with the web part, e.g., creating + it, modifying it, or understanding its data structure. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: mapping + uid: '@microsoft/sp-module-interfaces!IAIProperties#mapping:member' + package: '@microsoft/sp-module-interfaces!' + fullName: mapping + summary: The mapping of AI properties to existing property bag. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: |- + mapping: { + [key: string]: unknown; + }; + return: + type: |- + { + [key: string]: unknown; + } + - name: structure + uid: '@microsoft/sp-module-interfaces!IAIProperties#structure:member' + package: '@microsoft/sp-module-interfaces!' + fullName: structure + summary: The structure of AI properties for the web part. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: |- + structure: { + [key: string]: unknown; + }; + return: + type: |- + { + [key: string]: unknown; + } diff --git a/SP-Framework/sp-module-interfaces/iclientsideapplicationmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideapplicationmanifest.yml index 8c4b9a4a..f36e3253 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideapplicationmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideapplicationmanifest.yml @@ -32,14 +32,12 @@ properties: "en-us": "An application for searching for things.", "fr-fr": "Une demande pour la recherche de choses.", "zh": "申請尋找的東西。" - } - ``` isPreview: true isDeprecated: false syntax: content: 'description: ILocalizedString;' return: - type: '' + type: - name: preloadOptions uid: '@microsoft/sp-module-interfaces!IClientSideApplicationManifest#preloadOptions:member' package: '@microsoft/sp-module-interfaces!' @@ -51,7 +49,7 @@ properties: syntax: content: 'preloadOptions: IPreloadOptions;' return: - type: '' + type: - name: title uid: '@microsoft/sp-module-interfaces!IClientSideApplicationManifest#title:member' package: '@microsoft/sp-module-interfaces!' @@ -70,12 +68,10 @@ properties: "en-us": "My Application", "fr-fr": "Ma demande", "zh": "我的應用程式" - } - ``` isPreview: true isDeprecated: false syntax: content: 'title: ILocalizedString;' return: - type: '' -extends: '' + type: +extends: diff --git a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml index 9ac3e6ed..ae9aaf23 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideassemblymanifest.yml @@ -24,4 +24,4 @@ properties: content: 'rootComponentId: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml index 0e42c8b6..0886ee20 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentloaderconfiguration.yml @@ -97,7 +97,7 @@ properties: syntax: content: 'internalModuleBaseUrls: string[];' return: - type: 'string[]' + type: string[] - name: scriptResources uid: '@microsoft/sp-module-interfaces!IClientSideComponentLoaderConfiguration#scriptResources:member' package: '@microsoft/sp-module-interfaces!' @@ -139,10 +139,6 @@ properties: "paths": { "en-us": "master_2015-04-20/my-application_strings_en-us_d38ff012.js", "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js" - } - } - } - ``` isPreview: true isDeprecated: false syntax: diff --git a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml index c3516f1c..8129d004 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidecomponentmanifest.yml @@ -66,7 +66,7 @@ properties: syntax: content: 'componentType: ComponentType;' return: - type: '' + type: - name: experimentalData uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#experimentalData:member' package: '@microsoft/sp-module-interfaces!' @@ -113,7 +113,7 @@ properties: syntax: content: 'loaderConfig: IClientSideComponentLoaderConfiguration;' return: - type: '' + type: - name: loadLegacyFabricCss uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#loadLegacyFabricCss:member' package: '@microsoft/sp-module-interfaces!' @@ -144,7 +144,7 @@ properties: syntax: content: 'preloadComponents?: string[];' return: - type: 'string[]' + type: string[] - name: requiresCustomScript uid: '@microsoft/sp-module-interfaces!IClientSideComponentManifest#requiresCustomScript:member' package: '@microsoft/sp-module-interfaces!' @@ -211,4 +211,4 @@ properties: content: 'version: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml index c755266f..d7162a92 100644 --- a/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsideextensionmanifest.yml @@ -22,5 +22,5 @@ properties: syntax: content: 'extensionType: ExtensionType;' return: - type: '' -extends: '' + type: +extends: diff --git a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml index 91c3bfe8..a973601f 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidelibrarymanifest.yml @@ -8,4 +8,4 @@ remarks: '' isPreview: false isDeprecated: false type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-module-interfaces/iclientsidemultiversionmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidemultiversionmanifest.yml index 9cd927d1..9b66909b 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidemultiversionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidemultiversionmanifest.yml @@ -38,8 +38,6 @@ properties: { "1.0.0": ...manifest, "2.0.0": ...manifest - } - ``` isPreview: true isDeprecated: false syntax: @@ -52,4 +50,4 @@ properties: { [versionNumber: string]: TManifest; } -extends: '' +extends: diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml index 63749853..1102da43 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifest.yml @@ -16,6 +16,22 @@ isPreview: false isDeprecated: false type: interface properties: + - name: aiProperties + uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#aiProperties:member' + package: '@microsoft/sp-module-interfaces!' + fullName: aiProperties + summary: >- + Optional AI properties for the web part including the structure of AI properties and the mapping between AI + properties and the web part property bag. If provided, AI scenarios like LLM agent in SharePoint Pages will be + able to interact with the web part. For example, Creating a web part, modifying existing web part, better + understanding of the web part's data structure, etc. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'aiProperties?: IAIProperties;' + return: + type: - name: canUpdateConfiguration uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#canUpdateConfiguration:member' package: '@microsoft/sp-module-interfaces!' @@ -32,7 +48,7 @@ properties: uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#disabledOnClassicSharepoint:member' package: '@microsoft/sp-module-interfaces!' fullName: disabledOnClassicSharepoint - summary: 'If true, this web part is disabled on SharePoint classic pages' + 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. @@ -84,12 +100,12 @@ properties: syntax: content: 'flexibleLayoutSizing?: IFlexibleLayoutSizing;' return: - type: '' + type: - name: hiddenFromToolbox uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#hiddenFromToolbox:member' package: '@microsoft/sp-module-interfaces!' fullName: hiddenFromToolbox - summary: 'If true, this web part should not be displayed in the modern SharePoint toolbox.' + 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 @@ -171,15 +187,12 @@ properties: properties: { imageSource: "https://contoso.akamaihd.net/files/mountRainier.jpg", captionText: "Mount Rainier" - } - }] - ``` isPreview: false isDeprecated: false syntax: content: 'preconfiguredEntries: IClientSideWebPartManifestEntry[];' return: - type: '<TProperties>[]' + type: <TProperties>[] - name: requiredCapabilities uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#requiredCapabilities:member' package: '@microsoft/sp-module-interfaces!' @@ -193,7 +206,7 @@ properties: syntax: content: 'requiredCapabilities?: ICapabilityCollection;' return: - type: '' + type: - name: supportedHosts uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifest#supportedHosts:member' package: '@microsoft/sp-module-interfaces!' @@ -278,4 +291,4 @@ properties: content: 'useFallbackWhenPropertiesUpdatedExternally?: boolean;' return: type: boolean -extends: '' +extends: diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml index 1489cfd3..ecd7d19a 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestentry.yml @@ -69,14 +69,12 @@ properties: "en-us": "A tool for displaying neat information.", "fr-fr": "Un outil d'affichage des informations soignées.", "zh": "用於顯示整潔資訊的工具。" - } - ``` isPreview: false isDeprecated: false syntax: content: 'description: ILocalizedString;' return: - type: '' + type: - name: fullPageAppIconImageUrl uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#fullPageAppIconImageUrl:member' package: '@microsoft/sp-module-interfaces!' @@ -112,7 +110,7 @@ properties: syntax: content: 'group?: ILocalizedString;' return: - type: '' + type: - name: groupId uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#groupId:member' package: '@microsoft/sp-module-interfaces!' @@ -130,7 +128,7 @@ properties: syntax: content: 'groupId: PredefinedGroup | string;' return: - type: ' | string' + type: | string - name: iconImageUrl uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#iconImageUrl:member' package: '@microsoft/sp-module-interfaces!' @@ -219,7 +217,7 @@ properties: syntax: content: 'tags?: ILocalizedString[];' return: - type: '[]' + type: [] - name: title uid: '@microsoft/sp-module-interfaces!IClientSideWebPartManifestEntry#title:member' package: '@microsoft/sp-module-interfaces!' @@ -247,11 +245,9 @@ properties: "en-us": "My WebPart", "fr-fr": "Ma WebPart", "zh": "我的 web 部件" - } - ``` isPreview: false isDeprecated: false syntax: content: 'title: ILocalizedString;' return: - type: '' + type: diff --git a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml index 6ad4afcf..a0fbf42c 100644 --- a/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml +++ b/SP-Framework/sp-module-interfaces/iclientsidewebpartmanifestinstance.yml @@ -8,4 +8,4 @@ remarks: '' isPreview: false isDeprecated: false type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-module-interfaces/icommanddefinition.yml b/SP-Framework/sp-module-interfaces/icommanddefinition.yml index 27a9da0e..66402d80 100644 --- a/SP-Framework/sp-module-interfaces/icommanddefinition.yml +++ b/SP-Framework/sp-module-interfaces/icommanddefinition.yml @@ -24,7 +24,7 @@ properties: syntax: content: 'ariaLabel?: ILocalizedString;' return: - type: '' + type: - name: iconImageUrl uid: '@microsoft/sp-module-interfaces!ICommandDefinition#iconImageUrl:member' package: '@microsoft/sp-module-interfaces!' @@ -55,7 +55,7 @@ properties: syntax: content: 'title: ILocalizedString;' return: - type: '' + type: - name: type uid: '@microsoft/sp-module-interfaces!ICommandDefinition#type:member' package: '@microsoft/sp-module-interfaces!' diff --git a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml index 37079bca..fa7a593b 100644 --- a/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml +++ b/SP-Framework/sp-module-interfaces/icommandsetextensionmanifest.yml @@ -45,4 +45,4 @@ properties: { [itemId: string]: ; } -extends: '' +extends: diff --git a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml index c17f03dd..016a7d8e 100644 --- a/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/icomponentmoduleconfiguration.yml @@ -32,7 +32,7 @@ properties: syntax: content: 'failoverPath?: string | IIntegrityPath;' return: - type: 'string | ' + type: string | - name: id uid: '@microsoft/sp-module-interfaces!IComponentModuleConfiguration#id:member' package: '@microsoft/sp-module-interfaces!' @@ -78,4 +78,4 @@ properties: content: 'version: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-module-interfaces/iflexiblelayoutsizing.yml b/SP-Framework/sp-module-interfaces/iflexiblelayoutsizing.yml index f69309d0..1afff062 100644 --- a/SP-Framework/sp-module-interfaces/iflexiblelayoutsizing.yml +++ b/SP-Framework/sp-module-interfaces/iflexiblelayoutsizing.yml @@ -13,7 +13,7 @@ properties: uid: '@microsoft/sp-module-interfaces!IFlexibleLayoutSizing#defaultColumnWidth:member' package: '@microsoft/sp-module-interfaces!' fullName: defaultColumnWidth - summary: 'Default column width for the webpart, used by drop hint' + summary: Default column width for the webpart, used by drop hint remarks: '' isPreview: false isDeprecated: false @@ -25,7 +25,7 @@ properties: uid: '@microsoft/sp-module-interfaces!IFlexibleLayoutSizing#defaultRowHeight:member' package: '@microsoft/sp-module-interfaces!' fullName: defaultRowHeight - summary: 'Default row height for the webpart, used by drop hint' + summary: Default row height for the webpart, used by drop hint remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml index 5f7db205..3242f2ed 100644 --- a/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ilocalizedpathmoduleconfiguration.yml @@ -35,7 +35,7 @@ properties: syntax: content: 'defaultPath: string | IIntegrityPath;' return: - type: 'string | ' + type: string | - name: paths uid: '@microsoft/sp-module-interfaces!ILocalizedPathModuleConfiguration#paths:member' package: '@microsoft/sp-module-interfaces!' @@ -65,8 +65,6 @@ properties: { "en-us": "master_2015-04-20/my-application_strings_en-us_d38ff012.js", "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js" - } - ``` isPreview: true isDeprecated: false syntax: @@ -91,4 +89,4 @@ properties: content: 'type: ''localizedPath'';' return: type: '''localizedPath''' -extends: '' +extends: diff --git a/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml b/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml index 8a08c937..562ea458 100644 --- a/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml +++ b/SP-Framework/sp-module-interfaces/imoduleconfigurationbase.yml @@ -13,7 +13,7 @@ properties: uid: '@microsoft/sp-module-interfaces!IModuleConfigurationBase#shouldNotPreload:member' package: '@microsoft/sp-module-interfaces!' fullName: shouldNotPreload - summary: 'If set to `true`, this module should not be preloaded when loading the component.' + 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 diff --git a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml index 94aaa8e2..83fe0d6c 100644 --- a/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml +++ b/SP-Framework/sp-module-interfaces/ipathmoduleconfiguration.yml @@ -35,7 +35,7 @@ properties: syntax: content: 'globalDependencies?: string[];' return: - type: 'string[]' + type: string[] - name: globalName uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#globalName:member' package: '@microsoft/sp-module-interfaces!' @@ -90,7 +90,7 @@ properties: syntax: content: 'path: string | IIntegrityPath;' return: - type: 'string | ' + type: string | - name: type uid: '@microsoft/sp-module-interfaces!IPathModuleConfiguration#type:member' package: '@microsoft/sp-module-interfaces!' @@ -103,4 +103,4 @@ properties: content: 'type: ''path'';' return: type: '''path''' -extends: '' +extends: diff --git a/SP-Framework/sp-module-interfaces/iprefabappmanifest.yml b/SP-Framework/sp-module-interfaces/iprefabappmanifest.yml index e14522f9..c8b746b5 100644 --- a/SP-Framework/sp-module-interfaces/iprefabappmanifest.yml +++ b/SP-Framework/sp-module-interfaces/iprefabappmanifest.yml @@ -23,7 +23,7 @@ properties: syntax: content: 'actions?: Record;' return: - type: 'Record<string, >' + type: Record<string, > - name: appInstallationTypes uid: '@microsoft/sp-module-interfaces!IPrefabAppManifest#appInstallationTypes:member' package: '@microsoft/sp-module-interfaces!' @@ -59,14 +59,12 @@ properties: "en-us": "An application for searching for things.", "fr-fr": "Une demande pour la recherche de choses.", "zh": "申請尋找的東西。" - } - ``` isPreview: true isDeprecated: false syntax: content: 'description: ILocalizedString;' return: - type: '' + type: - name: isConfigured uid: '@microsoft/sp-module-interfaces!IPrefabAppManifest#isConfigured:member' package: '@microsoft/sp-module-interfaces!' @@ -90,7 +88,7 @@ properties: syntax: content: 'siteSettingsLinks?: IPrefabAppSiteSettingsLink[];' return: - type: '[]' + type: [] - name: title uid: '@microsoft/sp-module-interfaces!IPrefabAppManifest#title:member' package: '@microsoft/sp-module-interfaces!' @@ -109,14 +107,12 @@ properties: "en-us": "My Application", "fr-fr": "Ma demande", "zh": "我的應用程式" - } - ``` isPreview: true isDeprecated: false syntax: content: 'title: ILocalizedString;' return: - type: '' + type: - name: toolboxEntries uid: '@microsoft/sp-module-interfaces!IPrefabAppManifest#toolboxEntries:member' package: '@microsoft/sp-module-interfaces!' @@ -128,5 +124,5 @@ properties: syntax: content: 'toolboxEntries?: IPrefabAppToolboxEntry[];' return: - type: '[]' -extends: '' + type: [] +extends: diff --git a/SP-Framework/sp-module-interfaces/iprefabappondemandsitescript.yml b/SP-Framework/sp-module-interfaces/iprefabappondemandsitescript.yml index 22da3644..e9c032a9 100644 --- a/SP-Framework/sp-module-interfaces/iprefabappondemandsitescript.yml +++ b/SP-Framework/sp-module-interfaces/iprefabappondemandsitescript.yml @@ -21,4 +21,4 @@ properties: content: 'type: ''onDemand'';' return: type: '''onDemand''' -extends: '' +extends: diff --git a/SP-Framework/sp-module-interfaces/iprefabapponinstallsitescript.yml b/SP-Framework/sp-module-interfaces/iprefabapponinstallsitescript.yml index cd11788c..9d188ba9 100644 --- a/SP-Framework/sp-module-interfaces/iprefabapponinstallsitescript.yml +++ b/SP-Framework/sp-module-interfaces/iprefabapponinstallsitescript.yml @@ -21,4 +21,4 @@ properties: content: 'type: ''onInstall'';' return: type: '''onInstall''' -extends: '' +extends: diff --git a/SP-Framework/sp-module-interfaces/iprefabappsitescriptbase.yml b/SP-Framework/sp-module-interfaces/iprefabappsitescriptbase.yml index 3c386f34..21145faa 100644 --- a/SP-Framework/sp-module-interfaces/iprefabappsitescriptbase.yml +++ b/SP-Framework/sp-module-interfaces/iprefabappsitescriptbase.yml @@ -22,7 +22,7 @@ properties: syntax: content: 'actions: ISiteScriptActionBase[];' return: - type: '[]' + type: [] - name: type uid: '@microsoft/sp-module-interfaces!IPrefabAppSiteScriptBase#type:member' package: '@microsoft/sp-module-interfaces!' @@ -34,4 +34,4 @@ properties: syntax: content: 'type: SiteScriptType;' return: - type: '' + type: diff --git a/SP-Framework/sp-module-interfaces/iprefabappsitesettingslink.yml b/SP-Framework/sp-module-interfaces/iprefabappsitesettingslink.yml index b73de555..0674c007 100644 --- a/SP-Framework/sp-module-interfaces/iprefabappsitesettingslink.yml +++ b/SP-Framework/sp-module-interfaces/iprefabappsitesettingslink.yml @@ -29,14 +29,12 @@ properties: "en-us": "My App Settings", "fr-fr": "Mes paramètres d'application", "zh": "我的應用程式設定" - } - ``` isPreview: true isDeprecated: false syntax: content: 'text: ILocalizedString;' return: - type: '' + type: - name: viewId uid: '@microsoft/sp-module-interfaces!IPrefabAppSiteSettingsLink#viewId:member' package: '@microsoft/sp-module-interfaces!' diff --git a/SP-Framework/sp-module-interfaces/iprefabapptoolboxentry.yml b/SP-Framework/sp-module-interfaces/iprefabapptoolboxentry.yml index ad939eb4..d6eb579e 100644 --- a/SP-Framework/sp-module-interfaces/iprefabapptoolboxentry.yml +++ b/SP-Framework/sp-module-interfaces/iprefabapptoolboxentry.yml @@ -32,14 +32,12 @@ properties: "en-us": "A tool for displaying neat information.", "fr-fr": "Un outil d'affichage des informations soignées.", "zh": "用於顯示整潔資訊的工具。" - } - ``` isPreview: true isDeprecated: false syntax: content: 'description: ILocalizedString;' return: - type: '' + type: - name: iconImageUrl uid: '@microsoft/sp-module-interfaces!IPrefabAppToolboxEntry#iconImageUrl:member' package: '@microsoft/sp-module-interfaces!' @@ -113,14 +111,12 @@ properties: "en-us": "My PREFAB App", "fr-fr": "My PREFAB App", "zh": "我的 PREFAB 應用程式" - } - ``` isPreview: true isDeprecated: false syntax: content: 'title: ILocalizedString;' return: - type: '' + type: - name: viewId uid: '@microsoft/sp-module-interfaces!IPrefabAppToolboxEntry#viewId:member' package: '@microsoft/sp-module-interfaces!' diff --git a/SP-Framework/sp-module-interfaces/ipreloadoptions.yml b/SP-Framework/sp-module-interfaces/ipreloadoptions.yml index 4a0c1eb2..595a85fe 100644 --- a/SP-Framework/sp-module-interfaces/ipreloadoptions.yml +++ b/SP-Framework/sp-module-interfaces/ipreloadoptions.yml @@ -42,7 +42,7 @@ properties: syntax: content: 'preloadListItemProperties?: string[];' return: - type: 'string[]' + type: string[] - name: preloadListItemQueryOption uid: '@microsoft/sp-module-interfaces!IPreloadOptions#preloadListItemQueryOption:member' package: '@microsoft/sp-module-interfaces!' diff --git a/SP-Framework/sp-module-interfaces/manifesttype.yml b/SP-Framework/sp-module-interfaces/manifesttype.yml index 11503b57..d2e3d13b 100644 --- a/SP-Framework/sp-module-interfaces/manifesttype.yml +++ b/SP-Framework/sp-module-interfaces/manifesttype.yml @@ -16,5 +16,5 @@ fields: - name: container uid: '@microsoft/sp-module-interfaces!ManifestType.container:member' package: '@microsoft/sp-module-interfaces!' - summary: 'The container manifest type. This is used for manifests that contain other manifests, like multiversion manifests.' + summary: The container manifest type. This is used for manifests that contain other manifests, like multiversion manifests. value: '"Container"' diff --git a/SP-Framework/sp-odata-types/iodatacontenttype.yml b/SP-Framework/sp-odata-types/iodatacontenttype.yml index b7cd2cf6..f251eae7 100644 --- a/SP-Framework/sp-odata-types/iodatacontenttype.yml +++ b/SP-Framework/sp-odata-types/iodatacontenttype.yml @@ -80,7 +80,7 @@ properties: syntax: content: 'Id: IODataContentTypeId;' return: - type: '' + type: - name: Name uid: '@microsoft/sp-odata-types!IODataContentType#Name:member' package: '@microsoft/sp-odata-types!' @@ -141,4 +141,4 @@ properties: content: 'StringId: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml index cec543b4..f3311ad7 100644 --- a/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml +++ b/SP-Framework/sp-odata-types/iodatacontextwebinformation.yml @@ -46,7 +46,7 @@ properties: syntax: content: 'SupportedSchemaVersions: string[];' return: - type: 'string[]' + type: string[] - name: WebFullUrl uid: '@microsoft/sp-odata-types!IODataContextWebInformation#WebFullUrl:member' package: '@microsoft/sp-odata-types!' diff --git a/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml b/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml index 1148ec37..e7684710 100644 --- a/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml +++ b/SP-Framework/sp-odata-types/iodataformsclientsideconfiguration.yml @@ -3,7 +3,7 @@ name: IODataFormsClientSideConfiguration uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration:interface' package: '@microsoft/sp-odata-types!' fullName: IODataFormsClientSideConfiguration -summary: 'Represents a set of OData properties for objects that allow forms customizations (e.g. SP.List, SP.ContentType).' +summary: Represents a set of OData properties for objects that allow forms customizations (e.g. SP.List, SP.ContentType). remarks: '' isPreview: false isDeprecated: false @@ -13,7 +13,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#DislpayFormClientSideDisplayTarget:member' package: '@microsoft/sp-odata-types!' fullName: DislpayFormClientSideDisplayTarget - summary: 'Display Form display target (new tab, panel)' + summary: Display Form display target (new tab, panel) remarks: '' isPreview: false isDeprecated: false @@ -73,7 +73,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#EditFormClientSideDisplayTarget:member' package: '@microsoft/sp-odata-types!' fullName: EditFormClientSideDisplayTarget - summary: 'Edit Form display target (new tab, panel)' + summary: Edit Form display target (new tab, panel) remarks: '' isPreview: false isDeprecated: false @@ -109,7 +109,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataFormsClientSideConfiguration#NewFormClientSideDisplayTarget:member' package: '@microsoft/sp-odata-types!' fullName: NewFormClientSideDisplayTarget - summary: 'New Form display target (new tab, panel)' + summary: New Form display target (new tab, panel) remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-odata-types/iodatalist.yml b/SP-Framework/sp-odata-types/iodatalist.yml index 48072045..ba009047 100644 --- a/SP-Framework/sp-odata-types/iodatalist.yml +++ b/SP-Framework/sp-odata-types/iodatalist.yml @@ -46,7 +46,7 @@ properties: syntax: content: 'CurrentChangeToken: IODataChangeToken;' return: - type: '' + type: - name: Description uid: '@microsoft/sp-odata-types!IODataList#Description:member' package: '@microsoft/sp-odata-types!' @@ -169,4 +169,4 @@ properties: content: 'Title: string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-odata-types/iodatanavigationnode.yml b/SP-Framework/sp-odata-types/iodatanavigationnode.yml index 32bc1a50..44a55628 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnode.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnode.yml @@ -22,7 +22,7 @@ properties: syntax: content: 'Children?: IODataNavigationNode[];' return: - type: '[]' + type: [] - name: Id uid: '@microsoft/sp-odata-types!IODataNavigationNode#Id:member' package: '@microsoft/sp-odata-types!' diff --git a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml index 30026142..be350b15 100644 --- a/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml +++ b/SP-Framework/sp-odata-types/iodatanavigationnodecollection.yml @@ -22,7 +22,7 @@ properties: syntax: content: 'quickLaunch: IODataNavigationNode[];' return: - type: '[]' + type: [] - name: topNav uid: '@microsoft/sp-odata-types!IODataNavigationNodeCollection#topNav:member' package: '@microsoft/sp-odata-types!' @@ -34,4 +34,4 @@ properties: syntax: content: 'topNav: IODataNavigationNode[];' return: - type: '[]' + type: [] diff --git a/SP-Framework/sp-odata-types/iodatauser.yml b/SP-Framework/sp-odata-types/iodatauser.yml index ffa8a113..1959635e 100644 --- a/SP-Framework/sp-odata-types/iodatauser.yml +++ b/SP-Framework/sp-odata-types/iodatauser.yml @@ -109,4 +109,4 @@ properties: syntax: content: 'UserId: IODataUserId;' return: - type: '' + type: diff --git a/SP-Framework/sp-odata-types/iodatausercustomaction.yml b/SP-Framework/sp-odata-types/iodatausercustomaction.yml index f83c9584..7b2ddd8f 100644 --- a/SP-Framework/sp-odata-types/iodatausercustomaction.yml +++ b/SP-Framework/sp-odata-types/iodatausercustomaction.yml @@ -157,7 +157,7 @@ properties: syntax: content: 'Rights: IODataBasePermission;' return: - type: '' + type: - name: Scope uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Scope:member' package: '@microsoft/sp-odata-types!' @@ -224,7 +224,7 @@ properties: uid: '@microsoft/sp-odata-types!IODataUserCustomAction#Url:member' package: '@microsoft/sp-odata-types!' fullName: Url - summary: 'Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.' + summary: Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-odata-types/iodataweb.yml b/SP-Framework/sp-odata-types/iodataweb.yml index 9c878644..3da4559f 100644 --- a/SP-Framework/sp-odata-types/iodataweb.yml +++ b/SP-Framework/sp-odata-types/iodataweb.yml @@ -37,7 +37,7 @@ properties: syntax: content: 'CurrentChangeToken?: IODataChangeToken;' return: - type: '' + type: - name: CustomMasterUrl uid: '@microsoft/sp-odata-types!IODataWeb#CustomMasterUrl:member' package: '@microsoft/sp-odata-types!' diff --git a/SP-Framework/sp-page-context/azureactivedirectoryinfo.yml b/SP-Framework/sp-page-context/azureactivedirectoryinfo.yml index 3676b683..0856a9e7 100644 --- a/SP-Framework/sp-page-context/azureactivedirectoryinfo.yml +++ b/SP-Framework/sp-page-context/azureactivedirectoryinfo.yml @@ -36,7 +36,7 @@ properties: syntax: content: 'readonly tenantId: Guid;' return: - type: '' + type: - name: userId uid: '@microsoft/sp-page-context!AzureActiveDirectoryInfo#userId:member' package: '@microsoft/sp-page-context!' @@ -48,4 +48,4 @@ properties: syntax: content: 'readonly userId: Guid;' return: - type: '' + type: diff --git a/SP-Framework/sp-page-context/isptimezonedata.yml b/SP-Framework/sp-page-context/isptimezonedata.yml index af727df3..cc7e51b2 100644 --- a/SP-Framework/sp-page-context/isptimezonedata.yml +++ b/SP-Framework/sp-page-context/isptimezonedata.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'daylightDate: ISPSystemTime;' return: - type: '' + type: - name: daylightOffset uid: '@microsoft/sp-page-context!ISPTimeZoneData#daylightOffset:member' package: '@microsoft/sp-page-context!' @@ -80,7 +80,7 @@ properties: syntax: content: 'standardDate: ISPSystemTime;' return: - type: '' + type: - name: standardOffset uid: '@microsoft/sp-page-context!ISPTimeZoneData#standardOffset:member' package: '@microsoft/sp-page-context!' diff --git a/SP-Framework/sp-page-context/o365groupassociation.yml b/SP-Framework/sp-page-context/o365groupassociation.yml index dd34e880..5c4d5d28 100644 --- a/SP-Framework/sp-page-context/o365groupassociation.yml +++ b/SP-Framework/sp-page-context/o365groupassociation.yml @@ -24,7 +24,7 @@ properties: syntax: content: 'readonly id: Guid;' return: - type: '' + type: - name: type uid: '@microsoft/sp-page-context!O365GroupAssociation#type:member' package: '@microsoft/sp-page-context!' @@ -36,4 +36,4 @@ properties: syntax: content: 'readonly type: O365GroupAssociationType;' return: - type: '' + type: diff --git a/SP-Framework/sp-page-context/pagecontext.yml b/SP-Framework/sp-page-context/pagecontext.yml index 14ddd017..39d8a0ca 100644 --- a/SP-Framework/sp-page-context/pagecontext.yml +++ b/SP-Framework/sp-page-context/pagecontext.yml @@ -25,7 +25,7 @@ constructors: parameters: - id: serviceScope description: '' - type: '' + type: properties: - name: aadInfo uid: '@microsoft/sp-page-context!PageContext#aadInfo:member' @@ -40,7 +40,7 @@ properties: syntax: content: 'get aadInfo(): AzureActiveDirectoryInfo | undefined;' return: - type: ' | undefined' + type: | undefined - name: cultureInfo uid: '@microsoft/sp-page-context!PageContext#cultureInfo:member' package: '@microsoft/sp-page-context!' @@ -54,7 +54,7 @@ properties: syntax: content: 'get cultureInfo(): CultureInfo;' return: - type: '' + type: - name: isInitialized uid: '@microsoft/sp-page-context!PageContext#isInitialized:member' package: '@microsoft/sp-page-context!' @@ -102,7 +102,7 @@ properties: syntax: content: 'get list(): SPList | undefined;' return: - type: ' | undefined' + type: | undefined - name: listItem uid: '@microsoft/sp-page-context!PageContext#listItem:member' package: '@microsoft/sp-page-context!' @@ -116,7 +116,7 @@ properties: syntax: content: 'get listItem(): SPListItem | undefined;' return: - type: ' | undefined' + type: | undefined - name: page uid: '@microsoft/sp-page-context!PageContext#page:member' package: '@microsoft/sp-page-context!' @@ -128,7 +128,7 @@ properties: syntax: content: 'get page(): Page;' return: - type: '' + type: - name: serviceKey uid: '@microsoft/sp-page-context!PageContext.serviceKey:member' package: '@microsoft/sp-page-context!' @@ -154,7 +154,7 @@ properties: syntax: content: 'get site(): SPSite;' return: - type: '' + type: - name: user uid: '@microsoft/sp-page-context!PageContext#user:member' package: '@microsoft/sp-page-context!' @@ -168,7 +168,7 @@ properties: syntax: content: 'get user(): SPUser;' return: - type: '' + type: - name: web uid: '@microsoft/sp-page-context!PageContext#web:member' package: '@microsoft/sp-page-context!' @@ -180,4 +180,4 @@ properties: syntax: content: 'get web(): SPWeb;' return: - type: '' + type: diff --git a/SP-Framework/sp-page-context/spdayofweek-typealias.yml b/SP-Framework/sp-page-context/spdayofweek-typealias.yml index 1fa003f2..bdb8349b 100644 --- a/SP-Framework/sp-page-context/spdayofweek-typealias.yml +++ b/SP-Framework/sp-page-context/spdayofweek-typealias.yml @@ -7,4 +7,4 @@ summary: The type members represent the seven days of a week. remarks: '' isPreview: true isDeprecated: false -syntax: 'export type SPDayOfWeek = typeof SPDayOfWeek[keyof typeof SPDayOfWeek];' +syntax: export type SPDayOfWeek = typeof SPDayOfWeek[keyof typeof SPDayOfWeek]; diff --git a/SP-Framework/sp-page-context/spfield.yml b/SP-Framework/sp-page-context/spfield.yml index 3bd78259..aed3d6c4 100644 --- a/SP-Framework/sp-page-context/spfield.yml +++ b/SP-Framework/sp-page-context/spfield.yml @@ -26,7 +26,7 @@ properties: syntax: content: 'readonly clientSideComponentId: Guid | undefined;' return: - type: ' | undefined' + type: | undefined - name: clientSideComponentProperties uid: '@microsoft/sp-page-context!SPField#clientSideComponentProperties:member' package: '@microsoft/sp-page-context!' @@ -76,7 +76,7 @@ properties: syntax: content: 'readonly id: Guid;' return: - type: '' + type: - name: internalName uid: '@microsoft/sp-page-context!SPField#internalName:member' package: '@microsoft/sp-page-context!' diff --git a/SP-Framework/sp-page-context/splist.yml b/SP-Framework/sp-page-context/splist.yml index 6f1b2256..44a6d87a 100644 --- a/SP-Framework/sp-page-context/splist.yml +++ b/SP-Framework/sp-page-context/splist.yml @@ -26,7 +26,7 @@ properties: syntax: content: 'readonly id: Guid;' return: - type: '' + type: - name: permissions uid: '@microsoft/sp-page-context!SPList#permissions:member' package: '@microsoft/sp-page-context!' @@ -40,7 +40,7 @@ properties: syntax: content: 'readonly permissions: SPPermission;' return: - type: '' + type: - name: serverRelativeUrl uid: '@microsoft/sp-page-context!SPList#serverRelativeUrl:member' package: '@microsoft/sp-page-context!' diff --git a/SP-Framework/sp-page-context/sppermission.yml b/SP-Framework/sp-page-context/sppermission.yml index e7ca921a..fe41fe38 100644 --- a/SP-Framework/sp-page-context/sppermission.yml +++ b/SP-Framework/sp-page-context/sppermission.yml @@ -27,7 +27,7 @@ constructors: parameters: - id: value description: '' - type: '' + type: properties: - name: addAndCustomizePages uid: '@microsoft/sp-page-context!SPPermission.addAndCustomizePages:member' @@ -42,7 +42,7 @@ properties: syntax: content: 'static readonly addAndCustomizePages: SPPermission;' return: - type: '' + type: - name: addDelPrivateWebParts uid: '@microsoft/sp-page-context!SPPermission.addDelPrivateWebParts:member' package: '@microsoft/sp-page-context!' @@ -54,19 +54,19 @@ properties: syntax: content: 'static readonly addDelPrivateWebParts: SPPermission;' return: - type: '' + type: - name: addListItems uid: '@microsoft/sp-page-context!SPPermission.addListItems:member' package: '@microsoft/sp-page-context!' fullName: addListItems - summary: 'Add items to lists, add documents to document libraries, and add Web discussion comments.' + summary: Add items to lists, add documents to document libraries, and add Web discussion comments. remarks: '' isPreview: false isDeprecated: false syntax: content: 'static readonly addListItems: SPPermission;' return: - type: '' + type: - name: applyStyleSheets uid: '@microsoft/sp-page-context!SPPermission.applyStyleSheets:member' package: '@microsoft/sp-page-context!' @@ -78,7 +78,7 @@ properties: syntax: content: 'static readonly applyStyleSheets: SPPermission;' return: - type: '' + type: - name: applyThemeAndBorder uid: '@microsoft/sp-page-context!SPPermission.applyThemeAndBorder:member' package: '@microsoft/sp-page-context!' @@ -90,7 +90,7 @@ properties: syntax: content: 'static readonly applyThemeAndBorder: SPPermission;' return: - type: '' + type: - name: approveItems uid: '@microsoft/sp-page-context!SPPermission.approveItems:member' package: '@microsoft/sp-page-context!' @@ -102,7 +102,7 @@ properties: syntax: content: 'static readonly approveItems: SPPermission;' return: - type: '' + type: - name: browseDirectories uid: '@microsoft/sp-page-context!SPPermission.browseDirectories:member' package: '@microsoft/sp-page-context!' @@ -114,7 +114,7 @@ properties: syntax: content: 'static readonly browseDirectories: SPPermission;' return: - type: '' + type: - name: browserUserInfo uid: '@microsoft/sp-page-context!SPPermission.browserUserInfo:member' package: '@microsoft/sp-page-context!' @@ -126,7 +126,7 @@ properties: syntax: content: 'static readonly browserUserInfo: SPPermission;' return: - type: '' + type: - name: cancelCheckout uid: '@microsoft/sp-page-context!SPPermission.cancelCheckout:member' package: '@microsoft/sp-page-context!' @@ -138,7 +138,7 @@ properties: syntax: content: 'static readonly cancelCheckout: SPPermission;' return: - type: '' + type: - name: createAlerts uid: '@microsoft/sp-page-context!SPPermission.createAlerts:member' package: '@microsoft/sp-page-context!' @@ -150,7 +150,7 @@ properties: syntax: content: 'static readonly createAlerts: SPPermission;' return: - type: '' + type: - name: createGroups uid: '@microsoft/sp-page-context!SPPermission.createGroups:member' package: '@microsoft/sp-page-context!' @@ -162,7 +162,7 @@ properties: syntax: content: 'static readonly createGroups: SPPermission;' return: - type: '' + type: - name: createSSCSite uid: '@microsoft/sp-page-context!SPPermission.createSSCSite:member' package: '@microsoft/sp-page-context!' @@ -174,19 +174,19 @@ properties: syntax: content: 'static readonly createSSCSite: SPPermission;' return: - type: '' + type: - name: deleteListItems uid: '@microsoft/sp-page-context!SPPermission.deleteListItems:member' package: '@microsoft/sp-page-context!' fullName: deleteListItems - summary: 'Delete items from a list, documents from a document library, and Web discussion comments in documents.' + summary: Delete items from a list, documents from a document library, and Web discussion comments in documents. remarks: '' isPreview: false isDeprecated: false syntax: content: 'static readonly deleteListItems: SPPermission;' return: - type: '' + type: - name: deleteVersions uid: '@microsoft/sp-page-context!SPPermission.deleteVersions:member' package: '@microsoft/sp-page-context!' @@ -198,7 +198,7 @@ properties: syntax: content: 'static readonly deleteVersions: SPPermission;' return: - type: '' + type: - name: editListItems uid: '@microsoft/sp-page-context!SPPermission.editListItems:member' package: '@microsoft/sp-page-context!' @@ -212,19 +212,19 @@ properties: syntax: content: 'static readonly editListItems: SPPermission;' return: - type: '' + type: - name: editMyUserInfo uid: '@microsoft/sp-page-context!SPPermission.editMyUserInfo:member' package: '@microsoft/sp-page-context!' fullName: editMyUserInfo - summary: 'Allows a user to change his or her user information, such as adding a picture.' + summary: Allows a user to change his or her user information, such as adding a picture. remarks: '' isPreview: false isDeprecated: false syntax: content: 'static readonly editMyUserInfo: SPPermission;' return: - type: '' + type: - name: emptyMask uid: '@microsoft/sp-page-context!SPPermission.emptyMask:member' package: '@microsoft/sp-page-context!' @@ -236,19 +236,19 @@ properties: syntax: content: 'static readonly emptyMask: SPPermission;' return: - type: '' + type: - name: enumeratePermissions uid: '@microsoft/sp-page-context!SPPermission.enumeratePermissions:member' package: '@microsoft/sp-page-context!' fullName: enumeratePermissions - summary: 'Enumerate permissions on the Web site, list, folder, document, or list item.' + summary: Enumerate permissions on the Web site, list, folder, document, or list item. remarks: '' isPreview: false isDeprecated: false syntax: content: 'static readonly enumeratePermissions: SPPermission;' return: - type: '' + type: - name: fullMask uid: '@microsoft/sp-page-context!SPPermission.fullMask:member' package: '@microsoft/sp-page-context!' @@ -260,7 +260,7 @@ properties: syntax: content: 'static readonly fullMask: SPPermission;' return: - type: '' + type: - name: layoutsPage uid: '@microsoft/sp-page-context!SPPermission.layoutsPage:member' package: '@microsoft/sp-page-context!' @@ -272,7 +272,7 @@ properties: syntax: content: 'static readonly layoutsPage: SPPermission;' return: - type: '' + type: - name: manageAlerts uid: '@microsoft/sp-page-context!SPPermission.manageAlerts:member' package: '@microsoft/sp-page-context!' @@ -284,19 +284,19 @@ properties: syntax: content: 'static readonly manageAlerts: SPPermission;' return: - type: '' + type: - name: manageLists uid: '@microsoft/sp-page-context!SPPermission.manageLists:member' package: '@microsoft/sp-page-context!' fullName: manageLists - summary: 'Create and delete lists, add or remove columns in a list, and add or remove public views of a list.' + summary: Create and delete lists, add or remove columns in a list, and add or remove public views of a list. remarks: '' isPreview: false isDeprecated: false syntax: content: 'static readonly manageLists: SPPermission;' return: - type: '' + type: - name: managePermissions uid: '@microsoft/sp-page-context!SPPermission.managePermissions:member' package: '@microsoft/sp-page-context!' @@ -308,31 +308,31 @@ properties: syntax: content: 'static readonly managePermissions: SPPermission;' return: - type: '' + type: - name: managePersonalViews uid: '@microsoft/sp-page-context!SPPermission.managePersonalViews:member' package: '@microsoft/sp-page-context!' fullName: managePersonalViews - summary: 'Create, change, and delete personal views of lists.' + summary: Create, change, and delete personal views of lists. remarks: '' isPreview: false isDeprecated: false syntax: content: 'static readonly managePersonalViews: SPPermission;' return: - type: '' + type: - name: manageSubwebs uid: '@microsoft/sp-page-context!SPPermission.manageSubwebs:member' package: '@microsoft/sp-page-context!' fullName: manageSubwebs - summary: 'Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites.' + summary: Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites. remarks: '' isPreview: false isDeprecated: false syntax: content: 'static readonly manageSubwebs: SPPermission;' return: - type: '' + type: - name: manageWeb uid: '@microsoft/sp-page-context!SPPermission.manageWeb:member' package: '@microsoft/sp-page-context!' @@ -349,19 +349,19 @@ properties: syntax: content: 'static readonly manageWeb: SPPermission;' return: - type: '' + type: - name: open uid: '@microsoft/sp-page-context!SPPermission.open:member' package: '@microsoft/sp-page-context!' fullName: open - summary: 'Allow users to open a Web site, list, or folder to access items inside that container.' + summary: Allow users to open a Web site, list, or folder to access items inside that container. remarks: '' isPreview: false isDeprecated: false syntax: content: 'static readonly open: SPPermission;' return: - type: '' + type: - name: openItems uid: '@microsoft/sp-page-context!SPPermission.openItems:member' package: '@microsoft/sp-page-context!' @@ -373,7 +373,7 @@ properties: syntax: content: 'static readonly openItems: SPPermission;' return: - type: '' + type: - name: updatePersonalWebParts uid: '@microsoft/sp-page-context!SPPermission.updatePersonalWebParts:member' package: '@microsoft/sp-page-context!' @@ -385,31 +385,31 @@ properties: syntax: content: 'static readonly updatePersonalWebParts: SPPermission;' return: - type: '' + type: - name: useClientIntegration uid: '@microsoft/sp-page-context!SPPermission.useClientIntegration:member' package: '@microsoft/sp-page-context!' fullName: useClientIntegration - summary: 'Use features that launch client applications; otherwise, users must work on documents locally and upload changes.' + summary: Use features that launch client applications; otherwise, users must work on documents locally and upload changes. remarks: '' isPreview: false isDeprecated: false syntax: content: 'static readonly useClientIntegration: SPPermission;' return: - type: '' + type: - name: useRemoteAPIs uid: '@microsoft/sp-page-context!SPPermission.useRemoteAPIs:member' package: '@microsoft/sp-page-context!' fullName: useRemoteAPIs - summary: 'Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site.' + summary: Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site. remarks: '' isPreview: false isDeprecated: false syntax: content: 'static readonly useRemoteAPIs: SPPermission;' return: - type: '' + type: - name: value uid: '@microsoft/sp-page-context!SPPermission#value:member' package: '@microsoft/sp-page-context!' @@ -421,31 +421,31 @@ properties: syntax: content: 'get value(): IODataBasePermission;' return: - type: '' + type: - name: viewFormPages uid: '@microsoft/sp-page-context!SPPermission.viewFormPages:member' package: '@microsoft/sp-page-context!' fullName: viewFormPages - summary: 'View forms, views, and application pages, and enumerate lists.' + summary: View forms, views, and application pages, and enumerate lists. remarks: '' isPreview: false isDeprecated: false syntax: content: 'static readonly viewFormPages: SPPermission;' return: - type: '' + type: - name: viewListItems uid: '@microsoft/sp-page-context!SPPermission.viewListItems:member' package: '@microsoft/sp-page-context!' fullName: viewListItems - summary: 'View items in lists, documents in document libraries, and view Web discussion comments.' + summary: View items in lists, documents in document libraries, and view Web discussion comments. remarks: '' isPreview: false isDeprecated: false syntax: content: 'static readonly viewListItems: SPPermission;' return: - type: '' + type: - name: viewPages uid: '@microsoft/sp-page-context!SPPermission.viewPages:member' package: '@microsoft/sp-page-context!' @@ -457,7 +457,7 @@ properties: syntax: content: 'static readonly viewPages: SPPermission;' return: - type: '' + type: - name: viewUsageData uid: '@microsoft/sp-page-context!SPPermission.viewUsageData:member' package: '@microsoft/sp-page-context!' @@ -469,7 +469,7 @@ properties: syntax: content: 'static readonly viewUsageData: SPPermission;' return: - type: '' + type: - name: viewVersions uid: '@microsoft/sp-page-context!SPPermission.viewVersions:member' package: '@microsoft/sp-page-context!' @@ -481,7 +481,7 @@ properties: syntax: content: 'static readonly viewVersions: SPPermission;' return: - type: '' + type: methods: - name: hasAllPermissions(requestedPerms) uid: '@microsoft/sp-page-context!SPPermission#hasAllPermissions:member(1)' @@ -496,7 +496,7 @@ methods: parameters: - id: requestedPerms description: Any number of SPPermission objects to be compared against the original - type: '[]' + type: [] return: type: boolean description: '' @@ -513,7 +513,7 @@ methods: parameters: - id: requestedPerms description: Any number of SPPermission objects to be compared against the original - type: '[]' + type: [] return: type: boolean description: '' @@ -530,7 +530,7 @@ methods: parameters: - id: requestedPerm description: The SPPermission object to be compared against the original - type: '' + type: return: type: boolean description: '' diff --git a/SP-Framework/sp-page-context/spsite.yml b/SP-Framework/sp-page-context/spsite.yml index cfa55421..6e20a891 100644 --- a/SP-Framework/sp-page-context/spsite.yml +++ b/SP-Framework/sp-page-context/spsite.yml @@ -60,7 +60,7 @@ properties: syntax: content: 'readonly correlationId: Guid;' return: - type: '' + type: - name: group uid: '@microsoft/sp-page-context!SPSite#group:member' package: '@microsoft/sp-page-context!' @@ -74,7 +74,7 @@ properties: syntax: content: 'readonly group: O365GroupAssociation | undefined;' return: - type: ' | undefined' + type: | undefined - name: id uid: '@microsoft/sp-page-context!SPSite#id:member' package: '@microsoft/sp-page-context!' @@ -86,7 +86,7 @@ properties: syntax: content: 'readonly id: Guid;' return: - type: '' + type: - name: isNoScriptEnabled uid: '@microsoft/sp-page-context!SPSite#isNoScriptEnabled:member' package: '@microsoft/sp-page-context!' diff --git a/SP-Framework/sp-page-context/sptimezone.yml b/SP-Framework/sp-page-context/sptimezone.yml index 374e968c..fc098398 100644 --- a/SP-Framework/sp-page-context/sptimezone.yml +++ b/SP-Framework/sp-page-context/sptimezone.yml @@ -34,7 +34,7 @@ properties: syntax: content: 'readonly daylightDate: ISPSystemTime;' return: - type: '' + type: - name: daylightOffset uid: '@microsoft/sp-page-context!SPTimeZone#daylightOffset:member' package: '@microsoft/sp-page-context!' @@ -96,7 +96,7 @@ properties: syntax: content: 'readonly standardDate: ISPSystemTime;' return: - type: '' + type: - name: standardOffset uid: '@microsoft/sp-page-context!SPTimeZone#standardOffset:member' package: '@microsoft/sp-page-context!' diff --git a/SP-Framework/sp-page-context/spuser.yml b/SP-Framework/sp-page-context/spuser.yml index ddf39e5b..e0cc619b 100644 --- a/SP-Framework/sp-page-context/spuser.yml +++ b/SP-Framework/sp-page-context/spuser.yml @@ -48,7 +48,7 @@ properties: syntax: content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' return: - type: ' | undefined' + type: | undefined - name: isAnonymousGuestUser uid: '@microsoft/sp-page-context!SPUser#isAnonymousGuestUser:member' package: '@microsoft/sp-page-context!' @@ -108,4 +108,4 @@ properties: syntax: content: 'readonly timeZoneInfo: SPTimeZone | undefined;' return: - type: ' | undefined' + type: | undefined diff --git a/SP-Framework/sp-page-context/spweb.yml b/SP-Framework/sp-page-context/spweb.yml index cd4f67c0..82d714b5 100644 --- a/SP-Framework/sp-page-context/spweb.yml +++ b/SP-Framework/sp-page-context/spweb.yml @@ -48,7 +48,7 @@ properties: syntax: content: 'readonly firstDayOfWeek: SPDayOfWeek | undefined;' return: - type: ' | undefined' + type: | undefined - name: id uid: '@microsoft/sp-page-context!SPWeb#id:member' package: '@microsoft/sp-page-context!' @@ -60,7 +60,7 @@ properties: syntax: content: 'readonly id: Guid;' return: - type: '' + type: - name: isAppWeb uid: '@microsoft/sp-page-context!SPWeb#isAppWeb:member' package: '@microsoft/sp-page-context!' @@ -102,7 +102,7 @@ properties: package: '@microsoft/sp-page-context!' fullName: logoUrl summary: Returns the absolute URL of the website logo. - remarks: 'Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg`' + remarks: Example:` https://example.com/sites/PubSite/SubWeb/logo.jpg` isPreview: false isDeprecated: false syntax: @@ -122,7 +122,7 @@ properties: syntax: content: 'readonly permissions: SPPermission;' return: - type: '' + type: - name: serverRelativeUrl uid: '@microsoft/sp-page-context!SPWeb#serverRelativeUrl:member' package: '@microsoft/sp-page-context!' @@ -160,7 +160,7 @@ properties: syntax: content: 'readonly timeZoneInfo: SPTimeZone | undefined;' return: - type: ' | undefined' + type: | undefined - name: title uid: '@microsoft/sp-page-context!SPWeb#title:member' package: '@microsoft/sp-page-context!' diff --git a/SP-Framework/sp-property-pane.yml b/SP-Framework/sp-property-pane.yml index ce818415..424c9ef1 100644 --- a/SP-Framework/sp-property-pane.yml +++ b/SP-Framework/sp-property-pane.yml @@ -56,7 +56,7 @@ typeAliases: - '@microsoft/sp-property-pane!PropertyPaneHeadingLevel:type' - '@microsoft/sp-property-pane!ThumbnailType:type' functions: - - name: 'PropertyPaneButton(targetProperty, properties)' + - name: PropertyPaneButton(targetProperty, properties) uid: '@microsoft/sp-property-pane!PropertyPaneButton:function(1)' package: '@microsoft/sp-property-pane!' summary: Helper method to create a Button on the PropertyPane. @@ -73,13 +73,13 @@ functions: type: string - id: properties description: Strongly typed Button properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneCheckbox(targetProperty, properties)' + - name: PropertyPaneCheckbox(targetProperty, properties) uid: '@microsoft/sp-property-pane!PropertyPaneCheckbox:function(1)' package: '@microsoft/sp-property-pane!' summary: Helper method to create a Checkbox on the PropertyPane. @@ -96,13 +96,13 @@ functions: type: string - id: properties description: Strongly typed Checkbox properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneChoiceGroup(targetProperty, properties)' + - name: PropertyPaneChoiceGroup(targetProperty, properties) uid: '@microsoft/sp-property-pane!PropertyPaneChoiceGroup:function(1)' package: '@microsoft/sp-property-pane!' summary: Helper method to create a Choice Group on the PropertyPane. @@ -119,7 +119,7 @@ functions: type: string - id: properties description: Strongly typed Choice Group properties. - type: '' + type: return: type: >- <' + type: return: type: >- <> description: '' - - name: 'PropertyPaneDropdown(targetProperty, properties)' + - name: PropertyPaneDropdown(targetProperty, properties) uid: '@microsoft/sp-property-pane!PropertyPaneDropdown:function(1)' package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dropdown on the PropertyPane. @@ -166,13 +166,13 @@ functions: type: string - id: properties description: Strongly typed Dropdown properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneDynamicField(targetProperty, properties)' + - name: PropertyPaneDynamicField(targetProperty, properties) uid: '@microsoft/sp-property-pane!PropertyPaneDynamicField:function(1)' package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. @@ -189,7 +189,7 @@ functions: type: string - id: properties description: '' - type: '' + type: return: type: >- <' + type: return: type: >- <> description: '' - - name: 'PropertyPaneDynamicTextField(targetProperty, properties)' + - name: PropertyPaneDynamicTextField(targetProperty, properties) uid: '@microsoft/sp-property-pane!PropertyPaneDynamicTextField:function(1)' package: '@microsoft/sp-property-pane!' summary: Helper method to create a Dynamic TextField on the PropertyPane. @@ -241,13 +241,13 @@ functions: type: string - id: properties description: Properties of the PropertyPaneDynamicTextField. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneHeading(targetProperty, properties)' + - name: PropertyPaneHeading(targetProperty, properties) uid: '@microsoft/sp-property-pane!PropertyPaneHeading:function(1)' package: '@microsoft/sp-property-pane!' summary: Helper method to create a heading on the PropertyPane. Temporary solution while waiting for redesign @@ -264,7 +264,7 @@ functions: type: string - id: properties description: Strongly typed Label properties. - type: '' + type: return: type: >- <;' return: - type: '<void>' + type: <void> description: '' - - name: 'PropertyPaneIconPicker(targetProperty, properties)' + - name: PropertyPaneIconPicker(targetProperty, properties) uid: '@microsoft/sp-property-pane!PropertyPaneIconPicker:function(1)' package: '@microsoft/sp-property-pane!' summary: Helper method to create an IconPicker on the PropertyPane. @@ -299,13 +299,13 @@ functions: type: string - id: properties description: Strongly typed IconPicker properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneLabel(targetProperty, properties)' + - name: PropertyPaneLabel(targetProperty, properties) uid: '@microsoft/sp-property-pane!PropertyPaneLabel:function(1)' package: '@microsoft/sp-property-pane!' summary: Helper method to create a Label on the PropertyPane. @@ -322,13 +322,13 @@ functions: type: string - id: properties description: Strongly typed Label properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneLink(targetProperty, properties)' + - name: PropertyPaneLink(targetProperty, properties) uid: '@microsoft/sp-property-pane!PropertyPaneLink:function(1)' package: '@microsoft/sp-property-pane!' summary: Helper method to create a Link on the PropertyPane. @@ -345,13 +345,13 @@ functions: type: string - id: properties description: Strongly typed Link properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneSlider(targetProperty, properties)' + - name: PropertyPaneSlider(targetProperty, properties) uid: '@microsoft/sp-property-pane!PropertyPaneSlider:function(1)' package: '@microsoft/sp-property-pane!' summary: Helper method to create a Slider on the PropertyPane. @@ -368,13 +368,13 @@ functions: type: string - id: properties description: Strongly typed Slider properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneSpinButton(targetProperty, properties)' + - name: PropertyPaneSpinButton(targetProperty, properties) uid: '@microsoft/sp-property-pane!PropertyPaneSpinButton:function(1)' package: '@microsoft/sp-property-pane!' summary: Helper method to create a SpinButton on the property pane. @@ -391,13 +391,13 @@ functions: type: string - id: properties description: Strongly typed spin button properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneTextField(targetProperty, properties)' + - name: PropertyPaneTextField(targetProperty, properties) uid: '@microsoft/sp-property-pane!PropertyPaneTextField:function(1)' package: '@microsoft/sp-property-pane!' summary: Helper method to create a TextField on the PropertyPane. @@ -414,13 +414,13 @@ functions: type: string - id: properties description: Strongly typed TextField properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneThumbnailPicker(targetProperty, properties)' + - name: PropertyPaneThumbnailPicker(targetProperty, properties) uid: '@microsoft/sp-property-pane!PropertyPaneThumbnailPicker:function(1)' package: '@microsoft/sp-property-pane!' summary: Helper method to create a ThumbnailPicker on the PropertyPane. @@ -437,13 +437,13 @@ functions: type: string - id: properties description: Strongly typed ThumbnailPicker properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneToggle(targetProperty, properties)' + - name: PropertyPaneToggle(targetProperty, properties) uid: '@microsoft/sp-property-pane!PropertyPaneToggle:function(1)' package: '@microsoft/sp-property-pane!' summary: Helper method to create a Toggle on the PropertyPane. @@ -460,7 +460,7 @@ functions: type: string - id: properties description: Strongly typed Toggle properties. - type: '' + type: return: type: >- <' + type: diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml index 84c97986..1d89292b 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourceconfiguration.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'filters?: IDynamicDataSharedSourceFilters;' return: - type: '' + type: - name: sourcesLabel uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceConfiguration#sourcesLabel:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml index 221599b2..2fe35fcc 100644 --- a/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-property-pane/idynamicdatasharedsourcefilters.yml @@ -33,7 +33,7 @@ properties: syntax: content: 'componentId?: Guid;' return: - type: '' + type: - name: sourceId uid: '@microsoft/sp-property-pane!IDynamicDataSharedSourceFilters#sourceId:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/imagefit-typealias.yml b/SP-Framework/sp-property-pane/imagefit-typealias.yml index e1421714..4ca8ce05 100644 --- a/SP-Framework/sp-property-pane/imagefit-typealias.yml +++ b/SP-Framework/sp-property-pane/imagefit-typealias.yml @@ -7,4 +7,4 @@ summary: The possible methods that can be used to fit the image. remarks: '' isPreview: true isDeprecated: false -syntax: 'export type ImageFit = typeof ImageFit[keyof typeof ImageFit];' +syntax: export type ImageFit = (typeof ImageFit)[keyof typeof ImageFit]; diff --git a/SP-Framework/sp-property-pane/ipopupwindowprops.yml b/SP-Framework/sp-property-pane/ipopupwindowprops.yml index 1467aac8..b1523111 100644 --- a/SP-Framework/sp-property-pane/ipopupwindowprops.yml +++ b/SP-Framework/sp-property-pane/ipopupwindowprops.yml @@ -32,7 +32,7 @@ properties: syntax: content: 'positionWindowPosition: PopupWindowPosition;' return: - type: '' + type: - name: title uid: '@microsoft/sp-property-pane!IPopupWindowProps#title:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml index eb8971e7..d0d93d58 100644 --- a/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanebuttonprops.yml @@ -47,7 +47,7 @@ properties: syntax: content: 'buttonType?: PropertyPaneButtonType;' return: - type: '' + type: - name: description uid: '@microsoft/sp-property-pane!IPropertyPaneButtonProps#description:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml index 8f592731..7e8f6784 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupoption.yml @@ -59,7 +59,7 @@ properties: syntax: content: 'iconProps?: IPropertyPaneChoiceGroupOptionIconProps;' return: - type: '' + type: - name: imageAlt uid: '@microsoft/sp-property-pane!IPropertyPaneChoiceGroupOption#imageAlt:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml index d93a8ad9..832f5d1b 100644 --- a/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanechoicegroupprops.yml @@ -32,4 +32,4 @@ properties: syntax: content: 'options: IPropertyPaneChoiceGroupOption[];' return: - type: '[]' + type: [] diff --git a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml index af4fcd70..47f1104f 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconditionalgroup.yml @@ -44,7 +44,7 @@ properties: syntax: content: 'primaryGroup: IPropertyPaneGroup;' return: - type: '' + type: - name: secondaryGroup uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#secondaryGroup:member' package: '@microsoft/sp-property-pane!' @@ -56,7 +56,7 @@ properties: syntax: content: 'secondaryGroup: IPropertyPaneGroup;' return: - type: '' + type: - name: showSecondaryGroup uid: '@microsoft/sp-property-pane!IPropertyPaneConditionalGroup#showSecondaryGroup:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml index ebe62f32..b7b87347 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneconfiguration.yml @@ -36,7 +36,7 @@ properties: syntax: content: 'debounceProperties?: IPropertyPaneDebounceProperty[];' return: - type: '[]' + type: [] - name: disableAudiencePicker uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#disableAudiencePicker:member' package: '@microsoft/sp-property-pane!' @@ -61,6 +61,21 @@ properties: content: 'disableFocusTrap?: boolean;' return: type: boolean + - name: disableVisibilityGroup + uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#disableVisibilityGroup:member' + package: '@microsoft/sp-property-pane!' + fullName: disableVisibilityGroup + summary: Whether or not to show the "Visibility" group in the property pane. + remarks: >- + This property was created since this group should only be available for overall web part configuration, not + individual items within web parts (e.g., links in quick links). Note: This group is available to 1p/3p web parts, + so we may consider releasing this api for more 3p control. + isPreview: true + isDeprecated: false + syntax: + content: 'disableVisibilityGroup?: boolean;' + return: + type: boolean - name: loadingIndicatorDelayTime uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#loadingIndicatorDelayTime:member' package: '@microsoft/sp-property-pane!' @@ -84,19 +99,19 @@ properties: syntax: content: 'pages: IPropertyPanePage[];' return: - type: '[]' + type: [] - name: pagesType uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#pagesType:member' package: '@microsoft/sp-property-pane!' fullName: pagesType - summary: 'Type of pages to be displayed on the PropertyPane. By default, it works as ''Pages'' for multi pages property pane.' + summary: Type of pages to be displayed on the PropertyPane. By default, it works as 'Pages' for multi pages property pane. remarks: '' isPreview: true isDeprecated: false syntax: content: 'pagesType?: PagesType;' return: - type: '' + type: - name: showLoadingIndicator uid: '@microsoft/sp-property-pane!IPropertyPaneConfiguration#showLoadingIndicator:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml index 1cd10929..93d27c76 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedebounceproperty.yml @@ -3,7 +3,7 @@ name: IPropertyPaneDebounceProperty uid: '@microsoft/sp-property-pane!IPropertyPaneDebounceProperty:interface' package: '@microsoft/sp-property-pane!' fullName: IPropertyPaneDebounceProperty -summary: 'Definition of a Property Pane property, which should have the `onPropertyPaneFieldChanged` event be debounced.' +summary: Definition of a Property Pane property, which should have the `onPropertyPaneFieldChanged` event be debounced. remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml index 79657fe2..6d292930 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownoption.yml @@ -49,11 +49,11 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownOption#type:member' package: '@microsoft/sp-property-pane!' fullName: type - summary: 'The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal' + summary: The type of option. If omitted, the default is PropertyPaneDropdownMenuItemType.Normal remarks: '' isPreview: false isDeprecated: false syntax: content: 'type?: PropertyPaneDropdownOptionType;' return: - type: '' + type: diff --git a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml index c48be2a7..8bc88969 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedropdownprops.yml @@ -70,7 +70,7 @@ properties: syntax: content: 'calloutProps?: IPropertyPaneDropdownCalloutProps;' return: - type: '' + type: - name: disabled uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#disabled:member' package: '@microsoft/sp-property-pane!' @@ -87,7 +87,7 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#errorMessage:member' package: '@microsoft/sp-property-pane!' fullName: errorMessage - summary: 'If set, this will be displayed as an error message.' + summary: If set, this will be displayed as an error message. remarks: '' isPreview: true isDeprecated: false @@ -118,7 +118,7 @@ properties: syntax: content: 'options?: IPropertyPaneDropdownOption[];' return: - type: '[]' + type: [] - name: selectedKey uid: '@microsoft/sp-property-pane!IPropertyPaneDropdownProps#selectedKey:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml index 6c575d36..c18f1c60 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldprops.yml @@ -20,12 +20,12 @@ properties: syntax: content: 'filters?: IPropertyPaneDynamicFieldFilters;' return: - type: '' + type: - name: label uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldProps#label:member' package: '@microsoft/sp-property-pane!' fullName: label - summary: 'User-friendly, localized label to identify the field.' + summary: User-friendly, localized label to identify the field. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml index 2f3eb31e..60300855 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamicfieldsetprops.yml @@ -27,7 +27,7 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicFieldSetProps#label:member' package: '@microsoft/sp-property-pane!' fullName: label - summary: 'User-friendly, localized label to identify the property.' + summary: User-friendly, localized label to identify the property. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml index 33ad157f..84df9d2d 100644 --- a/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanedynamictextfieldprops.yml @@ -14,7 +14,7 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#ariaLabel:member' package: '@microsoft/sp-property-pane!' fullName: ariaLabel - summary: 'ARIA Label for text field, if any.' + summary: ARIA Label for text field, if any. remarks: '' isPreview: true isDeprecated: false @@ -50,7 +50,7 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneDynamicTextFieldProps#errorMessage:member' package: '@microsoft/sp-property-pane!' fullName: errorMessage - summary: 'If set, this will be displayed as an error message.' + 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. diff --git a/SP-Framework/sp-property-pane/ipropertypanefield.yml b/SP-Framework/sp-property-pane/ipropertypanefield.yml index 193fe82f..cebfe8ce 100644 --- a/SP-Framework/sp-property-pane/ipropertypanefield.yml +++ b/SP-Framework/sp-property-pane/ipropertypanefield.yml @@ -56,4 +56,4 @@ properties: syntax: content: 'type: PropertyPaneFieldType;' return: - type: '' + type: diff --git a/SP-Framework/sp-property-pane/ipropertypanegroup.yml b/SP-Framework/sp-property-pane/ipropertypanegroup.yml index 34db3cfd..2e12c6c1 100644 --- a/SP-Framework/sp-property-pane/ipropertypanegroup.yml +++ b/SP-Framework/sp-property-pane/ipropertypanegroup.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'groupFields: IPropertyPaneField[];' return: - type: '<any>[]' + type: <any>[] - name: groupName uid: '@microsoft/sp-property-pane!IPropertyPaneGroup#groupName:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypaneheadingprops.yml b/SP-Framework/sp-property-pane/ipropertypaneheadingprops.yml index c31ccabf..281d16d8 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneheadingprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneheadingprops.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'headingLevel?: PropertyPaneHeadingLevel;' return: - type: '' + type: - name: text uid: '@microsoft/sp-property-pane!IPropertyPaneHeadingProps#text:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml b/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml index 4f5a5bc9..50642840 100644 --- a/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypaneiconpickerprops.yml @@ -34,12 +34,12 @@ properties: syntax: content: 'customIconSet?: Map;' return: - type: 'Map<string, >' + type: Map<string, > - name: customSelectedIconName uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#customSelectedIconName:member' package: '@microsoft/sp-property-pane!' fullName: customSelectedIconName - summary: 'When invoking with a custom icon set, this is the name of the currently selected icon.' + summary: When invoking with a custom icon set, this is the name of the currently selected icon. remarks: '' isPreview: true isDeprecated: false @@ -51,7 +51,7 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#disabled:member' package: '@microsoft/sp-property-pane!' fullName: disabled - summary: 'If specified, disables the action buttons so icons cannot be selected or changed.' + summary: If specified, disables the action buttons so icons cannot be selected or changed. remarks: '' isPreview: true isDeprecated: false @@ -118,7 +118,7 @@ properties: syntax: content: 'thumbnail?: IThumbnail;' return: - type: '' + type: - name: thumbnailRendererIconClassName uid: '@microsoft/sp-property-pane!IPropertyPaneIconPickerProps#thumbnailRendererIconClassName:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml index 66389b85..6ec289f8 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelabelprops.yml @@ -14,7 +14,7 @@ properties: package: '@microsoft/sp-property-pane!' fullName: required summary: Whether the associated form field is required or not. - remarks: 'If true, a red asterisk is displayed to the right of the label. Default value is false.' + remarks: If true, a red asterisk is displayed to the right of the label. Default value is false. isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml index 05987590..99c8f6e7 100644 --- a/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanelinkprops.yml @@ -56,7 +56,7 @@ properties: syntax: content: 'popupWindowProps?: IPopupWindowProps;' return: - type: '' + type: - name: target uid: '@microsoft/sp-property-pane!IPropertyPaneLinkProps#target:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanepage.yml b/SP-Framework/sp-property-pane/ipropertypanepage.yml index 3d298aaf..4dbbd655 100644 --- a/SP-Framework/sp-property-pane/ipropertypanepage.yml +++ b/SP-Framework/sp-property-pane/ipropertypanepage.yml @@ -46,7 +46,7 @@ properties: syntax: content: 'header?: IPropertyPanePageHeader;' return: - type: '' + type: - name: title uid: '@microsoft/sp-property-pane!IPropertyPanePage#title:member' package: '@microsoft/sp-property-pane!' diff --git a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml index 03e61168..26bb7d60 100644 --- a/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanesliderprops.yml @@ -74,7 +74,7 @@ properties: package: '@microsoft/sp-property-pane!' fullName: showValue summary: Whether to show the value on the right of the Slider. - remarks: 'If you want to show the value by yourself, you may want to set this value to false.' + remarks: If you want to show the value by yourself, you may want to set this value to false. isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml index 4941f535..4b8f49b5 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetextfieldprops.yml @@ -13,7 +13,7 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#ariaLabel:member' package: '@microsoft/sp-property-pane!' fullName: ariaLabel - summary: 'Aria Label for text field, if any.' + summary: Aria Label for text field, if any. remarks: '' isPreview: false isDeprecated: false @@ -61,7 +61,7 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#errorMessage:member' package: '@microsoft/sp-property-pane!' fullName: errorMessage - summary: 'If set, this will be displayed as an error message.' + 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. @@ -131,7 +131,7 @@ properties: package: '@microsoft/sp-property-pane!' fullName: maxLength summary: Maximum number of characters that the PropertyPaneTextField can have. - remarks: 'If the value is set to a negative number, an exception will be thrown.' + remarks: If the value is set to a negative number, an exception will be thrown. isPreview: false isDeprecated: false syntax: @@ -213,7 +213,7 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneTextFieldProps#rows:member' package: '@microsoft/sp-property-pane!' fullName: rows - summary: 'Specifies the visible height of a text area(multiline text TextField), in lines.' + summary: Specifies the visible height of a text area(multiline text TextField), in lines. remarks: This prop is used only when the multiline prop is set to true. isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml b/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml index 9b540b00..c6f1de90 100644 --- a/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanethumbnailpickerprops.yml @@ -75,7 +75,7 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#previewFullWidth:member' package: '@microsoft/sp-property-pane!' fullName: previewFullWidth - summary: 'For the preview image, display with full width as opposed to the default fixed ratio.' + summary: For the preview image, display with full width as opposed to the default fixed ratio. remarks: '' isPreview: true isDeprecated: false @@ -106,7 +106,7 @@ properties: syntax: content: 'serviceScope: ServiceScope;' return: - type: '' + type: - name: thumbnail uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#thumbnail:member' package: '@microsoft/sp-property-pane!' @@ -118,7 +118,7 @@ properties: syntax: content: 'thumbnail?: IThumbnail;' return: - type: '' + type: - name: thumbnailRendererIconClassName uid: '@microsoft/sp-property-pane!IPropertyPaneThumbnailPickerProps#thumbnailRendererIconClassName:member' package: '@microsoft/sp-property-pane!' @@ -143,3 +143,4 @@ properties: content: 'thumbnailRendererWrapperClassName?: string;' return: type: string +extends: Pick<, 'enableGettyStockAssets'> diff --git a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml index 63317a99..a836c185 100644 --- a/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-property-pane/ipropertypanetoggleprops.yml @@ -25,7 +25,7 @@ properties: uid: '@microsoft/sp-property-pane!IPropertyPaneToggleProps#checked:member' package: '@microsoft/sp-property-pane!' fullName: checked - summary: 'Checked state of the toggle. If you are maintaining state yourself, set this property accordingly.' + summary: Checked state of the toggle. If you are maintaining state yourself, set this property accordingly. remarks: '' isPreview: false isDeprecated: false diff --git a/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml b/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml index 5b47479f..e0f26b1e 100644 --- a/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml +++ b/SP-Framework/sp-property-pane/ithumbnailfabricreacticon.yml @@ -56,4 +56,4 @@ properties: syntax: content: 'type: typeof ThumbnailType.FabricReactIcon;' return: - type: 'typeof @microsoft/sp-property-pane!~__type#' + type: typeof @microsoft/sp-property-pane!~__type# diff --git a/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml b/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml index cfeadb63..08fb4f89 100644 --- a/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml +++ b/SP-Framework/sp-property-pane/ithumbnailiconsizeimage.yml @@ -56,4 +56,4 @@ properties: syntax: content: 'type: typeof ThumbnailType.IconSizeImage;' return: - type: 'typeof @microsoft/sp-property-pane!~__type#' + type: typeof @microsoft/sp-property-pane!~__type# diff --git a/SP-Framework/sp-property-pane/ithumbnailimage.yml b/SP-Framework/sp-property-pane/ithumbnailimage.yml index 10f7addf..0c66d088 100644 --- a/SP-Framework/sp-property-pane/ithumbnailimage.yml +++ b/SP-Framework/sp-property-pane/ithumbnailimage.yml @@ -44,7 +44,7 @@ properties: syntax: content: 'imageFit: ImageFit | undefined;' return: - type: ' | undefined' + type: | undefined - name: imageUrl uid: '@microsoft/sp-property-pane!IThumbnailImage#imageUrl:member' package: '@microsoft/sp-property-pane!' @@ -68,4 +68,5 @@ properties: syntax: content: 'type: typeof ThumbnailType.Image;' return: - type: 'typeof @microsoft/sp-property-pane!~__type#' + type: typeof @microsoft/sp-property-pane!~__type# +extends: diff --git a/SP-Framework/sp-property-pane/propertypaneheadinglevel.yml b/SP-Framework/sp-property-pane/propertypaneheadinglevel.yml index 6444d53f..32c093a8 100644 --- a/SP-Framework/sp-property-pane/propertypaneheadinglevel.yml +++ b/SP-Framework/sp-property-pane/propertypaneheadinglevel.yml @@ -3,7 +3,7 @@ name: PropertyPaneHeadingLevel uid: '@microsoft/sp-property-pane!PropertyPaneHeadingLevel:type' package: '@microsoft/sp-property-pane!' fullName: PropertyPaneHeadingLevel -summary: 'Type for the heading levels, h1-h6' +summary: Type for the heading levels, h1-h6 remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-property-pane/thumbnailtype-typealias.yml b/SP-Framework/sp-property-pane/thumbnailtype-typealias.yml index 02aad543..9e987188 100644 --- a/SP-Framework/sp-property-pane/thumbnailtype-typealias.yml +++ b/SP-Framework/sp-property-pane/thumbnailtype-typealias.yml @@ -7,4 +7,4 @@ summary: Supported thumbnail image types. remarks: '' isPreview: true isDeprecated: false -syntax: 'export type ThumbnailType = typeof ThumbnailType[keyof typeof ThumbnailType];' +syntax: export type ThumbnailType = (typeof ThumbnailType)[keyof typeof ThumbnailType]; diff --git a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml index 3e33e73a..03062331 100644 --- a/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml +++ b/SP-Framework/sp-search-extensibility/basesearchquerymodifier.yml @@ -28,7 +28,7 @@ properties: syntax: content: 'protected readonly context: SearchQueryModifierContext;' return: - type: '' + type: - name: timeout uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#timeout:member' package: '@microsoft/sp-search-extensibility!' @@ -46,10 +46,10 @@ properties: return: type: number methods: - - name: 'modifySearchQuery(query, scenario)' + - name: modifySearchQuery(query, scenario) uid: '@microsoft/sp-search-extensibility!BaseSearchQueryModifier#modifySearchQuery:member(1)' package: '@microsoft/sp-search-extensibility!' - fullName: 'modifySearchQuery(query, scenario)' + fullName: modifySearchQuery(query, scenario) summary: Returns a modified search query. remarks: '' isPreview: false @@ -61,11 +61,11 @@ methods: parameters: - id: query description: Query to modify. - type: '' + type: - id: scenario description: Search scenario. - type: '' + type: return: - type: 'Promise<>' + type: Promise<> description: Modified query. -extends: '<TProperties>' +extends: <TProperties> diff --git a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml index b7513fec..e6cfc982 100644 --- a/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml +++ b/SP-Framework/sp-search-extensibility/searchquerymodifiercontext.yml @@ -8,4 +8,4 @@ remarks: '' isPreview: false isDeprecated: false type: class -extends: '' +extends: diff --git a/SP-Framework/sp-top-actions.yml b/SP-Framework/sp-top-actions.yml index 9797800f..dc0aeb29 100644 --- a/SP-Framework/sp-top-actions.yml +++ b/SP-Framework/sp-top-actions.yml @@ -6,9 +6,15 @@ summary: '' interfaces: - '@microsoft/sp-top-actions!ITopActions:interface' - '@microsoft/sp-top-actions!ITopActionsButtonProps:interface' + - '@microsoft/sp-top-actions!ITopActionsButtonV2Props:interface' + - '@microsoft/sp-top-actions!ITopActionsComboboxProps:interface' - '@microsoft/sp-top-actions!ITopActionsDropdownOption:interface' - '@microsoft/sp-top-actions!ITopActionsDropdownOptionIconProps:interface' - '@microsoft/sp-top-actions!ITopActionsDropdownProps:interface' + - '@microsoft/sp-top-actions!ITopActionsDropdownV2Props:interface' - '@microsoft/sp-top-actions!ITopActionsField:interface' + - '@microsoft/sp-top-actions!ITopActionsFieldCommonProps:interface' + - '@microsoft/sp-top-actions!ITopActionsSplitProps:interface' + - '@microsoft/sp-top-actions!ITopActionsToggleProps:interface' enums: - '@microsoft/sp-top-actions!TopActionsFieldType:enum' diff --git a/SP-Framework/sp-top-actions/itopactions.yml b/SP-Framework/sp-top-actions/itopactions.yml index b0cc1328..6cf766d3 100644 --- a/SP-Framework/sp-top-actions/itopactions.yml +++ b/SP-Framework/sp-top-actions/itopactions.yml @@ -20,12 +20,12 @@ properties: syntax: content: 'readonly topActions: ITopActionsField[];' return: - type: '[]' + type: [] methods: - - name: 'onExecute(actionName, updatedValue)' + - name: onExecute(actionName, updatedValue) uid: '@microsoft/sp-top-actions!ITopActions#onExecute:member(1)' package: '@microsoft/sp-top-actions!' - fullName: 'onExecute(actionName, updatedValue)' + fullName: onExecute(actionName, updatedValue) summary: Triggered once the top action configuration state has been executed for the specified property path remarks: '' isPreview: false diff --git a/SP-Framework/sp-top-actions/itopactionsbuttonv2props.yml b/SP-Framework/sp-top-actions/itopactionsbuttonv2props.yml new file mode 100644 index 00000000..560b80c2 --- /dev/null +++ b/SP-Framework/sp-top-actions/itopactionsbuttonv2props.yml @@ -0,0 +1,11 @@ +### YamlMime:TSType +name: ITopActionsButtonV2Props +uid: '@microsoft/sp-top-actions!ITopActionsButtonV2Props:interface' +package: '@microsoft/sp-top-actions!' +fullName: ITopActionsButtonV2Props +summary: TopActions basic button props. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +extends: Pick<, 'icon' | 'onClick'> diff --git a/SP-Framework/sp-top-actions/itopactionscomboboxprops.yml b/SP-Framework/sp-top-actions/itopactionscomboboxprops.yml new file mode 100644 index 00000000..5665ef05 --- /dev/null +++ b/SP-Framework/sp-top-actions/itopactionscomboboxprops.yml @@ -0,0 +1,13 @@ +### YamlMime:TSType +name: ITopActionsComboboxProps +uid: '@microsoft/sp-top-actions!ITopActionsComboboxProps:interface' +package: '@microsoft/sp-top-actions!' +fullName: ITopActionsComboboxProps +summary: TopActions combobox props. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +extends: >- + Pick<, 'icon' | 'freeform' | 'currentOption' + | 'options' | 'onChange' | 'type'> diff --git a/SP-Framework/sp-top-actions/itopactionsdropdownoption.yml b/SP-Framework/sp-top-actions/itopactionsdropdownoption.yml index 61dbf144..fe5ddc71 100644 --- a/SP-Framework/sp-top-actions/itopactionsdropdownoption.yml +++ b/SP-Framework/sp-top-actions/itopactionsdropdownoption.yml @@ -71,7 +71,7 @@ properties: syntax: content: 'readonly iconProps?: ITopActionsDropdownOptionIconProps;' return: - type: '' + type: - name: imageSize uid: '@microsoft/sp-top-actions!ITopActionsDropdownOption#imageSize:member' package: '@microsoft/sp-top-actions!' diff --git a/SP-Framework/sp-top-actions/itopactionsdropdownprops.yml b/SP-Framework/sp-top-actions/itopactionsdropdownprops.yml index d0e452d7..23eedfa4 100644 --- a/SP-Framework/sp-top-actions/itopactionsdropdownprops.yml +++ b/SP-Framework/sp-top-actions/itopactionsdropdownprops.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'readonly options: ITopActionsDropdownOption[];' return: - type: '[]' + type: [] - name: titleButton uid: '@microsoft/sp-top-actions!ITopActionsDropdownProps#titleButton:member' package: '@microsoft/sp-top-actions!' @@ -35,4 +35,4 @@ properties: syntax: content: 'readonly titleButton?: ITopActionsButtonProps;' return: - type: '' + type: diff --git a/SP-Framework/sp-top-actions/itopactionsdropdownv2props.yml b/SP-Framework/sp-top-actions/itopactionsdropdownv2props.yml new file mode 100644 index 00000000..5e68032c --- /dev/null +++ b/SP-Framework/sp-top-actions/itopactionsdropdownv2props.yml @@ -0,0 +1,13 @@ +### YamlMime:TSType +name: ITopActionsDropdownV2Props +uid: '@microsoft/sp-top-actions!ITopActionsDropdownV2Props:interface' +package: '@microsoft/sp-top-actions!' +fullName: ITopActionsDropdownV2Props +summary: TopActions dropdown props. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +extends: >- + Pick<, 'icon' | 'checkedValues' | 'onChange' + | 'popover'> diff --git a/SP-Framework/sp-top-actions/itopactionsfield.yml b/SP-Framework/sp-top-actions/itopactionsfield.yml index 6f1a23ed..8d08cc08 100644 --- a/SP-Framework/sp-top-actions/itopactionsfield.yml +++ b/SP-Framework/sp-top-actions/itopactionsfield.yml @@ -68,4 +68,4 @@ properties: syntax: content: 'readonly type: TopActionsFieldType;' return: - type: '' + type: diff --git a/SP-Framework/sp-top-actions/itopactionsfieldcommonprops.yml b/SP-Framework/sp-top-actions/itopactionsfieldcommonprops.yml new file mode 100644 index 00000000..75d92f15 --- /dev/null +++ b/SP-Framework/sp-top-actions/itopactionsfieldcommonprops.yml @@ -0,0 +1,13 @@ +### YamlMime:TSType +name: ITopActionsFieldCommonProps +uid: '@microsoft/sp-top-actions!ITopActionsFieldCommonProps:interface' +package: '@microsoft/sp-top-actions!' +fullName: ITopActionsFieldCommonProps +summary: Common props for all top actions fields (except legacy button and dropdown). +remarks: '' +isPreview: true +isDeprecated: false +type: interface +extends: >- + Pick<, 'id' | 'tooltip' | 'label' | + 'ariaLabel'> diff --git a/SP-Framework/sp-top-actions/itopactionssplitprops.yml b/SP-Framework/sp-top-actions/itopactionssplitprops.yml new file mode 100644 index 00000000..465a537e --- /dev/null +++ b/SP-Framework/sp-top-actions/itopactionssplitprops.yml @@ -0,0 +1,13 @@ +### YamlMime:TSType +name: ITopActionsSplitProps +uid: '@microsoft/sp-top-actions!ITopActionsSplitProps:interface' +package: '@microsoft/sp-top-actions!' +fullName: ITopActionsSplitProps +summary: TopActions split props. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +extends: >- + Pick<, 'icon' | 'iconFillColor' | 'onClick' | + 'secondaryButtonId' | 'secondaryButtonAriaLabel' | 'popover'> diff --git a/SP-Framework/sp-top-actions/itopactionstoggleprops.yml b/SP-Framework/sp-top-actions/itopactionstoggleprops.yml new file mode 100644 index 00000000..58d8e865 --- /dev/null +++ b/SP-Framework/sp-top-actions/itopactionstoggleprops.yml @@ -0,0 +1,26 @@ +### YamlMime:TSType +name: ITopActionsToggleProps +uid: '@microsoft/sp-top-actions!ITopActionsToggleProps:interface' +package: '@microsoft/sp-top-actions!' +fullName: ITopActionsToggleProps +summary: TopActions toggle props. +remarks: '' +isPreview: true +isDeprecated: false +type: interface +properties: + - name: checked + uid: '@microsoft/sp-top-actions!ITopActionsToggleProps#checked:member' + package: '@microsoft/sp-top-actions!' + fullName: checked + summary: Whether or not the toggle button is in an active state. + remarks: '' + isPreview: true + isDeprecated: false + syntax: + content: 'checked?: boolean;' + return: + type: boolean +extends: >- + Pick<, 'icon' | 'name' | 'onClick' | + 'secondaryContent'> diff --git a/SP-Framework/sp-top-actions/topactionsfieldtype.yml b/SP-Framework/sp-top-actions/topactionsfieldtype.yml index 1987ecfe..5996618a 100644 --- a/SP-Framework/sp-top-actions/topactionsfieldtype.yml +++ b/SP-Framework/sp-top-actions/topactionsfieldtype.yml @@ -16,8 +16,23 @@ fields: package: '@microsoft/sp-top-actions!' summary: Button field. value: '11' + - name: Combobox + uid: '@microsoft/sp-top-actions!TopActionsFieldType.Combobox:member' + package: '@microsoft/sp-top-actions!' + summary: Combobox field. + value: '101' - name: Dropdown uid: '@microsoft/sp-top-actions!TopActionsFieldType.Dropdown:member' package: '@microsoft/sp-top-actions!' summary: Choice Group field. value: '10' + - name: Split + uid: '@microsoft/sp-top-actions!TopActionsFieldType.Split:member' + package: '@microsoft/sp-top-actions!' + summary: Split field. + value: '100' + - name: Toggle + uid: '@microsoft/sp-top-actions!TopActionsFieldType.Toggle:member' + package: '@microsoft/sp-top-actions!' + summary: Toggle field. + value: '5' diff --git a/SP-Framework/sp-webpart-base.yml b/SP-Framework/sp-webpart-base.yml index 07caf27d..d009293f 100644 --- a/SP-Framework/sp-webpart-base.yml +++ b/SP-Framework/sp-webpart-base.yml @@ -57,7 +57,7 @@ interfaces: - '@microsoft/sp-webpart-base!IWebPartPropertiesMetadata:interface' - '@microsoft/sp-webpart-base!IWebPartPropertyMetadata:interface' functions: - - name: 'PropertyPaneButton(targetProperty, properties)' + - name: PropertyPaneButton(targetProperty, properties) uid: '@microsoft/sp-webpart-base!PropertyPaneButton:function(1)' package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Button on the PropertyPane. @@ -77,13 +77,13 @@ functions: type: string - id: properties description: Strongly typed Button properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneCheckbox(targetProperty, properties)' + - name: PropertyPaneCheckbox(targetProperty, properties) uid: '@microsoft/sp-webpart-base!PropertyPaneCheckbox:function(1)' package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Checkbox on the PropertyPane. @@ -103,13 +103,13 @@ functions: type: string - id: properties description: Strongly typed Checkbox properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneChoiceGroup(targetProperty, properties)' + - name: PropertyPaneChoiceGroup(targetProperty, properties) uid: '@microsoft/sp-webpart-base!PropertyPaneChoiceGroup:function(1)' package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Choice Group on the PropertyPane. @@ -129,7 +129,7 @@ functions: type: string - id: properties description: Strongly typed Choice Group properties. - type: '' + type: return: type: >- <' + type: return: type: >- <> description: '' - - name: 'PropertyPaneDropdown(targetProperty, properties)' + - name: PropertyPaneDropdown(targetProperty, properties) uid: '@microsoft/sp-webpart-base!PropertyPaneDropdown:function(1)' package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dropdown on the PropertyPane. @@ -178,13 +178,13 @@ functions: type: string - id: properties description: Strongly typed Dropdown properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneDynamicField(targetProperty, properties)' + - name: PropertyPaneDynamicField(targetProperty, properties) uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicField:function(1)' package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dynamic Data widget on the PropertyPane for a dynamic field. @@ -204,7 +204,7 @@ functions: type: string - id: properties description: '' - type: '' + type: return: type: >- <' + type: return: type: >- <> description: '' - - name: 'PropertyPaneDynamicTextField(targetProperty, properties)' + - name: PropertyPaneDynamicTextField(targetProperty, properties) uid: '@microsoft/sp-webpart-base!PropertyPaneDynamicTextField:function(1)' package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Dynamic TextField on the PropertyPane. @@ -261,7 +261,7 @@ functions: type: string - id: properties description: Properties of the PropertyPaneDynamicTextField. - type: '' + type: return: type: >- <;' return: - type: '<void>' + type: <void> description: '' - - name: 'PropertyPaneLabel(targetProperty, properties)' + - name: PropertyPaneLabel(targetProperty, properties) uid: '@microsoft/sp-webpart-base!PropertyPaneLabel:function(1)' package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Label on the PropertyPane. @@ -302,13 +302,13 @@ functions: type: string - id: properties description: Strongly typed Label properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneLink(targetProperty, properties)' + - name: PropertyPaneLink(targetProperty, properties) uid: '@microsoft/sp-webpart-base!PropertyPaneLink:function(1)' package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Link on the PropertyPane. @@ -328,13 +328,13 @@ functions: type: string - id: properties description: Strongly typed Link properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneSlider(targetProperty, properties)' + - name: PropertyPaneSlider(targetProperty, properties) uid: '@microsoft/sp-webpart-base!PropertyPaneSlider:function(1)' package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Slider on the PropertyPane. @@ -354,13 +354,13 @@ functions: type: string - id: properties description: Strongly typed Slider properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneTextField(targetProperty, properties)' + - name: PropertyPaneTextField(targetProperty, properties) uid: '@microsoft/sp-webpart-base!PropertyPaneTextField:function(1)' package: '@microsoft/sp-webpart-base!' summary: Helper method to create a TextField on the PropertyPane. @@ -380,13 +380,13 @@ functions: type: string - id: properties description: Strongly typed TextField properties. - type: '' + type: return: type: >- <> description: '' - - name: 'PropertyPaneToggle(targetProperty, properties)' + - name: PropertyPaneToggle(targetProperty, properties) uid: '@microsoft/sp-webpart-base!PropertyPaneToggle:function(1)' package: '@microsoft/sp-webpart-base!' summary: Helper method to create a Toggle on the PropertyPane. @@ -406,7 +406,7 @@ functions: type: string - id: properties description: Strongly typed Toggle properties. - type: '' + type: return: type: >- <' + type: - name: domElement uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#domElement:member' package: '@microsoft/sp-webpart-base!' @@ -224,7 +224,7 @@ methods: parameters: - id: oldDisplayMode description: The old display mode. - type: '' + type: return: type: void description: '' @@ -264,7 +264,7 @@ methods: parameters: - id: theme description: New theme for the page or section - type: ' | undefined' + type: | undefined return: type: void description: '' @@ -283,10 +283,10 @@ methods: return: type: void description: '' - - name: 'renderCompleted(error, didUpdate)' + - name: renderCompleted(error, didUpdate) uid: '@microsoft/sp-webpart-base!BaseClientSideWebPart#renderCompleted:member(1)' package: '@microsoft/sp-webpart-base!' - fullName: 'renderCompleted(error, didUpdate)' + fullName: renderCompleted(error, didUpdate) 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 @@ -326,4 +326,4 @@ methods: return: type: void description: '' -extends: '<TProperties>' +extends: <TProperties> diff --git a/SP-Framework/sp-webpart-base/basewebpart.yml b/SP-Framework/sp-webpart-base/basewebpart.yml index a1b4b99b..37c545c9 100644 --- a/SP-Framework/sp-webpart-base/basewebpart.yml +++ b/SP-Framework/sp-webpart-base/basewebpart.yml @@ -54,7 +54,7 @@ properties: syntax: content: 'readonly context: BaseWebPartContext;' return: - type: '' + type: - name: dataVersion uid: '@microsoft/sp-webpart-base!BaseWebPart#dataVersion:member' package: '@microsoft/sp-webpart-base!' @@ -68,7 +68,7 @@ properties: syntax: content: 'protected get dataVersion(): Version;' return: - type: '' + type: - name: description uid: '@microsoft/sp-webpart-base!BaseWebPart#description:member' package: '@microsoft/sp-webpart-base!' @@ -114,7 +114,7 @@ properties: syntax: content: 'get displayMode(): DisplayMode;' return: - type: '' + type: - name: previewImageUrl uid: '@microsoft/sp-webpart-base!BaseWebPart#previewImageUrl:member' package: '@microsoft/sp-webpart-base!' @@ -157,7 +157,7 @@ properties: syntax: content: 'protected get propertiesMetadata(): IWebPartPropertiesMetadata | undefined;' return: - type: ' | undefined' + type: | undefined - name: title uid: '@microsoft/sp-webpart-base!BaseWebPart#title:member' package: '@microsoft/sp-webpart-base!' @@ -191,7 +191,7 @@ methods: syntax: content: 'protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;' return: - type: '' + type: description: '' - name: getTopActionsConfiguration() uid: '@microsoft/sp-webpart-base!BaseWebPart#getTopActionsConfiguration:member(1)' @@ -204,7 +204,7 @@ methods: syntax: content: 'getTopActionsConfiguration(): ITopActions | undefined;' return: - type: ' | undefined' + type: | undefined description: '' - name: loadPropertyPaneResources() uid: '@microsoft/sp-webpart-base!BaseWebPart#loadPropertyPaneResources:member(1)' @@ -231,10 +231,10 @@ methods: return: type: Promise<void> description: '' - - name: 'onAfterDeserialize(deserializedObject, dataVersion)' + - name: onAfterDeserialize(deserializedObject, dataVersion) uid: '@microsoft/sp-webpart-base!BaseWebPart#onAfterDeserialize:member(1)' package: '@microsoft/sp-webpart-base!' - fullName: 'onAfterDeserialize(deserializedObject, dataVersion)' + fullName: onAfterDeserialize(deserializedObject, dataVersion) summary: >- This API is called after the web part is deserialized to an object, right before the property bag is populated. virtual @@ -264,7 +264,7 @@ methods: 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: '' + type: return: type: TProperties description: The property bag of the web part @@ -322,7 +322,7 @@ methods: parameters: - id: oldDisplayMode description: The old display mode. - type: '' + type: return: type: void description: '' @@ -399,10 +399,10 @@ methods: return: type: void description: '' - - name: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + - name: onPropertyPaneFieldChanged(propertyPath, oldValue, newValue) uid: '@microsoft/sp-webpart-base!BaseWebPart#onPropertyPaneFieldChanged:member(1)' package: '@microsoft/sp-webpart-base!' - fullName: 'onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)' + fullName: onPropertyPaneFieldChanged(propertyPath, oldValue, newValue) summary: >- This API is invoked after updating the new value of the property in the property bag when the PropertyPane is being used in Reactive mode. virtual @@ -440,4 +440,4 @@ methods: return: type: void description: '' -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/basewebpartcontext.yml b/SP-Framework/sp-webpart-base/basewebpartcontext.yml index 2e9c4103..f1bafa98 100644 --- a/SP-Framework/sp-webpart-base/basewebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/basewebpartcontext.yml @@ -29,7 +29,7 @@ properties: syntax: content: 'get formFactor(): WebPartFormFactor;' return: - type: '' + type: - name: host uid: '@microsoft/sp-webpart-base!BaseWebPartContext#host:member' package: '@microsoft/sp-webpart-base!' @@ -41,7 +41,7 @@ properties: syntax: content: 'get host(): IWebPartHost;' return: - type: '' + type: - name: manifest uid: '@microsoft/sp-webpart-base!BaseWebPartContext#manifest:member' package: '@microsoft/sp-webpart-base!' @@ -53,7 +53,7 @@ properties: syntax: content: 'readonly manifest: IClientSideWebPartManifestInstance;' return: - type: '<any>' + type: <any> - name: propertyPane uid: '@microsoft/sp-webpart-base!BaseWebPartContext#propertyPane:member' package: '@microsoft/sp-webpart-base!' @@ -65,7 +65,7 @@ properties: syntax: content: 'get propertyPane(): IPropertyPaneAccessor;' return: - type: '' + type: - name: webPartTag uid: '@microsoft/sp-webpart-base!BaseWebPartContext#webPartTag:member' package: '@microsoft/sp-webpart-base!' @@ -78,4 +78,4 @@ properties: content: 'get webPartTag(): string;' return: type: string -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/iagentssdk.yml b/SP-Framework/sp-webpart-base/iagentssdk.yml index 8106a4e6..c49199d3 100644 --- a/SP-Framework/sp-webpart-base/iagentssdk.yml +++ b/SP-Framework/sp-webpart-base/iagentssdk.yml @@ -13,7 +13,7 @@ properties: uid: '@microsoft/sp-webpart-base!IAgentsSDK#openAgentInSidecar:member' package: '@microsoft/sp-webpart-base!' fullName: openAgentInSidecar - summary: '' + summary: Legacy API for backward compatibility remarks: '' isPreview: true isDeprecated: false diff --git a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml index 2e674be9..2e23d50f 100644 --- a/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml +++ b/SP-Framework/sp-webpart-base/iclientsidewebpartstatusrenderer.yml @@ -45,10 +45,10 @@ methods: return: type: void description: '' - - name: 'displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)' + - name: displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback) uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#displayLoadingIndicator:member(1)' package: '@microsoft/sp-webpart-base!' - fullName: 'displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback)' + fullName: displayLoadingIndicator(domElement, loadingMessage, timeout, clearDomElementCallback) summary: Display a loading spinner. remarks: '' isPreview: false @@ -71,14 +71,14 @@ methods: description: >- Callback to clear the dom node before rendering the indicator. Standard DOM API will be used after the callback. - type: '' + type: return: type: void description: '' - - name: 'renderError(domElement, error, clearDomElementCallback)' + - name: renderError(domElement, error, clearDomElementCallback) uid: '@microsoft/sp-webpart-base!IClientSideWebPartStatusRenderer#renderError:member(1)' package: '@microsoft/sp-webpart-base!' - fullName: 'renderError(domElement, error, clearDomElementCallback)' + fullName: renderError(domElement, error, clearDomElementCallback) summary: Render the provided error message in the webpart container div. remarks: '' isPreview: false @@ -98,7 +98,7 @@ methods: description: >- Callback to clear the dom node before rendering the error element. Standard DOM API will be used after the callback. - type: '' + type: return: type: void description: '' diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml index 2d293501..34158f35 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyconfiguration.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml index 3bf23c0b..895510af 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedpropertyfilters.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml index 0b5cebf7..61b056f0 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourceconfiguration.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml index eb423ff5..303bf45e 100644 --- a/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml +++ b/SP-Framework/sp-webpart-base/idynamicdatasharedsourcefilters.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/imicrosoftteams.yml b/SP-Framework/sp-webpart-base/imicrosoftteams.yml index 49e4b05a..ae2be563 100644 --- a/SP-Framework/sp-webpart-base/imicrosoftteams.yml +++ b/SP-Framework/sp-webpart-base/imicrosoftteams.yml @@ -23,7 +23,7 @@ properties: syntax: content: 'context: microsoftTeams.Context;' return: - type: '' + type: - name: teamsJs uid: '@microsoft/sp-webpart-base!IMicrosoftTeams#teamsJs:member' package: '@microsoft/sp-webpart-base!' diff --git a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml index 46364063..00587e10 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneaccessor.yml @@ -29,7 +29,7 @@ methods: package: '@microsoft/sp-webpart-base!' fullName: isContentPanelOpen() summary: Returns true if the ContentPanel is open. - remarks: 'Returns true if the Content Panel is open, regardless if the Content Panel is rendering the property pane.' + remarks: Returns true if the Content Panel is open, regardless if the Content Panel is rendering the property pane. isPreview: true isDeprecated: false syntax: @@ -106,7 +106,7 @@ methods: summary: >- This API should be used to open the Details PropertyPane/Content Panel 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.' + remarks: This API is mainly used for configuring Details, which is different from configuring the web part itself. isPreview: false isDeprecated: false syntax: diff --git a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml index 949840bf..84c4e813 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanebuttonprops.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml index eba48722..256c6e56 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecheckboxprops.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml index 94f4aea1..b5580330 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoption.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml index 46306640..d53ca0b7 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupoptioniconprops.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml index 5a5401b3..d69b1d2c 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanechoicegroupprops.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml index 728b41b2..e763d162 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconditionalgroup.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml index 9b5138a9..7ba1b6bb 100644 --- a/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml +++ b/SP-Framework/sp-webpart-base/ipropertypaneconfiguration.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml index f905ceb9..7354c2be 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanecustomfieldprops.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml index 6259fe66..4b51917e 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdowncalloutprops.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml index fe1e9711..c6e49260 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownoption.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml index 5d671c4f..7e38b8a5 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedropdownprops.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml index 6857c79b..69f9e4b5 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldfilters.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml index 8baaf20c..1d4d5235 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldprops.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml index b4a6c2e5..ea35b2cc 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamicfieldsetprops.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml index aac68c1e..e4783847 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanedynamictextfieldprops.yml @@ -9,4 +9,4 @@ isPreview: true isDeprecated: true customDeprecatedMessage: '- This has been replaced by IPropertyPaneDynamicFieldProps' type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanefield.yml b/SP-Framework/sp-webpart-base/ipropertypanefield.yml index a0c1cef4..ce958074 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanefield.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanefield.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '<TProperties>' +extends: <TProperties> diff --git a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml index 39fac75e..a492f273 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanegroup.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanegroup.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml index be87590f..83551b34 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelabelprops.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanelifecycleeventdata.yml b/SP-Framework/sp-webpart-base/ipropertypanelifecycleeventdata.yml index 3399f3cd..6e27b2a4 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelifecycleeventdata.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelifecycleeventdata.yml @@ -32,4 +32,4 @@ properties: syntax: content: 'webPartData: IWebPartData;' return: - type: '' + type: diff --git a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml index c6253895..3dabf418 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanelinkprops.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanepage.yml b/SP-Framework/sp-webpart-base/ipropertypanepage.yml index ad5d7e45..420f3051 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepage.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepage.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml index 4a1ff335..b74b2896 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanepageheader.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml index c58d06e4..236d8a05 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanesliderprops.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml index bc853f0c..50389ea5 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetextfieldprops.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml index 66014ec9..1ab98546 100644 --- a/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml +++ b/SP-Framework/sp-webpart-base/ipropertypanetoggleprops.yml @@ -11,4 +11,4 @@ customDeprecatedMessage: >- This is obsolete now. This interface has been moved to `@microsoft/sp-property-pane`. Please consume it from there. type: interface -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/isdks.yml b/SP-Framework/sp-webpart-base/isdks.yml index 489319d8..d40de0c6 100644 --- a/SP-Framework/sp-webpart-base/isdks.yml +++ b/SP-Framework/sp-webpart-base/isdks.yml @@ -20,7 +20,7 @@ properties: syntax: content: 'agents?: IAgentsSDK;' return: - type: '' + type: - name: microsoftTeams uid: '@microsoft/sp-webpart-base!ISDKs#microsoftTeams:member' package: '@microsoft/sp-webpart-base!' @@ -36,4 +36,4 @@ properties: syntax: content: 'microsoftTeams?: IMicrosoftTeams;' return: - type: '' + type: diff --git a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml index f64fde7d..a3eb6fec 100644 --- a/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iserializedwebpartdata.yml @@ -31,7 +31,7 @@ properties: syntax: content: 'dataVersion: Version;' return: - type: '' + type: - name: dynamicDataPaths uid: '@microsoft/sp-webpart-base!ISerializedWebPartData#dynamicDataPaths:member' package: '@microsoft/sp-webpart-base!' @@ -48,8 +48,6 @@ properties: 'PageContext:user', 'anotherWebPartProperty': 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' - } - ``` isPreview: true isDeprecated: false syntax: @@ -78,8 +76,6 @@ properties: { 'aStringProperty': 'thisIsAString', 'aBooleanProperty': true - } - ``` isPreview: true isDeprecated: false syntax: @@ -123,4 +119,4 @@ properties: syntax: content: 'serverProcessedContent?: ISerializedServerProcessedData;' return: - type: '' + type: diff --git a/SP-Framework/sp-webpart-base/iwebpartcontext.yml b/SP-Framework/sp-webpart-base/iwebpartcontext.yml index becde01a..87861352 100644 --- a/SP-Framework/sp-webpart-base/iwebpartcontext.yml +++ b/SP-Framework/sp-webpart-base/iwebpartcontext.yml @@ -38,7 +38,7 @@ properties: syntax: content: 'readonly host: IWebPartHost;' return: - type: '' + type: - name: httpClient uid: '@microsoft/sp-webpart-base!IWebPartContext#httpClient:member' package: '@microsoft/sp-webpart-base!' @@ -50,7 +50,7 @@ properties: syntax: content: 'readonly httpClient: HttpClient;' return: - type: '' + type: - name: instanceId uid: '@microsoft/sp-webpart-base!IWebPartContext#instanceId:member' package: '@microsoft/sp-webpart-base!' @@ -74,7 +74,7 @@ properties: syntax: content: 'readonly manifest: IClientSideWebPartManifestInstance;' return: - type: '<any>' + type: <any> - name: pageContext uid: '@microsoft/sp-webpart-base!IWebPartContext#pageContext:member' package: '@microsoft/sp-webpart-base!' @@ -86,7 +86,7 @@ properties: syntax: content: 'readonly pageContext: PageContext;' return: - type: '' + type: - name: propertyPane uid: '@microsoft/sp-webpart-base!IWebPartContext#propertyPane:member' package: '@microsoft/sp-webpart-base!' @@ -98,7 +98,7 @@ properties: syntax: content: 'readonly propertyPane: IPropertyPaneAccessor;' return: - type: '' + type: - name: spHttpClient uid: '@microsoft/sp-webpart-base!IWebPartContext#spHttpClient:member' package: '@microsoft/sp-webpart-base!' @@ -110,7 +110,7 @@ properties: syntax: content: 'readonly spHttpClient: SPHttpClient;' return: - type: '' + type: - name: statusRenderer uid: '@microsoft/sp-webpart-base!IWebPartContext#statusRenderer:member' package: '@microsoft/sp-webpart-base!' @@ -122,7 +122,7 @@ properties: syntax: content: 'readonly statusRenderer: IClientSideWebPartStatusRenderer;' return: - type: '' + type: - name: webPartTag uid: '@microsoft/sp-webpart-base!IWebPartContext#webPartTag:member' package: '@microsoft/sp-webpart-base!' diff --git a/SP-Framework/sp-webpart-base/iwebpartdata.yml b/SP-Framework/sp-webpart-base/iwebpartdata.yml index 800c45cb..f5339f48 100644 --- a/SP-Framework/sp-webpart-base/iwebpartdata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartdata.yml @@ -70,9 +70,6 @@ properties: 'PageContext:user', 'anotherWebPartProperty': 'WebPart.c3be45f2-7cd9-4e92-9c6c-a01d24dc04cf.3d6307e4-c8e1-4b2d-bef9-f1689c6eb7ea:aProperty' - } - - ``` isPreview: true isDeprecated: false syntax: @@ -101,8 +98,6 @@ properties: { 'aStringProperty': 'thisIsAString', 'aBooleanProperty': true - } - ``` isPreview: true isDeprecated: false syntax: @@ -155,7 +150,7 @@ properties: syntax: content: 'isolationLevel?: WebPartIsolationLevel;' return: - type: '' + type: - name: properties uid: '@microsoft/sp-webpart-base!IWebPartData#properties:member' package: '@microsoft/sp-webpart-base!' @@ -187,7 +182,7 @@ properties: syntax: content: 'serverProcessedContent?: ISerializedServerProcessedData;' return: - type: '' + type: - name: title uid: '@microsoft/sp-webpart-base!IWebPartData#title:member' package: '@microsoft/sp-webpart-base!' diff --git a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml index 3bf6ad55..c68a6c70 100644 --- a/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml +++ b/SP-Framework/sp-webpart-base/iwebpartpropertymetadata.yml @@ -13,7 +13,7 @@ properties: uid: '@microsoft/sp-webpart-base!IWebPartPropertyMetadata#dynamicPropertyType:member' package: '@microsoft/sp-webpart-base!' fullName: dynamicPropertyType - summary: 'If specified, indicates that the property is a dynamic property and the type of the dynamic property.' + summary: If specified, indicates that the property is a dynamic property and the type of the dynamic property. remarks: >- If a web part has properties that are dynamically configurable, then use this flag to declare the property as a dynamic property by specifying its type. When a property specifies its dynamic property type, then the framework @@ -34,4 +34,4 @@ properties: content: 'dynamicPropertyType?: ''boolean'' | ''number'' | ''string'' | ''array'' | ''object'';' return: type: '''boolean'' | ''number'' | ''string'' | ''array'' | ''object''' -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/webpartcontext.yml b/SP-Framework/sp-webpart-base/webpartcontext.yml index f09d19f8..cd12912a 100644 --- a/SP-Framework/sp-webpart-base/webpartcontext.yml +++ b/SP-Framework/sp-webpart-base/webpartcontext.yml @@ -53,7 +53,7 @@ properties: syntax: content: 'get sdks(): ISDKs;' return: - type: '' + type: - name: statusRenderer uid: '@microsoft/sp-webpart-base!WebPartContext#statusRenderer:member' package: '@microsoft/sp-webpart-base!' @@ -65,7 +65,7 @@ properties: syntax: content: 'get statusRenderer(): IClientSideWebPartStatusRenderer;' return: - type: '' + type: - name: widthCacheKey uid: '@microsoft/sp-webpart-base!WebPartContext#widthCacheKey:member' package: '@microsoft/sp-webpart-base!' @@ -80,4 +80,4 @@ properties: content: 'get widthCacheKey(): string | undefined;' return: type: string | undefined -extends: '' +extends: diff --git a/SP-Framework/sp-webpart-base/webpartformfactor.yml b/SP-Framework/sp-webpart-base/webpartformfactor.yml index 41194112..2adda0a3 100644 --- a/SP-Framework/sp-webpart-base/webpartformfactor.yml +++ b/SP-Framework/sp-webpart-base/webpartformfactor.yml @@ -14,7 +14,7 @@ fields: - name: FullSize uid: '@microsoft/sp-webpart-base!WebPartFormFactor.FullSize:member' package: '@microsoft/sp-webpart-base!' - summary: 'Full size form factor. This means the web part is rendered in full size, taking all space available in the page.' + summary: Full size form factor. This means the web part is rendered in full size, taking all space available in the page. value: '1' - name: FullWidth uid: '@microsoft/sp-webpart-base!WebPartFormFactor.FullWidth:member' diff --git a/SP-Framework/toc.yml b/SP-Framework/toc.yml index 17e82427..1b670705 100644 --- a/SP-Framework/toc.yml +++ b/SP-Framework/toc.yml @@ -506,6 +506,8 @@ items: uid: '@microsoft/sp-http-base!AadTokenProvider:class' - name: AadTokenProviderFactory uid: '@microsoft/sp-http-base!AadTokenProviderFactory:class' + - name: BeforeFullPageRedirectEventArgs + uid: '@microsoft/sp-http-base!BeforeFullPageRedirectEventArgs:class' - name: BeforeRedirectEventArgs uid: '@microsoft/sp-http-base!BeforeRedirectEventArgs:class' - name: DigestCache @@ -566,6 +568,8 @@ items: uid: '@microsoft/sp-http-base!ODataVersion:class' - name: PopupEventArgs uid: '@microsoft/sp-http-base!PopupEventArgs:class' + - name: PopupRequestEventArgs + uid: '@microsoft/sp-http-base!PopupRequestEventArgs:class' - name: SPHttpClient uid: '@microsoft/sp-http-base!SPHttpClient:class' - name: SPHttpClientBatch @@ -693,6 +697,8 @@ items: uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifest:interface' - name: IAdaptiveCardExtensionManifestEntry uid: '@microsoft/sp-module-interfaces!IAdaptiveCardExtensionManifestEntry:interface' + - name: IAIProperties + uid: '@microsoft/sp-module-interfaces!IAIProperties:interface' - name: ICapabilityCollection uid: '@microsoft/sp-module-interfaces!ICapabilityCollection:interface' - name: IClientSideApplicationManifest @@ -948,14 +954,26 @@ items: uid: '@microsoft/sp-top-actions!ITopActions:interface' - name: ITopActionsButtonProps uid: '@microsoft/sp-top-actions!ITopActionsButtonProps:interface' + - name: ITopActionsButtonV2Props + uid: '@microsoft/sp-top-actions!ITopActionsButtonV2Props:interface' + - name: ITopActionsComboboxProps + uid: '@microsoft/sp-top-actions!ITopActionsComboboxProps:interface' - name: ITopActionsDropdownOption uid: '@microsoft/sp-top-actions!ITopActionsDropdownOption:interface' - name: ITopActionsDropdownOptionIconProps uid: '@microsoft/sp-top-actions!ITopActionsDropdownOptionIconProps:interface' - name: ITopActionsDropdownProps uid: '@microsoft/sp-top-actions!ITopActionsDropdownProps:interface' + - name: ITopActionsDropdownV2Props + uid: '@microsoft/sp-top-actions!ITopActionsDropdownV2Props:interface' - name: ITopActionsField uid: '@microsoft/sp-top-actions!ITopActionsField:interface' + - name: ITopActionsFieldCommonProps + uid: '@microsoft/sp-top-actions!ITopActionsFieldCommonProps:interface' + - name: ITopActionsSplitProps + uid: '@microsoft/sp-top-actions!ITopActionsSplitProps:interface' + - name: ITopActionsToggleProps + uid: '@microsoft/sp-top-actions!ITopActionsToggleProps:interface' - name: TopActionsFieldType uid: '@microsoft/sp-top-actions!TopActionsFieldType:enum' - name: sp-webpart-base