Docs & rules

pnp/pnpcoreGitHub

This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works

dev551d959Last read Oct 3

Is this yours? Install to manage it

Once installed, Striff checks every pull request.

Rules summary
Documents
Rules
67
67
67
10
1
2
21
13
1
3
1
4
1
1
9
25 docs
pnp/pnpcoreOpen repository

pnp/pnpcore — documented rules

67 of 67 rules, printed November 22, 2026.

The sentence in your docs
Tenant and site collection app managers provide some common app operations like GetAvailable, Add, Deploy, Install, etc. These operations are available for both tenant and site collection app managers and are listed below.
4 rules from this sentence
AppManager has a GetAvailable method
HoldsPR #1819 · Oct 2
AppManager has an Add method
HoldsPR #1819 · Oct 2
AppManager has a Deploy method
HoldsPR #1819 · Oct 2
AppManager has an Install method
HoldsPR #1819 · Oct 2
To upgrade the app on the specific site you need to call the Upgrade method:
AppManager has an Upgrade method
Holds
To uninstall the app from the specific site you need to call the Uninstall method:
AppManager has an Uninstall method
Holds
If you don't want your app to be available for sites, you should call Retract.
AppManager has Retract
Holds
To completely remove the app from the app catalog you should call the Remove method:
AppManager has a Remove method
Holds
The Enable2 and Disable2 operations can be found on the ServicePrincipal object:
2 rules from this sentence
ServicePrincipal has an Enable2 method
Holds
ServicePrincipal has a Disable2 method
Holds
in this case this is a PnPContext which was obtained via the PnPContextFactory as explained in the overview article and show below:
PnPContextFactory depends on PnPContext
Holds
in this case this is a PnPContext which was obtained via the PnPContextFactory as explained in the overview article and show below:
PnPContextFactory depends on PnPContext
Holds
calling GetChanges on an IList will only return changes for that particular list.
IList has GetChanges
Holds
See the EnableVersioning and EnableMinorVersions properties on the IList interface.
IList has EnableVersioning
HoldsPR #1819 · Oct 2
In PnP Core SDK files are represented via an IFile interface.
IFile is a contract
Holds
If you have an IListItem you can load the connected file via File property:
IListItem has File
Holds
You can read this property bag, provided via the IFile Properties property, and add new key/value pairs to it.
IFile has Properties
Holds
To rename a file you can either use the Rename methods or use the MoveTo methods.
2 rules from this sentence
IFile has a Rename method
Holds
IFile has a MoveTo method
Holds
IList has ForceCheckout
HoldsPR #1819 · Oct 2
Deleting a file is done using the typical Delete methods like DeleteAsync, recycling is done via RecycleAsync.
2 rules from this sentence
IFile has a RecycleAsync method
HoldsPR #1819 · Oct 2
IFile has a DeleteAsync method
Holds
Each file has an Author property (the one who created the file), an Editor property (the one who last changed the file), a Created property (when was the file added) and a Modified property (when was the file changed).
IFile has Author
Holds
[!Note] > You can also opt for an asynchronous bulk file/folder copy/move via the CreateCopyJobs methods on ISite.
ISite has a CreateCopyJobs method
HoldsPR #1819 · Oct 2
Some files can be transformed into another format by calling one of the ConvertTo methods.
IFile has a ConvertTo method
Holds
[!Note] > Loading the VroomDriveID and VroomItemID when you load the file to convert optimizes performance, these properties will be fetched if not present.
2 rules from this sentence
IFile has VroomDriveID
Holds
IFile has VroomItemID
Holds
Once you've an IFileVersion you can also download that specific version of the file by using one of the GetContent methods as shown in the example.
IFileVersion has a GetContent method
Holds
Loading file versions can be done by requesting the Versions property of the file.
IFile has Versions
Holds
See the EnableVersioning and EnableMinorVersions properties on the IList interface.
IList has EnableMinorVersions
Holds
Using one of the GetAnalytics methods on IFile gives you back the file analytics for all time, the last seven days or for a custom interval of your choice.
IFile has a GetAnalytics method
HoldsPR #1819 · Oct 2
Using on of the GetPreview methods allows you to obtain a short-lived embeddable URL for a file in order to render a temporary preview.
IFile has a GetPreview method
Holds
Use the InformationRightsManagementSettings property to read the file's IRM settings.
IFile has InformationRightsManagementSettings
Holds
[!Note] > The library holding files you want to protect need to be first setup for IRM by enabling IRM on it via the IrmEnabled property.
IList has IrmEnabled
HoldsPR #1819 · Oct 2
The LoadItemsByCamlQueryViaCsom methods run the same CAML query through the CSOM List.GetItems(CamlQuery) method instead, which does return them.
IList has a LoadItemsByCamlQueryViaCsom method
Holds
Projected fields are returned as an IFieldLookupValue, where LookupValue holds the value coming from the joined list.
IFieldLookupValue has LookupValue
Holds
Add a RowLimit with Paged='TRUE' to the CAML query and the returned PagingInfo tells you how to request the next page.
CamlQueryOptions has PagingInfo
Holds
When you add list items you quite often need to add multiple items and the best way to do that is using the Batch methods (e.g. AddBatchAsync), the lesser server roundtrips the faster your code will be.
IListItemCollection has an AddBatchAsync method
Holds
Updating a list item comes down to updating the field values followed by calling an IListItem Update method such as UpdateAsync.
IListItem has an UpdateAsync method
Holds
SystemUpdate, SystemUpdateAsync | Updates the item without creating a new version and without updating the modified and editor list item fields UpdateOverWriteVersion, UpdateOverWriteVersionAsync | Updates the item without creating a new version and the modified and editor list item fields will be updated
2 rules from this sentence
IListItem has SystemUpdate
Holds
IListItem has SystemUpdateAsync
Holds
Once that's done use one of the AddListFolder methods to add a folder.
IList has an AddListFolder method
Holds
You can move a list item to another folder inside it's list using one of the MoveTo methods:
IListItem has a MoveTo method
Holds
You can use the GetChanges methods on an IListItem to list all the changes.
IListItem has a GetChanges method
Holds
If you want to enumerate these versions you need to first load the Versions property:
IListItem has Versions
Holds
If you have an IListItem you can load the connected file via File property:
IListItem has File
Holds
To access that file version you need to load the FileVersion property on the IListItemVersion instance.
IListItemVersion has FileVersion
Holds
Left alone they point at the sites the template came from, so set them in ApplyConfiguration.Parameters to apply the template as a copy.
ApplyConfiguration has Parameters
Holds
Once that's done you can obtain a PnPContext from the PnPContextFactory and start using the library.
PnPContextFactory depends on PnPContext
Holds
For more fine grained control over the setup of the internally used SharePointRestClient and MicrosoftGraphClient used in PnPContext, there are optional actions to enable configuring the IHttpClientBuilder of each in the AddPnPCore extension method.
2 rules from this sentence
PnPContext depends on SharePointRestClient
Holds
PnPContext depends on MicrosoftGraphClient
Holds
Note that to share the contents of a complete library you can use the IList.RootFolder property as sharing target
IList has RootFolder
Holds
To verify if a site is a Syntex Content Center site you can use the IsSyntexContentCenterAsync method on your web.
IWeb has an IsSyntexContentCenterAsync method
Holds
When you want to work with a SharePoint Syntex Content Center site you need to first load it, this can be done using the AsSyntexContentCenterAsync method:
IWeb has an AsSyntexContentCenterAsync method
Holds
If you want to know to which libraries a Syntex model was deployed then you can use the GetModelPublicationsAsync method to get a list of libraries to which the model was published.
ISyntexModel has a GetModelPublicationsAsync method
Holds
Previous chapter showed how you can trigger this for a single file, but you can also classify and extract all files in a library using the ClassifyAndExtractAsync method on the IList.
IList has a ClassifyAndExtractAsync method
Holds
Events is a collection part of the ITeam interface, so when you get a team, you can include the events on the request.
ITeam has Events
Holds
To unfurl a received link you simply call one of the UnfurlLink methods on IWeb and you'll get back a populated IUnfurledResource instance:
IWeb has an UnfurlLink method
HoldsPR #1819 · Oct 2
To verify if the site collection you're using is a home site you can use one of the IsHomeSite methods on ISite:
ISite has an IsHomeSite method
Holds
To read the Microsoft Viva Connections dashboard you will need to use one of the GetVivaDashboard methods on IWeb:
IWeb has a GetVivaDashboard method
Holds
Once the ACE has been created and configured it can be added to the dashboard via an AddACE method and finally the dashboard changes are persisted via one of the Save methods.
2 rules from this sentence
IVivaDashboard has an AddACE method
Holds
IVivaDashboard has a Save method
Holds
To add an ACE to the dashboard you first need to instantiate an AdaptiveCardExtension or a class inheriting from that one (e.g. CardDesignerACE, AssignedTasksACE or TeamsACE).
3 rules from this sentence
CardDesignerACE extends AdaptiveCardExtension
Holds
AssignedTasksACE extends AdaptiveCardExtension
Holds
TeamsACE extends AdaptiveCardExtension
Holds
To remove an ACE from a dashboard simply use the RemoveACE method providing the ACE instance id as key and then save the dashboard again.
IVivaDashboard has a RemoveACE method
Holds
You can also update existing ACEs by using the UpdateACE method followed by saving the dashboard changes again.
IVivaDashboard has an UpdateACE method
Holds
67 rules from 12 docs

More open-source reports

Every report →

Other public repositories whose docs Striff read and checked against their code.