diff --git a/api/Microsoft.Extensions.DependencyInjection.AuthenticationCollectionExtensions.html b/api/Microsoft.Extensions.DependencyInjection.AuthenticationCollectionExtensions.html index 481bbd97bd..d5533e84fe 100644 --- a/api/Microsoft.Extensions.DependencyInjection.AuthenticationCollectionExtensions.html +++ b/api/Microsoft.Extensions.DependencyInjection.AuthenticationCollectionExtensions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AuthenticationCollectionExtensions
diff --git a/api/Microsoft.Extensions.DependencyInjection.PnPCoreServiceCollectionExtensions.html b/api/Microsoft.Extensions.DependencyInjection.PnPCoreServiceCollectionExtensions.html index 201bf7cf76..257a48aedd 100644 --- a/api/Microsoft.Extensions.DependencyInjection.PnPCoreServiceCollectionExtensions.html +++ b/api/Microsoft.Extensions.DependencyInjection.PnPCoreServiceCollectionExtensions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreServiceCollectionExtensions
diff --git a/api/PnP.Core.Admin.Model.Microsoft365.CreationOptions.html b/api/PnP.Core.Admin.Model.Microsoft365.CreationOptions.html index 8eeec2d34e..66458ee384 100644 --- a/api/PnP.Core.Admin.Model.Microsoft365.CreationOptions.html +++ b/api/PnP.Core.Admin.Model.Microsoft365.CreationOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CreationOptions
diff --git a/api/PnP.Core.Admin.Model.Microsoft365.GraphGroupOptions.html b/api/PnP.Core.Admin.Model.Microsoft365.GraphGroupOptions.html index 42dd7770b2..3ab390956c 100644 --- a/api/PnP.Core.Admin.Model.Microsoft365.GraphGroupOptions.html +++ b/api/PnP.Core.Admin.Model.Microsoft365.GraphGroupOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
GraphGroupOptions
diff --git a/api/PnP.Core.Admin.Model.SharePoint.ClassicSiteOptions.html b/api/PnP.Core.Admin.Model.SharePoint.ClassicSiteOptions.html index cf1e3d2f83..7ba2519b65 100644 --- a/api/PnP.Core.Admin.Model.SharePoint.ClassicSiteOptions.html +++ b/api/PnP.Core.Admin.Model.SharePoint.ClassicSiteOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonSiteOptions
ClassicSiteOptions
diff --git a/api/PnP.Core.Admin.Model.SharePoint.CommonGroupSiteOptions.html b/api/PnP.Core.Admin.Model.SharePoint.CommonGroupSiteOptions.html index 8369294c32..f9fb11d023 100644 --- a/api/PnP.Core.Admin.Model.SharePoint.CommonGroupSiteOptions.html +++ b/api/PnP.Core.Admin.Model.SharePoint.CommonGroupSiteOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonSiteOptions
CommonGroupSiteOptions
diff --git a/api/PnP.Core.Admin.Model.SharePoint.CommonNoGroupSiteOptions.html b/api/PnP.Core.Admin.Model.SharePoint.CommonNoGroupSiteOptions.html index c2b9220b7b..f47ff8df07 100644 --- a/api/PnP.Core.Admin.Model.SharePoint.CommonNoGroupSiteOptions.html +++ b/api/PnP.Core.Admin.Model.SharePoint.CommonNoGroupSiteOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonSiteOptions
CommonNoGroupSiteOptions
diff --git a/api/PnP.Core.Admin.Model.SharePoint.CommonSiteOptions.html b/api/PnP.Core.Admin.Model.SharePoint.CommonSiteOptions.html index d8b0fbe38c..fe07c2acf3 100644 --- a/api/PnP.Core.Admin.Model.SharePoint.CommonSiteOptions.html +++ b/api/PnP.Core.Admin.Model.SharePoint.CommonSiteOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonSiteOptions
diff --git a/api/PnP.Core.Admin.Model.SharePoint.CommunicationSiteOptions.html b/api/PnP.Core.Admin.Model.SharePoint.CommunicationSiteOptions.html index 133edc463a..db0a0ceaee 100644 --- a/api/PnP.Core.Admin.Model.SharePoint.CommunicationSiteOptions.html +++ b/api/PnP.Core.Admin.Model.SharePoint.CommunicationSiteOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonSiteOptions
CommonNoGroupSiteOptions
CommunicationSiteOptions
diff --git a/api/PnP.Core.Admin.Model.SharePoint.ConnectSiteToGroupOptions.html b/api/PnP.Core.Admin.Model.SharePoint.ConnectSiteToGroupOptions.html index d4ccdfc8f7..5fd01abbbf 100644 --- a/api/PnP.Core.Admin.Model.SharePoint.ConnectSiteToGroupOptions.html +++ b/api/PnP.Core.Admin.Model.SharePoint.ConnectSiteToGroupOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonSiteOptions
CommonGroupSiteOptions
ConnectSiteToGroupOptions
diff --git a/api/PnP.Core.Admin.Model.SharePoint.CreationOptions.html b/api/PnP.Core.Admin.Model.SharePoint.CreationOptions.html index ddd755eecc..083c7b115c 100644 --- a/api/PnP.Core.Admin.Model.SharePoint.CreationOptions.html +++ b/api/PnP.Core.Admin.Model.SharePoint.CreationOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CreationOptions
diff --git a/api/PnP.Core.Admin.Model.SharePoint.SiteCreationOptions.html b/api/PnP.Core.Admin.Model.SharePoint.SiteCreationOptions.html index 16321410fa..b099c35ec9 100644 --- a/api/PnP.Core.Admin.Model.SharePoint.SiteCreationOptions.html +++ b/api/PnP.Core.Admin.Model.SharePoint.SiteCreationOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CreationOptions
SiteCreationOptions
diff --git a/api/PnP.Core.Admin.Model.SharePoint.TeamSiteOptions.html b/api/PnP.Core.Admin.Model.SharePoint.TeamSiteOptions.html index 1cb22123bd..61b6899901 100644 --- a/api/PnP.Core.Admin.Model.SharePoint.TeamSiteOptions.html +++ b/api/PnP.Core.Admin.Model.SharePoint.TeamSiteOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonSiteOptions
CommonGroupSiteOptions
TeamSiteOptions
diff --git a/api/PnP.Core.Admin.Model.SharePoint.TeamSiteWithoutGroupOptions.html b/api/PnP.Core.Admin.Model.SharePoint.TeamSiteWithoutGroupOptions.html index fc5581f6ec..e6c54487c7 100644 --- a/api/PnP.Core.Admin.Model.SharePoint.TeamSiteWithoutGroupOptions.html +++ b/api/PnP.Core.Admin.Model.SharePoint.TeamSiteWithoutGroupOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonSiteOptions
CommonNoGroupSiteOptions
TeamSiteWithoutGroupOptions
diff --git a/api/PnP.Core.Admin.Model.SharePoint.VanityUrlOptions.html b/api/PnP.Core.Admin.Model.SharePoint.VanityUrlOptions.html index 58a61735d5..c075b1ce07 100644 --- a/api/PnP.Core.Admin.Model.SharePoint.VanityUrlOptions.html +++ b/api/PnP.Core.Admin.Model.SharePoint.VanityUrlOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
VanityUrlOptions
diff --git a/api/PnP.Core.Admin.Model.Teams.TeamCreationOptions.html b/api/PnP.Core.Admin.Model.Teams.TeamCreationOptions.html index 1d7a0833bd..18b5914275 100644 --- a/api/PnP.Core.Admin.Model.Teams.TeamCreationOptions.html +++ b/api/PnP.Core.Admin.Model.Teams.TeamCreationOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
TeamCreationOptions
diff --git a/api/PnP.Core.Admin.Model.Teams.TeamForGroupOptions.html b/api/PnP.Core.Admin.Model.Teams.TeamForGroupOptions.html index a686173a79..81beb05c20 100644 --- a/api/PnP.Core.Admin.Model.Teams.TeamForGroupOptions.html +++ b/api/PnP.Core.Admin.Model.Teams.TeamForGroupOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
TeamOptions
TeamForGroupOptions
diff --git a/api/PnP.Core.Admin.Model.Teams.TeamOptions.html b/api/PnP.Core.Admin.Model.Teams.TeamOptions.html index 83f295e088..ad92781562 100644 --- a/api/PnP.Core.Admin.Model.Teams.TeamOptions.html +++ b/api/PnP.Core.Admin.Model.Teams.TeamOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
TeamOptions
diff --git a/api/PnP.Core.Auth.CredentialManagerAuthenticationProvider.html b/api/PnP.Core.Auth.CredentialManagerAuthenticationProvider.html index dff8c0f98a..f1cbe0f467 100644 --- a/api/PnP.Core.Auth.CredentialManagerAuthenticationProvider.html +++ b/api/PnP.Core.Auth.CredentialManagerAuthenticationProvider.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
OAuthAuthenticationProvider
CredentialManagerAuthenticationProvider
diff --git a/api/PnP.Core.Auth.DeviceCodeAuthenticationProvider.html b/api/PnP.Core.Auth.DeviceCodeAuthenticationProvider.html index 0a8bea4dc8..b0179daa2b 100644 --- a/api/PnP.Core.Auth.DeviceCodeAuthenticationProvider.html +++ b/api/PnP.Core.Auth.DeviceCodeAuthenticationProvider.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
OAuthAuthenticationProvider
DeviceCodeAuthenticationProvider
diff --git a/api/PnP.Core.Auth.DeviceCodeNotification.html b/api/PnP.Core.Auth.DeviceCodeNotification.html index 180302d397..c13566042f 100644 --- a/api/PnP.Core.Auth.DeviceCodeNotification.html +++ b/api/PnP.Core.Auth.DeviceCodeNotification.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
DeviceCodeNotification
diff --git a/api/PnP.Core.Auth.ExternalAuthenticationProvider.html b/api/PnP.Core.Auth.ExternalAuthenticationProvider.html index ffb0e2068d..4cd2e7e14c 100644 --- a/api/PnP.Core.Auth.ExternalAuthenticationProvider.html +++ b/api/PnP.Core.Auth.ExternalAuthenticationProvider.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
OAuthAuthenticationProvider
ExternalAuthenticationProvider
diff --git a/api/PnP.Core.Auth.InteractiveAuthenticationProvider.html b/api/PnP.Core.Auth.InteractiveAuthenticationProvider.html index b369259af0..dee38d1559 100644 --- a/api/PnP.Core.Auth.InteractiveAuthenticationProvider.html +++ b/api/PnP.Core.Auth.InteractiveAuthenticationProvider.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
OAuthAuthenticationProvider
InteractiveAuthenticationProvider
diff --git a/api/PnP.Core.Auth.OAuthAuthenticationProvider.html b/api/PnP.Core.Auth.OAuthAuthenticationProvider.html index 7a657700e0..b2523e2c7b 100644 --- a/api/PnP.Core.Auth.OAuthAuthenticationProvider.html +++ b/api/PnP.Core.Auth.OAuthAuthenticationProvider.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
OAuthAuthenticationProvider
diff --git a/api/PnP.Core.Auth.OnBehalfOfAuthenticationProvider.html b/api/PnP.Core.Auth.OnBehalfOfAuthenticationProvider.html index bc87cb6d61..15600d9b72 100644 --- a/api/PnP.Core.Auth.OnBehalfOfAuthenticationProvider.html +++ b/api/PnP.Core.Auth.OnBehalfOfAuthenticationProvider.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
OAuthAuthenticationProvider
OnBehalfOfAuthenticationProvider
diff --git a/api/PnP.Core.Auth.Services.AuthenticationProviderFactory.html b/api/PnP.Core.Auth.Services.AuthenticationProviderFactory.html index bd86759be9..229e5888a9 100644 --- a/api/PnP.Core.Auth.Services.AuthenticationProviderFactory.html +++ b/api/PnP.Core.Auth.Services.AuthenticationProviderFactory.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AuthenticationProviderFactory
diff --git a/api/PnP.Core.Auth.Services.Builder.Configuration.AuthenticationProvidersOptionsConfigurator.html b/api/PnP.Core.Auth.Services.Builder.Configuration.AuthenticationProvidersOptionsConfigurator.html index c35a2c58f5..0f490f0886 100644 --- a/api/PnP.Core.Auth.Services.Builder.Configuration.AuthenticationProvidersOptionsConfigurator.html +++ b/api/PnP.Core.Auth.Services.Builder.Configuration.AuthenticationProvidersOptionsConfigurator.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AuthenticationProvidersOptionsConfigurator
diff --git a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationBaseOptions.html b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationBaseOptions.html index f01004d0da..25e4067b03 100644 --- a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationBaseOptions.html +++ b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationBaseOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreAuthenticationBaseOptions
diff --git a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialConfigurationOptions.html b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialConfigurationOptions.html index 862a5dfe9c..0199adb04e 100644 --- a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialConfigurationOptions.html +++ b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialConfigurationOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreAuthenticationCredentialConfigurationOptions
diff --git a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialManagerOptions.html b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialManagerOptions.html index 77e658c2c4..920cb52d60 100644 --- a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialManagerOptions.html +++ b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialManagerOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreAuthenticationBaseOptions
PnPCoreAuthenticationCredentialManagerOptions
diff --git a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialsConfigurationsOptions.html b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialsConfigurationsOptions.html index 32bb7002b9..ee5146d81b 100644 --- a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialsConfigurationsOptions.html +++ b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialsConfigurationsOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreAuthenticationCredentialsConfigurationsOptions
diff --git a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialsOptions.html b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialsOptions.html index 3b54578953..56d4814986 100644 --- a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialsOptions.html +++ b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialsOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreAuthenticationCredentialsOptions
diff --git a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationDeviceCodeOptions.html b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationDeviceCodeOptions.html index 867618c708..476f2f0200 100644 --- a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationDeviceCodeOptions.html +++ b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationDeviceCodeOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreAuthenticationBaseOptions
PnPCoreAuthenticationDeviceCodeOptions
diff --git a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationInteractiveOptions.html b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationInteractiveOptions.html index 135d9988dd..2e0c8440fe 100644 --- a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationInteractiveOptions.html +++ b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationInteractiveOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreAuthenticationBaseOptions
PnPCoreAuthenticationInteractiveOptions
diff --git a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationOnBehalfOfOptions.html b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationOnBehalfOfOptions.html index aad0ead01b..6db3e80711 100644 --- a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationOnBehalfOfOptions.html +++ b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationOnBehalfOfOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreAuthenticationBaseOptions
PnPCoreAuthenticationOnBehalfOfOptions
diff --git a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationOptions.html b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationOptions.html index 33ddcbff98..a52b448a0a 100644 --- a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationOptions.html +++ b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreAuthenticationOptions
diff --git a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationSiteOptions.html b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationSiteOptions.html index 2219e8ce6b..10f49fa4cc 100644 --- a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationSiteOptions.html +++ b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationSiteOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreAuthenticationSiteOptions
diff --git a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationSitesOptions.html b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationSitesOptions.html index 058aa238d5..eb7259fba3 100644 --- a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationSitesOptions.html +++ b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationSitesOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreAuthenticationSitesOptions
diff --git a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationUsernamePasswordOptions.html b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationUsernamePasswordOptions.html index 001b8cb5d4..627e946a68 100644 --- a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationUsernamePasswordOptions.html +++ b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationUsernamePasswordOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreAuthenticationBaseOptions
PnPCoreAuthenticationUsernamePasswordOptions
diff --git a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationX509CertificateOptions.html b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationX509CertificateOptions.html index d2f6715e07..2318edd950 100644 --- a/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationX509CertificateOptions.html +++ b/api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationX509CertificateOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreAuthenticationBaseOptions
PnPCoreAuthenticationX509CertificateOptions
diff --git a/api/PnP.Core.Auth.Services.Http.MsalHttpClientFactory.html b/api/PnP.Core.Auth.Services.Http.MsalHttpClientFactory.html index e791107cab..9bf16d4efd 100644 --- a/api/PnP.Core.Auth.Services.Http.MsalHttpClientFactory.html +++ b/api/PnP.Core.Auth.Services.Http.MsalHttpClientFactory.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
MsalHttpClientFactory
diff --git a/api/PnP.Core.Auth.UsernamePasswordAuthenticationProvider.html b/api/PnP.Core.Auth.UsernamePasswordAuthenticationProvider.html index 4892dfbcae..d09883d990 100644 --- a/api/PnP.Core.Auth.UsernamePasswordAuthenticationProvider.html +++ b/api/PnP.Core.Auth.UsernamePasswordAuthenticationProvider.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
OAuthAuthenticationProvider
UsernamePasswordAuthenticationProvider
diff --git a/api/PnP.Core.Auth.X509CertificateAuthenticationProvider.html b/api/PnP.Core.Auth.X509CertificateAuthenticationProvider.html index 238112dcbe..48a29d30fb 100644 --- a/api/PnP.Core.Auth.X509CertificateAuthenticationProvider.html +++ b/api/PnP.Core.Auth.X509CertificateAuthenticationProvider.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
OAuthAuthenticationProvider
X509CertificateAuthenticationProvider
diff --git a/api/PnP.Core.AuthenticationError.html b/api/PnP.Core.AuthenticationError.html index c13d5dce16..056a56b654 100644 --- a/api/PnP.Core.AuthenticationError.html +++ b/api/PnP.Core.AuthenticationError.html @@ -91,7 +91,7 @@

Cl
Inheritance
-
Object
+
System.Object
BaseError
AuthenticationError
diff --git a/api/PnP.Core.AuthenticationException.html b/api/PnP.Core.AuthenticationException.html index 4f0cea5330..9c05dbf8e2 100644 --- a/api/PnP.Core.AuthenticationException.html +++ b/api/PnP.Core.AuthenticationException.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPException
AuthenticationException
diff --git a/api/PnP.Core.BaseError.html b/api/PnP.Core.BaseError.html index 5d9ba166c4..338cdbe98f 100644 --- a/api/PnP.Core.BaseError.html +++ b/api/PnP.Core.BaseError.html @@ -91,7 +91,7 @@

Class BaseError
Inheritance
-
Object
+
System.Object
BaseError
@@ -193,7 +193,7 @@

Property Value
@@ -331,7 +331,7 @@
Parameters
- IDictionary<String, Object> + IDictionary<String, System.Object>

- Object + System.Object propertyValue

Value to add

diff --git a/api/PnP.Core.ClientError.html b/api/PnP.Core.ClientError.html index 9f422e3e5f..251e74fb4f 100644 --- a/api/PnP.Core.ClientError.html +++ b/api/PnP.Core.ClientError.html @@ -91,7 +91,7 @@

Class ClientError
Inheritance
-
Object
+
System.Object
BaseError
ClientError
diff --git a/api/PnP.Core.ClientException.html b/api/PnP.Core.ClientException.html index 25af2bfae1..24ae5d9b3d 100644 --- a/api/PnP.Core.ClientException.html +++ b/api/PnP.Core.ClientException.html @@ -91,7 +91,7 @@

Class Clie
Inheritance
-
Object
+
System.Object
PnPException
ClientException
diff --git a/api/PnP.Core.CsomError.html b/api/PnP.Core.CsomError.html index 42d5a01058..0ccdc4aa6f 100644 --- a/api/PnP.Core.CsomError.html +++ b/api/PnP.Core.CsomError.html @@ -91,7 +91,7 @@

Class CsomError
Inheritance
-
Object
+
System.Object
BaseError
ServiceError
CsomError
diff --git a/api/PnP.Core.CsomServiceException.html b/api/PnP.Core.CsomServiceException.html index d22285bc16..ad0d94734b 100644 --- a/api/PnP.Core.CsomServiceException.html +++ b/api/PnP.Core.CsomServiceException.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPException
ServiceException
CsomServiceException
diff --git a/api/PnP.Core.MicrosoftGraphError.html b/api/PnP.Core.MicrosoftGraphError.html index 9b4e55fea6..1695ea821f 100644 --- a/api/PnP.Core.MicrosoftGraphError.html +++ b/api/PnP.Core.MicrosoftGraphError.html @@ -91,7 +91,7 @@

Cl
Inheritance
-
Object
+
System.Object
BaseError
ServiceError
MicrosoftGraphError
diff --git a/api/PnP.Core.MicrosoftGraphServiceException.html b/api/PnP.Core.MicrosoftGraphServiceException.html index 6f717e3af3..cb3bba820a 100644 --- a/api/PnP.Core.MicrosoftGraphServiceException.html +++ b/api/PnP.Core.MicrosoftGraphServiceException.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPException
ServiceException
MicrosoftGraphServiceException
diff --git a/api/PnP.Core.Model.DataModelCollectionLoadExtensions.html b/api/PnP.Core.Model.DataModelCollectionLoadExtensions.html index a4043c7282..20e9bda58c 100644 --- a/api/PnP.Core.Model.DataModelCollectionLoadExtensions.html +++ b/api/PnP.Core.Model.DataModelCollectionLoadExtensions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
DataModelCollectionLoadExtensions
@@ -145,7 +145,7 @@

Parameters

- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

@@ -207,7 +207,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

@@ -287,7 +287,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

@@ -359,7 +359,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

@@ -439,7 +439,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

diff --git a/api/PnP.Core.Model.DataModelGetExtensions.html b/api/PnP.Core.Model.DataModelGetExtensions.html index aaca90cdc1..c0cb6ad8b6 100644 --- a/api/PnP.Core.Model.DataModelGetExtensions.html +++ b/api/PnP.Core.Model.DataModelGetExtensions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
DataModelGetExtensions
@@ -145,7 +145,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

@@ -217,7 +217,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

@@ -297,7 +297,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

@@ -369,7 +369,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

@@ -449,7 +449,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

diff --git a/api/PnP.Core.Model.DataModelLoadExtensions.html b/api/PnP.Core.Model.DataModelLoadExtensions.html index ce4fd552c9..3885b06bd9 100644 --- a/api/PnP.Core.Model.DataModelLoadExtensions.html +++ b/api/PnP.Core.Model.DataModelLoadExtensions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
DataModelLoadExtensions
@@ -145,7 +145,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

@@ -207,7 +207,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

@@ -287,7 +287,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

@@ -359,7 +359,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

@@ -439,7 +439,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

@@ -511,7 +511,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

diff --git a/api/PnP.Core.Model.FollowDocumentData.html b/api/PnP.Core.Model.FollowDocumentData.html index 5262f338dc..6b09e7f3fa 100644 --- a/api/PnP.Core.Model.FollowDocumentData.html +++ b/api/PnP.Core.Model.FollowDocumentData.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
FollowData
FollowDocumentData
diff --git a/api/PnP.Core.Model.FollowPersonData.html b/api/PnP.Core.Model.FollowPersonData.html index 7748c509c5..d83605bef1 100644 --- a/api/PnP.Core.Model.FollowPersonData.html +++ b/api/PnP.Core.Model.FollowPersonData.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
FollowData
FollowPersonData
diff --git a/api/PnP.Core.Model.FollowSiteData.html b/api/PnP.Core.Model.FollowSiteData.html index 4db6a4c800..3eaf6e322f 100644 --- a/api/PnP.Core.Model.FollowSiteData.html +++ b/api/PnP.Core.Model.FollowSiteData.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
FollowData
FollowSiteData
diff --git a/api/PnP.Core.Model.FollowTagData.html b/api/PnP.Core.Model.FollowTagData.html index e3de077fa4..863c6922c5 100644 --- a/api/PnP.Core.Model.FollowTagData.html +++ b/api/PnP.Core.Model.FollowTagData.html @@ -91,7 +91,7 @@

Cl
Inheritance
-
Object
+
System.Object
FollowData
FollowTagData
diff --git a/api/PnP.Core.Model.IBatchSingleResult.html b/api/PnP.Core.Model.IBatchSingleResult.html index 66415d57b8..a773e10d19 100644 --- a/api/PnP.Core.Model.IBatchSingleResult.html +++ b/api/PnP.Core.Model.IBatchSingleResult.html @@ -143,7 +143,7 @@

Property Value
diff --git a/api/PnP.Core.Model.IDataModel-1.html b/api/PnP.Core.Model.IDataModel-1.html index a57bfe36d5..6eb746b293 100644 --- a/api/PnP.Core.Model.IDataModel-1.html +++ b/api/PnP.Core.Model.IDataModel-1.html @@ -199,7 +199,7 @@
Parameters
- Object + System.Object

- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

Expression listing the properties to check

@@ -255,7 +255,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

Expressions listing the properties to load

@@ -301,7 +301,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

Expressions listing the properties to load

@@ -818,7 +818,7 @@
Parameters
- Expression<Func<TModel, Object>> + Expression<Func<TModel, System.Object>> expression

Expression listing the property to load

diff --git a/api/PnP.Core.Model.IDataModelCollectionLoad-1.html b/api/PnP.Core.Model.IDataModelCollectionLoad-1.html index cb555952ae..9f9214b891 100644 --- a/api/PnP.Core.Model.IDataModelCollectionLoad-1.html +++ b/api/PnP.Core.Model.IDataModelCollectionLoad-1.html @@ -143,7 +143,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] selectors

The properties to select

@@ -207,7 +207,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] selectors

The properties to select

diff --git a/api/PnP.Core.Model.IDataModelGet-1.html b/api/PnP.Core.Model.IDataModelGet-1.html index f368886fc6..bcffc5993f 100644 --- a/api/PnP.Core.Model.IDataModelGet-1.html +++ b/api/PnP.Core.Model.IDataModelGet-1.html @@ -142,7 +142,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

@@ -206,7 +206,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

diff --git a/api/PnP.Core.Model.IDataModelLoad-1.html b/api/PnP.Core.Model.IDataModelLoad-1.html index 66fa1d70d8..6a19aed167 100644 --- a/api/PnP.Core.Model.IDataModelLoad-1.html +++ b/api/PnP.Core.Model.IDataModelLoad-1.html @@ -142,7 +142,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

@@ -206,7 +206,7 @@
Parameters
- Expression<Func<TModel, Object>>[] + Expression<Func<TModel, System.Object>>[] expressions

The properties to select

diff --git a/api/PnP.Core.Model.IDataModelMappingHandler.html b/api/PnP.Core.Model.IDataModelMappingHandler.html index dd2fe85069..2e99d8d798 100644 --- a/api/PnP.Core.Model.IDataModelMappingHandler.html +++ b/api/PnP.Core.Model.IDataModelMappingHandler.html @@ -138,7 +138,7 @@
Property Value
diff --git a/api/PnP.Core.Model.IDataModelWithKey.html b/api/PnP.Core.Model.IDataModelWithKey.html index b74d3f37b4..fb8ca4a9c4 100644 --- a/api/PnP.Core.Model.IDataModelWithKey.html +++ b/api/PnP.Core.Model.IDataModelWithKey.html @@ -137,7 +137,7 @@
Property Value
- Func<FromJson, Object> + Func<FromJson, System.Object>

diff --git a/api/PnP.Core.Model.IExpandoDataModel.html b/api/PnP.Core.Model.IExpandoDataModel.html index e4e1495736..c1810ce2eb 100644 --- a/api/PnP.Core.Model.IExpandoDataModel.html +++ b/api/PnP.Core.Model.IExpandoDataModel.html @@ -192,7 +192,7 @@
Property Value
- Object + System.Object

@@ -280,7 +280,7 @@
Returns
- Object + System.Object

The value of the property
diff --git a/api/PnP.Core.Model.IManageableCollection.html b/api/PnP.Core.Model.IManageableCollection.html index deef131437..d4fabffbc6 100644 --- a/api/PnP.Core.Model.IManageableCollection.html +++ b/api/PnP.Core.Model.IManageableCollection.html @@ -134,7 +134,7 @@
Parameters
- Object + System.Object

Dynamic version of current model instance
- Object + System.Object item

The untyped item to add

@@ -181,7 +181,7 @@
Parameters
- Object + System.Object newItem

The untyped item to add

@@ -189,7 +189,7 @@
Parameters
- Predicate<Object> + Predicate<System.Object> selector

The selection predicate for the already existing item, if any

@@ -237,7 +237,7 @@
Returns
@@ -282,7 +282,7 @@
Returns
- Object + System.Object

The new item, ready to be added to the current collection
@@ -326,7 +326,7 @@
Parameters
- Object + System.Object

The new item, added to the collection
- Object + System.Object item

The untyped item to remove

@@ -390,7 +390,7 @@
Parameters
- Object + System.Object newItem

New item to replace the old one with

diff --git a/api/PnP.Core.Model.Me.ChatMemberOptions.html b/api/PnP.Core.Model.Me.ChatMemberOptions.html index 18fb30ea24..96b9037601 100644 --- a/api/PnP.Core.Model.Me.ChatMemberOptions.html +++ b/api/PnP.Core.Model.Me.ChatMemberOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ChatMemberOptions
diff --git a/api/PnP.Core.Model.Me.ChatOptions.html b/api/PnP.Core.Model.Me.ChatOptions.html index a20fe26abd..463fc65058 100644 --- a/api/PnP.Core.Model.Me.ChatOptions.html +++ b/api/PnP.Core.Model.Me.ChatOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ChatOptions
diff --git a/api/PnP.Core.Model.RequestModuleExtensions.html b/api/PnP.Core.Model.RequestModuleExtensions.html index 1f2a2a015c..39e882ca1a 100644 --- a/api/PnP.Core.Model.RequestModuleExtensions.html +++ b/api/PnP.Core.Model.RequestModuleExtensions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
RequestModuleExtensions
diff --git a/api/PnP.Core.Model.Security.AnonymousLinkOptions.html b/api/PnP.Core.Model.Security.AnonymousLinkOptions.html index 9cf01b1ef7..d9fbc00e37 100644 --- a/api/PnP.Core.Model.Security.AnonymousLinkOptions.html +++ b/api/PnP.Core.Model.Security.AnonymousLinkOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AnonymousLinkOptions
diff --git a/api/PnP.Core.Model.Security.IRoleAssignment.html b/api/PnP.Core.Model.Security.IRoleAssignment.html index 42cb3ac559..6af4140968 100644 --- a/api/PnP.Core.Model.Security.IRoleAssignment.html +++ b/api/PnP.Core.Model.Security.IRoleAssignment.html @@ -233,7 +233,7 @@
Property Value
diff --git a/api/PnP.Core.Model.Security.IRoleDefinition.html b/api/PnP.Core.Model.Security.IRoleDefinition.html index ddca808dfe..ff8eb60781 100644 --- a/api/PnP.Core.Model.Security.IRoleDefinition.html +++ b/api/PnP.Core.Model.Security.IRoleDefinition.html @@ -233,7 +233,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.Security.ISharePointGroup.html b/api/PnP.Core.Model.Security.ISharePointGroup.html index f43235c94b..25089c5d13 100644 --- a/api/PnP.Core.Model.Security.ISharePointGroup.html +++ b/api/PnP.Core.Model.Security.ISharePointGroup.html @@ -248,7 +248,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.Security.ISharePointUser.html b/api/PnP.Core.Model.Security.ISharePointUser.html index 91b605443e..808ec746a6 100644 --- a/api/PnP.Core.Model.Security.ISharePointUser.html +++ b/api/PnP.Core.Model.Security.ISharePointUser.html @@ -274,7 +274,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.Security.InviteOptions.html b/api/PnP.Core.Model.Security.InviteOptions.html index 8df28afd0b..f27e2fc1b0 100644 --- a/api/PnP.Core.Model.Security.InviteOptions.html +++ b/api/PnP.Core.Model.Security.InviteOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
InviteOptionsBase
InviteOptions
diff --git a/api/PnP.Core.Model.Security.InviteOptionsBase.html b/api/PnP.Core.Model.Security.InviteOptionsBase.html index 02ef6342ab..2b172c4480 100644 --- a/api/PnP.Core.Model.Security.InviteOptionsBase.html +++ b/api/PnP.Core.Model.Security.InviteOptionsBase.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
InviteOptionsBase
diff --git a/api/PnP.Core.Model.Security.MailOptions.html b/api/PnP.Core.Model.Security.MailOptions.html index 2b9e00ecf7..3daa110cf1 100644 --- a/api/PnP.Core.Model.Security.MailOptions.html +++ b/api/PnP.Core.Model.Security.MailOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
MailOptions
diff --git a/api/PnP.Core.Model.Security.MessageAttachmentOptions.html b/api/PnP.Core.Model.Security.MessageAttachmentOptions.html index 672769623a..8fbd3d7e89 100644 --- a/api/PnP.Core.Model.Security.MessageAttachmentOptions.html +++ b/api/PnP.Core.Model.Security.MessageAttachmentOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
MessageAttachmentOptions
diff --git a/api/PnP.Core.Model.Security.MessageOptions.html b/api/PnP.Core.Model.Security.MessageOptions.html index a34b2f8ea7..c113b68bbe 100644 --- a/api/PnP.Core.Model.Security.MessageOptions.html +++ b/api/PnP.Core.Model.Security.MessageOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
MessageOptions
diff --git a/api/PnP.Core.Model.Security.OrganizationalLinkOptions.html b/api/PnP.Core.Model.Security.OrganizationalLinkOptions.html index d6b08b8cbd..7259df7a67 100644 --- a/api/PnP.Core.Model.Security.OrganizationalLinkOptions.html +++ b/api/PnP.Core.Model.Security.OrganizationalLinkOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
OrganizationalLinkOptions
diff --git a/api/PnP.Core.Model.Security.RecipientOptions.html b/api/PnP.Core.Model.Security.RecipientOptions.html index 8c10784cc7..6362e92511 100644 --- a/api/PnP.Core.Model.Security.RecipientOptions.html +++ b/api/PnP.Core.Model.Security.RecipientOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
RecipientOptions
diff --git a/api/PnP.Core.Model.Security.UserLinkOptions.html b/api/PnP.Core.Model.Security.UserLinkOptions.html index c81cbd71f7..ddcae8f411 100644 --- a/api/PnP.Core.Model.Security.UserLinkOptions.html +++ b/api/PnP.Core.Model.Security.UserLinkOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
InviteOptionsBase
UserLinkOptions
diff --git a/api/PnP.Core.Model.SharePoint.ACEData.html b/api/PnP.Core.Model.SharePoint.ACEData.html index 30f9a20d92..879b2e35c4 100644 --- a/api/PnP.Core.Model.SharePoint.ACEData.html +++ b/api/PnP.Core.Model.SharePoint.ACEData.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ACEData
diff --git a/api/PnP.Core.Model.SharePoint.ACEFactory.html b/api/PnP.Core.Model.SharePoint.ACEFactory.html index 42bc7e830c..67c4890048 100644 --- a/api/PnP.Core.Model.SharePoint.ACEFactory.html +++ b/api/PnP.Core.Model.SharePoint.ACEFactory.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ACEFactory
diff --git a/api/PnP.Core.Model.SharePoint.ACEProperties.html b/api/PnP.Core.Model.SharePoint.ACEProperties.html index 3f425c29cb..14edb988f0 100644 --- a/api/PnP.Core.Model.SharePoint.ACEProperties.html +++ b/api/PnP.Core.Model.SharePoint.ACEProperties.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ACEProperties
diff --git a/api/PnP.Core.Model.SharePoint.AdaptiveCardAction-1.html b/api/PnP.Core.Model.SharePoint.AdaptiveCardAction-1.html index 8afb4dfdf2..b84b6efc5b 100644 --- a/api/PnP.Core.Model.SharePoint.AdaptiveCardAction-1.html +++ b/api/PnP.Core.Model.SharePoint.AdaptiveCardAction-1.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AdaptiveCardAction
AdaptiveCardAction<T>
diff --git a/api/PnP.Core.Model.SharePoint.AdaptiveCardAction.html b/api/PnP.Core.Model.SharePoint.AdaptiveCardAction.html index 970a77ea3a..4038519e25 100644 --- a/api/PnP.Core.Model.SharePoint.AdaptiveCardAction.html +++ b/api/PnP.Core.Model.SharePoint.AdaptiveCardAction.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AdaptiveCardAction
@@ -143,7 +143,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.SharePoint.AdaptiveCardControl.html b/api/PnP.Core.Model.SharePoint.AdaptiveCardControl.html index 9d7abc4e0f..899914f001 100644 --- a/api/PnP.Core.Model.SharePoint.AdaptiveCardControl.html +++ b/api/PnP.Core.Model.SharePoint.AdaptiveCardControl.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AdaptiveCardControl
diff --git a/api/PnP.Core.Model.SharePoint.AdaptiveCardExtension-1.html b/api/PnP.Core.Model.SharePoint.AdaptiveCardExtension-1.html index aae1ec7764..9564921f9c 100644 --- a/api/PnP.Core.Model.SharePoint.AdaptiveCardExtension-1.html +++ b/api/PnP.Core.Model.SharePoint.AdaptiveCardExtension-1.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AdaptiveCardExtension
AdaptiveCardExtension<T>
diff --git a/api/PnP.Core.Model.SharePoint.AdaptiveCardExtension.html b/api/PnP.Core.Model.SharePoint.AdaptiveCardExtension.html index 488a588237..e204a911e6 100644 --- a/api/PnP.Core.Model.SharePoint.AdaptiveCardExtension.html +++ b/api/PnP.Core.Model.SharePoint.AdaptiveCardExtension.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AdaptiveCardExtension
@@ -543,7 +543,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.SharePoint.AdaptiveCardTemplate.html b/api/PnP.Core.Model.SharePoint.AdaptiveCardTemplate.html index a2192ef353..8ac00ebf95 100644 --- a/api/PnP.Core.Model.SharePoint.AdaptiveCardTemplate.html +++ b/api/PnP.Core.Model.SharePoint.AdaptiveCardTemplate.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AdaptiveCardTemplate
diff --git a/api/PnP.Core.Model.SharePoint.AddContentTypeFromHubOptions.html b/api/PnP.Core.Model.SharePoint.AddContentTypeFromHubOptions.html index a39f590ede..448a718d79 100644 --- a/api/PnP.Core.Model.SharePoint.AddContentTypeFromHubOptions.html +++ b/api/PnP.Core.Model.SharePoint.AddContentTypeFromHubOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AddContentTypeFromHubOptions
diff --git a/api/PnP.Core.Model.SharePoint.AddUserCustomActionOptions.html b/api/PnP.Core.Model.SharePoint.AddUserCustomActionOptions.html index 773be48b00..5a72b8359e 100644 --- a/api/PnP.Core.Model.SharePoint.AddUserCustomActionOptions.html +++ b/api/PnP.Core.Model.SharePoint.AddUserCustomActionOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AddUserCustomActionOptions
diff --git a/api/PnP.Core.Model.SharePoint.AnalyticsOptions.html b/api/PnP.Core.Model.SharePoint.AnalyticsOptions.html index c3be063d9b..56318736d9 100644 --- a/api/PnP.Core.Model.SharePoint.AnalyticsOptions.html +++ b/api/PnP.Core.Model.SharePoint.AnalyticsOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AnalyticsOptions
diff --git a/api/PnP.Core.Model.SharePoint.AssignedTasksACE.html b/api/PnP.Core.Model.SharePoint.AssignedTasksACE.html index 7c5c76ff4f..85937b753f 100644 --- a/api/PnP.Core.Model.SharePoint.AssignedTasksACE.html +++ b/api/PnP.Core.Model.SharePoint.AssignedTasksACE.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AdaptiveCardExtension
AssignedTasksACE
diff --git a/api/PnP.Core.Model.SharePoint.AssignedTasksACEFactory.html b/api/PnP.Core.Model.SharePoint.AssignedTasksACEFactory.html index 3d66337d7e..b3391e26ec 100644 --- a/api/PnP.Core.Model.SharePoint.AssignedTasksACEFactory.html +++ b/api/PnP.Core.Model.SharePoint.AssignedTasksACEFactory.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ACEFactory
AssignedTasksACEFactory
diff --git a/api/PnP.Core.Model.SharePoint.ButtonAction.html b/api/PnP.Core.Model.SharePoint.ButtonAction.html index fe317efbef..51765507c6 100644 --- a/api/PnP.Core.Model.SharePoint.ButtonAction.html +++ b/api/PnP.Core.Model.SharePoint.ButtonAction.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ButtonAction
diff --git a/api/PnP.Core.Model.SharePoint.CamlQueryOptions.html b/api/PnP.Core.Model.SharePoint.CamlQueryOptions.html index c58b673433..f3dcd28949 100644 --- a/api/PnP.Core.Model.SharePoint.CamlQueryOptions.html +++ b/api/PnP.Core.Model.SharePoint.CamlQueryOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CamlQueryOptions
diff --git a/api/PnP.Core.Model.SharePoint.CardDesignerACE.html b/api/PnP.Core.Model.SharePoint.CardDesignerACE.html index ad0497ad37..112681472b 100644 --- a/api/PnP.Core.Model.SharePoint.CardDesignerACE.html +++ b/api/PnP.Core.Model.SharePoint.CardDesignerACE.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AdaptiveCardExtension
AdaptiveCardExtension<CardDesignerProps>
CardDesignerACE
diff --git a/api/PnP.Core.Model.SharePoint.CardDesignerACEFactory.html b/api/PnP.Core.Model.SharePoint.CardDesignerACEFactory.html index d9d320ec84..2630a73440 100644 --- a/api/PnP.Core.Model.SharePoint.CardDesignerACEFactory.html +++ b/api/PnP.Core.Model.SharePoint.CardDesignerACEFactory.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ACEFactory
CardDesignerACEFactory
diff --git a/api/PnP.Core.Model.SharePoint.CardDesignerProps.html b/api/PnP.Core.Model.SharePoint.CardDesignerProps.html index 05a93f6ce8..bb447a8609 100644 --- a/api/PnP.Core.Model.SharePoint.CardDesignerProps.html +++ b/api/PnP.Core.Model.SharePoint.CardDesignerProps.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ACEProperties
CardDesignerProps
diff --git a/api/PnP.Core.Model.SharePoint.ChangeQueryOptions.html b/api/PnP.Core.Model.SharePoint.ChangeQueryOptions.html index 77efdc8c03..f8be5088ac 100644 --- a/api/PnP.Core.Model.SharePoint.ChangeQueryOptions.html +++ b/api/PnP.Core.Model.SharePoint.ChangeQueryOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ChangeQueryOptions
diff --git a/api/PnP.Core.Model.SharePoint.ChangeTokenOptions.html b/api/PnP.Core.Model.SharePoint.ChangeTokenOptions.html index 4465934180..725d85da4c 100644 --- a/api/PnP.Core.Model.SharePoint.ChangeTokenOptions.html +++ b/api/PnP.Core.Model.SharePoint.ChangeTokenOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ChangeTokenOptions
diff --git a/api/PnP.Core.Model.SharePoint.CommonFieldOptions.html b/api/PnP.Core.Model.SharePoint.CommonFieldOptions.html index 168b28f67b..ec847fcd7f 100644 --- a/api/PnP.Core.Model.SharePoint.CommonFieldOptions.html +++ b/api/PnP.Core.Model.SharePoint.CommonFieldOptions.html @@ -92,7 +92,7 @@

Inheritance
-
Object
+
System.Object
CommonFieldOptions
diff --git a/api/PnP.Core.Model.SharePoint.ConvertToOptions.html b/api/PnP.Core.Model.SharePoint.ConvertToOptions.html index fb1fed99f6..5348b5186c 100644 --- a/api/PnP.Core.Model.SharePoint.ConvertToOptions.html +++ b/api/PnP.Core.Model.SharePoint.ConvertToOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ConvertToOptions
diff --git a/api/PnP.Core.Model.SharePoint.CopyMigrationOptions.html b/api/PnP.Core.Model.SharePoint.CopyMigrationOptions.html index 1ad536fb08..5f457f5045 100644 --- a/api/PnP.Core.Model.SharePoint.CopyMigrationOptions.html +++ b/api/PnP.Core.Model.SharePoint.CopyMigrationOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CopyMigrationOptions
diff --git a/api/PnP.Core.Model.SharePoint.CustomImageSettings.html b/api/PnP.Core.Model.SharePoint.CustomImageSettings.html index 9f9d69eaa1..92147ef132 100644 --- a/api/PnP.Core.Model.SharePoint.CustomImageSettings.html +++ b/api/PnP.Core.Model.SharePoint.CustomImageSettings.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CustomImageSettings
diff --git a/api/PnP.Core.Model.SharePoint.CustomThumbnailOptions.html b/api/PnP.Core.Model.SharePoint.CustomThumbnailOptions.html index 10f7810631..8821d7688c 100644 --- a/api/PnP.Core.Model.SharePoint.CustomThumbnailOptions.html +++ b/api/PnP.Core.Model.SharePoint.CustomThumbnailOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CustomThumbnailOptions
diff --git a/api/PnP.Core.Model.SharePoint.DefaultColumnValueOptions.html b/api/PnP.Core.Model.SharePoint.DefaultColumnValueOptions.html index 1ff0e21260..6835eac365 100644 --- a/api/PnP.Core.Model.SharePoint.DefaultColumnValueOptions.html +++ b/api/PnP.Core.Model.SharePoint.DefaultColumnValueOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
DefaultColumnValueOptions
diff --git a/api/PnP.Core.Model.SharePoint.DocumentSetContentOptions.html b/api/PnP.Core.Model.SharePoint.DocumentSetContentOptions.html index 7a231776f0..733aa5040c 100644 --- a/api/PnP.Core.Model.SharePoint.DocumentSetContentOptions.html +++ b/api/PnP.Core.Model.SharePoint.DocumentSetContentOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
DocumentSetContentOptions
diff --git a/api/PnP.Core.Model.SharePoint.DocumentSetOptions.html b/api/PnP.Core.Model.SharePoint.DocumentSetOptions.html index 7b84341d11..b78628a983 100644 --- a/api/PnP.Core.Model.SharePoint.DocumentSetOptions.html +++ b/api/PnP.Core.Model.SharePoint.DocumentSetOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
DocumentSetOptions
diff --git a/api/PnP.Core.Model.SharePoint.EventReceiverOptions.html b/api/PnP.Core.Model.SharePoint.EventReceiverOptions.html index 1ae2652e19..d904fb96b3 100644 --- a/api/PnP.Core.Model.SharePoint.EventReceiverOptions.html +++ b/api/PnP.Core.Model.SharePoint.EventReceiverOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
EventReceiverOptions
diff --git a/api/PnP.Core.Model.SharePoint.ExternalLinkAction.html b/api/PnP.Core.Model.SharePoint.ExternalLinkAction.html index 9f96def747..1210e45742 100644 --- a/api/PnP.Core.Model.SharePoint.ExternalLinkAction.html +++ b/api/PnP.Core.Model.SharePoint.ExternalLinkAction.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AdaptiveCardAction
AdaptiveCardAction<ExternalLinkActionParameter>
ExternalLinkAction
diff --git a/api/PnP.Core.Model.SharePoint.ExternalLinkActionParameter.html b/api/PnP.Core.Model.SharePoint.ExternalLinkActionParameter.html index 1c42a69c48..2c8a23f872 100644 --- a/api/PnP.Core.Model.SharePoint.ExternalLinkActionParameter.html +++ b/api/PnP.Core.Model.SharePoint.ExternalLinkActionParameter.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ExternalLinkActionParameter
diff --git a/api/PnP.Core.Model.SharePoint.FieldBooleanOptions.html b/api/PnP.Core.Model.SharePoint.FieldBooleanOptions.html index e27e97e165..98aee02083 100644 --- a/api/PnP.Core.Model.SharePoint.FieldBooleanOptions.html +++ b/api/PnP.Core.Model.SharePoint.FieldBooleanOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonFieldOptions
FieldBooleanOptions
diff --git a/api/PnP.Core.Model.SharePoint.FieldCalculatedOptions.html b/api/PnP.Core.Model.SharePoint.FieldCalculatedOptions.html index 141329610e..c2666d6462 100644 --- a/api/PnP.Core.Model.SharePoint.FieldCalculatedOptions.html +++ b/api/PnP.Core.Model.SharePoint.FieldCalculatedOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonFieldOptions
FieldCalculatedOptions
diff --git a/api/PnP.Core.Model.SharePoint.FieldChoiceMultiOptions.html b/api/PnP.Core.Model.SharePoint.FieldChoiceMultiOptions.html index a4990ca720..b0b58f2506 100644 --- a/api/PnP.Core.Model.SharePoint.FieldChoiceMultiOptions.html +++ b/api/PnP.Core.Model.SharePoint.FieldChoiceMultiOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonFieldOptions
FieldChoiceMultiOptions
diff --git a/api/PnP.Core.Model.SharePoint.FieldChoiceOptions.html b/api/PnP.Core.Model.SharePoint.FieldChoiceOptions.html index 2f6c8ed918..fcf24a551b 100644 --- a/api/PnP.Core.Model.SharePoint.FieldChoiceOptions.html +++ b/api/PnP.Core.Model.SharePoint.FieldChoiceOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonFieldOptions
FieldChoiceMultiOptions
FieldChoiceOptions
diff --git a/api/PnP.Core.Model.SharePoint.FieldCurrencyOptions.html b/api/PnP.Core.Model.SharePoint.FieldCurrencyOptions.html index 0aa71da3a1..81c6905e92 100644 --- a/api/PnP.Core.Model.SharePoint.FieldCurrencyOptions.html +++ b/api/PnP.Core.Model.SharePoint.FieldCurrencyOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonFieldOptions
FieldCurrencyOptions
diff --git a/api/PnP.Core.Model.SharePoint.FieldDateTimeOptions.html b/api/PnP.Core.Model.SharePoint.FieldDateTimeOptions.html index a86cc14183..a12899c7b8 100644 --- a/api/PnP.Core.Model.SharePoint.FieldDateTimeOptions.html +++ b/api/PnP.Core.Model.SharePoint.FieldDateTimeOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonFieldOptions
FieldDateTimeOptions
diff --git a/api/PnP.Core.Model.SharePoint.FieldLocationValue.html b/api/PnP.Core.Model.SharePoint.FieldLocationValue.html index 0d6d8ae938..819c7c54e4 100644 --- a/api/PnP.Core.Model.SharePoint.FieldLocationValue.html +++ b/api/PnP.Core.Model.SharePoint.FieldLocationValue.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
FieldValue
FieldLocationValue
diff --git a/api/PnP.Core.Model.SharePoint.FieldLookupOptions.html b/api/PnP.Core.Model.SharePoint.FieldLookupOptions.html index 70cd66f1af..05a030744f 100644 --- a/api/PnP.Core.Model.SharePoint.FieldLookupOptions.html +++ b/api/PnP.Core.Model.SharePoint.FieldLookupOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonFieldOptions
FieldLookupOptions
diff --git a/api/PnP.Core.Model.SharePoint.FieldLookupValue.html b/api/PnP.Core.Model.SharePoint.FieldLookupValue.html index 3a6ea52149..35f593051b 100644 --- a/api/PnP.Core.Model.SharePoint.FieldLookupValue.html +++ b/api/PnP.Core.Model.SharePoint.FieldLookupValue.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
FieldValue
FieldLookupValue
diff --git a/api/PnP.Core.Model.SharePoint.FieldMultilineTextOptions.html b/api/PnP.Core.Model.SharePoint.FieldMultilineTextOptions.html index c15421f501..d8c11e44fe 100644 --- a/api/PnP.Core.Model.SharePoint.FieldMultilineTextOptions.html +++ b/api/PnP.Core.Model.SharePoint.FieldMultilineTextOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonFieldOptions
FieldMultilineTextOptions
diff --git a/api/PnP.Core.Model.SharePoint.FieldNumberOptions.html b/api/PnP.Core.Model.SharePoint.FieldNumberOptions.html index 8e26021dee..1a3c954531 100644 --- a/api/PnP.Core.Model.SharePoint.FieldNumberOptions.html +++ b/api/PnP.Core.Model.SharePoint.FieldNumberOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonFieldOptions
FieldNumberOptions
diff --git a/api/PnP.Core.Model.SharePoint.FieldTaxonomyOptions.html b/api/PnP.Core.Model.SharePoint.FieldTaxonomyOptions.html index 51c07c4b3f..20e3561888 100644 --- a/api/PnP.Core.Model.SharePoint.FieldTaxonomyOptions.html +++ b/api/PnP.Core.Model.SharePoint.FieldTaxonomyOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonFieldOptions
FieldTaxonomyOptions
diff --git a/api/PnP.Core.Model.SharePoint.FieldTaxonomyValue.html b/api/PnP.Core.Model.SharePoint.FieldTaxonomyValue.html index ec4ab8839e..a68ef4a01a 100644 --- a/api/PnP.Core.Model.SharePoint.FieldTaxonomyValue.html +++ b/api/PnP.Core.Model.SharePoint.FieldTaxonomyValue.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
FieldValue
FieldTaxonomyValue
diff --git a/api/PnP.Core.Model.SharePoint.FieldTextOptions.html b/api/PnP.Core.Model.SharePoint.FieldTextOptions.html index bd420761de..6f3ca4e056 100644 --- a/api/PnP.Core.Model.SharePoint.FieldTextOptions.html +++ b/api/PnP.Core.Model.SharePoint.FieldTextOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonFieldOptions
FieldTextOptions
diff --git a/api/PnP.Core.Model.SharePoint.FieldUrlOptions.html b/api/PnP.Core.Model.SharePoint.FieldUrlOptions.html index eb19192f20..28576e578f 100644 --- a/api/PnP.Core.Model.SharePoint.FieldUrlOptions.html +++ b/api/PnP.Core.Model.SharePoint.FieldUrlOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonFieldOptions
FieldUrlOptions
diff --git a/api/PnP.Core.Model.SharePoint.FieldUrlValue.html b/api/PnP.Core.Model.SharePoint.FieldUrlValue.html index adbf06c040..9c341cb5df 100644 --- a/api/PnP.Core.Model.SharePoint.FieldUrlValue.html +++ b/api/PnP.Core.Model.SharePoint.FieldUrlValue.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
FieldValue
FieldUrlValue
diff --git a/api/PnP.Core.Model.SharePoint.FieldUserOptions.html b/api/PnP.Core.Model.SharePoint.FieldUserOptions.html index 03dae31b61..3a9731e94d 100644 --- a/api/PnP.Core.Model.SharePoint.FieldUserOptions.html +++ b/api/PnP.Core.Model.SharePoint.FieldUserOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
CommonFieldOptions
FieldUserOptions
diff --git a/api/PnP.Core.Model.SharePoint.FieldUserValue.html b/api/PnP.Core.Model.SharePoint.FieldUserValue.html index 3e9a7c4714..916f60354b 100644 --- a/api/PnP.Core.Model.SharePoint.FieldUserValue.html +++ b/api/PnP.Core.Model.SharePoint.FieldUserValue.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
FieldValue
FieldLookupValue
FieldUserValue
diff --git a/api/PnP.Core.Model.SharePoint.FieldValue.html b/api/PnP.Core.Model.SharePoint.FieldValue.html index d35de7b032..fe48467dc5 100644 --- a/api/PnP.Core.Model.SharePoint.FieldValue.html +++ b/api/PnP.Core.Model.SharePoint.FieldValue.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
FieldValue
diff --git a/api/PnP.Core.Model.SharePoint.FieldValueCollection.html b/api/PnP.Core.Model.SharePoint.FieldValueCollection.html index ad74569d42..a7b61c76a0 100644 --- a/api/PnP.Core.Model.SharePoint.FieldValueCollection.html +++ b/api/PnP.Core.Model.SharePoint.FieldValueCollection.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
FieldValueCollection
diff --git a/api/PnP.Core.Model.SharePoint.FollowData.html b/api/PnP.Core.Model.SharePoint.FollowData.html index dba6295aeb..477313ddac 100644 --- a/api/PnP.Core.Model.SharePoint.FollowData.html +++ b/api/PnP.Core.Model.SharePoint.FollowData.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
FollowData
diff --git a/api/PnP.Core.Model.SharePoint.GenericAdaptiveCardExtension.html b/api/PnP.Core.Model.SharePoint.GenericAdaptiveCardExtension.html index 6547f45e91..8de75d2cc9 100644 --- a/api/PnP.Core.Model.SharePoint.GenericAdaptiveCardExtension.html +++ b/api/PnP.Core.Model.SharePoint.GenericAdaptiveCardExtension.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AdaptiveCardExtension
AdaptiveCardExtension<JsonElement>
GenericAdaptiveCardExtension
diff --git a/api/PnP.Core.Model.SharePoint.IAttachment.html b/api/PnP.Core.Model.SharePoint.IAttachment.html index d0d116c702..b133c9b2a9 100644 --- a/api/PnP.Core.Model.SharePoint.IAttachment.html +++ b/api/PnP.Core.Model.SharePoint.IAttachment.html @@ -227,7 +227,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.SharePoint.IBasePermissions.html b/api/PnP.Core.Model.SharePoint.IBasePermissions.html index 91d08cee4c..ddbedd2c6c 100644 --- a/api/PnP.Core.Model.SharePoint.IBasePermissions.html +++ b/api/PnP.Core.Model.SharePoint.IBasePermissions.html @@ -185,7 +185,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.SharePoint.IChange.html b/api/PnP.Core.Model.SharePoint.IChange.html index dc57981af9..78d89099bb 100644 --- a/api/PnP.Core.Model.SharePoint.IChange.html +++ b/api/PnP.Core.Model.SharePoint.IChange.html @@ -311,7 +311,7 @@
Parameters
- Object + System.Object

- Expression<Func<TModel, Object>> + Expression<Func<TModel, System.Object>> expression

An expression defining the property to check (e.g. p => p.Property)

diff --git a/api/PnP.Core.Model.SharePoint.IComment.html b/api/PnP.Core.Model.SharePoint.IComment.html index 410f1893cd..c0f5e0d085 100644 --- a/api/PnP.Core.Model.SharePoint.IComment.html +++ b/api/PnP.Core.Model.SharePoint.IComment.html @@ -215,7 +215,7 @@
Property Value
diff --git a/api/PnP.Core.Model.SharePoint.IContentType.html b/api/PnP.Core.Model.SharePoint.IContentType.html index edf1118e21..d47fcdf830 100644 --- a/api/PnP.Core.Model.SharePoint.IContentType.html +++ b/api/PnP.Core.Model.SharePoint.IContentType.html @@ -233,7 +233,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.SharePoint.IEventReceiverDefinition.html b/api/PnP.Core.Model.SharePoint.IEventReceiverDefinition.html index 6b5d9fe5a6..7febb90ec4 100644 --- a/api/PnP.Core.Model.SharePoint.IEventReceiverDefinition.html +++ b/api/PnP.Core.Model.SharePoint.IEventReceiverDefinition.html @@ -215,7 +215,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.SharePoint.IFeature.html b/api/PnP.Core.Model.SharePoint.IFeature.html index 3163695180..9a3d44df2f 100644 --- a/api/PnP.Core.Model.SharePoint.IFeature.html +++ b/api/PnP.Core.Model.SharePoint.IFeature.html @@ -191,7 +191,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.SharePoint.IField.html b/api/PnP.Core.Model.SharePoint.IField.html index 5c689c537d..b860465062 100644 --- a/api/PnP.Core.Model.SharePoint.IField.html +++ b/api/PnP.Core.Model.SharePoint.IField.html @@ -233,7 +233,7 @@
Property Value
- Object + System.Object

@@ -1070,7 +1070,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.SharePoint.IFieldLink.html b/api/PnP.Core.Model.SharePoint.IFieldLink.html index c1cfe06cb4..77de5a2e67 100644 --- a/api/PnP.Core.Model.SharePoint.IFieldLink.html +++ b/api/PnP.Core.Model.SharePoint.IFieldLink.html @@ -233,7 +233,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.SharePoint.IFile.html b/api/PnP.Core.Model.SharePoint.IFile.html index bc9bf90534..56350e6a43 100644 --- a/api/PnP.Core.Model.SharePoint.IFile.html +++ b/api/PnP.Core.Model.SharePoint.IFile.html @@ -233,7 +233,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.SharePoint.IFileVersion.html b/api/PnP.Core.Model.SharePoint.IFileVersion.html index cfe7fad744..fa47048d22 100644 --- a/api/PnP.Core.Model.SharePoint.IFileVersion.html +++ b/api/PnP.Core.Model.SharePoint.IFileVersion.html @@ -197,7 +197,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.SharePoint.IFileVersionCollection.html b/api/PnP.Core.Model.SharePoint.IFileVersionCollection.html index f7e026b938..cd89f0bafd 100644 --- a/api/PnP.Core.Model.SharePoint.IFileVersionCollection.html +++ b/api/PnP.Core.Model.SharePoint.IFileVersionCollection.html @@ -168,7 +168,7 @@
Parameters
- Object + System.Object

- Expression<Func<IFileVersion, Object>>[] + Expression<Func<IFileVersion, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -232,7 +232,7 @@
Parameters
- Expression<Func<IFileVersion, Object>>[] + Expression<Func<IFileVersion, System.Object>>[] selectors

The expressions declaring the fields to select

diff --git a/api/PnP.Core.Model.SharePoint.IFolder.html b/api/PnP.Core.Model.SharePoint.IFolder.html index b82ec04c9b..44285c346d 100644 --- a/api/PnP.Core.Model.SharePoint.IFolder.html +++ b/api/PnP.Core.Model.SharePoint.IFolder.html @@ -251,7 +251,7 @@
Property Value
diff --git a/api/PnP.Core.Model.SharePoint.IFollowing.html b/api/PnP.Core.Model.SharePoint.IFollowing.html index 8d26974a12..12b964e09f 100644 --- a/api/PnP.Core.Model.SharePoint.IFollowing.html +++ b/api/PnP.Core.Model.SharePoint.IFollowing.html @@ -749,7 +749,7 @@
Parameters
- Object + System.Object

- Expression<Func<IPersonProperties, Object>>[] + Expression<Func<IPersonProperties, System.Object>>[] selectors

Specific properties to return

@@ -813,7 +813,7 @@
Parameters
- Expression<Func<IPersonProperties, Object>>[] + Expression<Func<IPersonProperties, System.Object>>[] selectors

Specific properties to return

@@ -967,7 +967,7 @@
Parameters
- Expression<Func<IPersonProperties, Object>>[] + Expression<Func<IPersonProperties, System.Object>>[] selectors

Specific properties to return

@@ -1031,7 +1031,7 @@
Parameters
- Expression<Func<IPersonProperties, Object>>[] + Expression<Func<IPersonProperties, System.Object>>[] selectors

Specific properties to return

diff --git a/api/PnP.Core.Model.SharePoint.IHubSite.html b/api/PnP.Core.Model.SharePoint.IHubSite.html index 81a6220ccc..789cb9cda4 100644 --- a/api/PnP.Core.Model.SharePoint.IHubSite.html +++ b/api/PnP.Core.Model.SharePoint.IHubSite.html @@ -233,7 +233,7 @@
Property Value
diff --git a/api/PnP.Core.Model.SharePoint.IInformationRightsManagementSettings.html b/api/PnP.Core.Model.SharePoint.IInformationRightsManagementSettings.html index b34f4e50f2..cc61378e0a 100644 --- a/api/PnP.Core.Model.SharePoint.IInformationRightsManagementSettings.html +++ b/api/PnP.Core.Model.SharePoint.IInformationRightsManagementSettings.html @@ -197,7 +197,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.SharePoint.IList.html b/api/PnP.Core.Model.SharePoint.IList.html index b8370d28b6..0da33eef60 100644 --- a/api/PnP.Core.Model.SharePoint.IList.html +++ b/api/PnP.Core.Model.SharePoint.IList.html @@ -347,7 +347,7 @@
Property Value
- Object + System.Object

@@ -4801,7 +4801,7 @@
Parameters
- Object + System.Object

- Expression<Func<IListItem, Object>>[] + Expression<Func<IListItem, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -4855,7 +4855,7 @@
Parameters
- Expression<Func<IListItem, Object>>[] + Expression<Func<IListItem, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -4909,7 +4909,7 @@
Parameters
- Expression<Func<IListItem, Object>>[] + Expression<Func<IListItem, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -4972,7 +4972,7 @@
Parameters
- Expression<Func<IListItem, Object>>[] + Expression<Func<IListItem, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -5035,7 +5035,7 @@
Parameters
- Expression<Func<IListItem, Object>>[] + Expression<Func<IListItem, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -5097,7 +5097,7 @@
Parameters
- Expression<Func<IListItem, Object>>[] + Expression<Func<IListItem, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -5159,7 +5159,7 @@
Parameters
- Expression<Func<IListItem, Object>>[] + Expression<Func<IListItem, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -5213,7 +5213,7 @@
Parameters
- Expression<Func<IListItem, Object>>[] + Expression<Func<IListItem, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -5267,7 +5267,7 @@
Parameters
- Expression<Func<IListItem, Object>>[] + Expression<Func<IListItem, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -5338,7 +5338,7 @@
Parameters
- Expression<Func<IListItem, Object>>[] + Expression<Func<IListItem, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -5409,7 +5409,7 @@
Parameters
- Expression<Func<IListItem, Object>>[] + Expression<Func<IListItem, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -5472,7 +5472,7 @@
Parameters
- Expression<Func<IListItem, Object>>[] + Expression<Func<IListItem, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -5539,7 +5539,7 @@
Returns
@@ -5594,7 +5594,7 @@
Returns
- Dictionary<String, Object> + Dictionary<String, System.Object>

@@ -5649,7 +5649,7 @@
Returns
- Task<Dictionary<String, Object>> + Task<Dictionary<String, System.Object>>

@@ -5712,7 +5712,7 @@
Returns
- IBatchSingleResult<Dictionary<String, Object>> + IBatchSingleResult<Dictionary<String, System.Object>>

@@ -5767,7 +5767,7 @@
Returns
- IBatchSingleResult<Dictionary<String, Object>> + IBatchSingleResult<Dictionary<String, System.Object>>

@@ -5830,7 +5830,7 @@
Returns
- Task<IBatchSingleResult<Dictionary<String, Object>>> + Task<IBatchSingleResult<Dictionary<String, System.Object>>>

diff --git a/api/PnP.Core.Model.SharePoint.IListCollection.html b/api/PnP.Core.Model.SharePoint.IListCollection.html index 41c67e6edc..1829d57a71 100644 --- a/api/PnP.Core.Model.SharePoint.IListCollection.html +++ b/api/PnP.Core.Model.SharePoint.IListCollection.html @@ -578,7 +578,7 @@
Parameters
- Task<IBatchSingleResult<Dictionary<String, Object>>> + Task<IBatchSingleResult<Dictionary<String, System.Object>>>

- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -634,7 +634,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -690,7 +690,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -754,7 +754,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -810,7 +810,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -874,7 +874,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -938,7 +938,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1002,7 +1002,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1066,7 +1066,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1138,7 +1138,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1202,7 +1202,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1274,7 +1274,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1338,7 +1338,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1402,7 +1402,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1474,7 +1474,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1538,7 +1538,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1610,7 +1610,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1674,7 +1674,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1738,7 +1738,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1802,7 +1802,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1874,7 +1874,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1938,7 +1938,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -2010,7 +2010,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -2074,7 +2074,7 @@
Parameters
- Expression<Func<IList, Object>>[] + Expression<Func<IList, System.Object>>[] selectors

The expressions declaring the fields to select

diff --git a/api/PnP.Core.Model.SharePoint.IListItem.html b/api/PnP.Core.Model.SharePoint.IListItem.html index 5e0d2783a3..dcf591e61a 100644 --- a/api/PnP.Core.Model.SharePoint.IListItem.html +++ b/api/PnP.Core.Model.SharePoint.IListItem.html @@ -359,7 +359,7 @@
Property Value
@@ -1791,7 +1791,7 @@
Parameters
- Object + System.Object

- Expression<Func<IComment, Object>>[] + Expression<Func<IComment, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1846,7 +1846,7 @@
Parameters
- Expression<Func<IComment, Object>>[] + Expression<Func<IComment, System.Object>>[] selectors

The expressions declaring the fields to select

diff --git a/api/PnP.Core.Model.SharePoint.IListItemCollection.html b/api/PnP.Core.Model.SharePoint.IListItemCollection.html index 2f4696b192..61baa6de50 100644 --- a/api/PnP.Core.Model.SharePoint.IListItemCollection.html +++ b/api/PnP.Core.Model.SharePoint.IListItemCollection.html @@ -178,7 +178,7 @@
Parameters
- Dictionary<String, Object> + Dictionary<String, System.Object> values

Values to add to list item

@@ -250,7 +250,7 @@
Parameters
- Dictionary<String, Object> + Dictionary<String, System.Object> values

Values to add to list item

@@ -322,7 +322,7 @@
Parameters
- Dictionary<String, Object> + Dictionary<String, System.Object> values

Values to add to list item

@@ -402,7 +402,7 @@
Parameters
- Dictionary<String, Object> + Dictionary<String, System.Object> values

Values to add to list item

@@ -474,7 +474,7 @@
Parameters
- Dictionary<String, Object> + Dictionary<String, System.Object> values

Values to add to list item

@@ -554,7 +554,7 @@
Parameters
- Dictionary<String, Object> + Dictionary<String, System.Object> values

Values to add to list item

@@ -690,7 +690,7 @@
Parameters
- Expression<Func<IListItem, Object>>[] + Expression<Func<IListItem, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -754,7 +754,7 @@
Parameters
- Expression<Func<IListItem, Object>>[] + Expression<Func<IListItem, System.Object>>[] selectors

The expressions declaring the fields to select

diff --git a/api/PnP.Core.Model.SharePoint.IListItemVersion.html b/api/PnP.Core.Model.SharePoint.IListItemVersion.html index f458f2e00e..447ead1ddf 100644 --- a/api/PnP.Core.Model.SharePoint.IListItemVersion.html +++ b/api/PnP.Core.Model.SharePoint.IListItemVersion.html @@ -227,7 +227,7 @@
Property Value
diff --git a/api/PnP.Core.Model.SharePoint.IListItemVersionCollection.html b/api/PnP.Core.Model.SharePoint.IListItemVersionCollection.html index 1e58271494..33fa1d19d5 100644 --- a/api/PnP.Core.Model.SharePoint.IListItemVersionCollection.html +++ b/api/PnP.Core.Model.SharePoint.IListItemVersionCollection.html @@ -168,7 +168,7 @@
Parameters
- Object + System.Object

- Expression<Func<IListItemVersion, Object>>[] + Expression<Func<IListItemVersion, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -232,7 +232,7 @@
Parameters
- Expression<Func<IListItemVersion, Object>>[] + Expression<Func<IListItemVersion, System.Object>>[] selectors

The expressions declaring the fields to select

diff --git a/api/PnP.Core.Model.SharePoint.INavigation.html b/api/PnP.Core.Model.SharePoint.INavigation.html index bc19f2e4e5..2328194749 100644 --- a/api/PnP.Core.Model.SharePoint.INavigation.html +++ b/api/PnP.Core.Model.SharePoint.INavigation.html @@ -197,7 +197,7 @@
Property Value
diff --git a/api/PnP.Core.Model.SharePoint.INavigationNode.html b/api/PnP.Core.Model.SharePoint.INavigationNode.html index e47799ae88..beaa3519a5 100644 --- a/api/PnP.Core.Model.SharePoint.INavigationNode.html +++ b/api/PnP.Core.Model.SharePoint.INavigationNode.html @@ -233,7 +233,7 @@
Property Value
- Object + System.Object

@@ -671,7 +671,7 @@
Parameters
- Object + System.Object

@@ -725,7 +725,7 @@
Parameters
- Expression<Func<INavigationNode, Object>>[] + Expression<Func<INavigationNode, System.Object>>[] selectors

diff --git a/api/PnP.Core.Model.SharePoint.INavigationNodeCollection.html b/api/PnP.Core.Model.SharePoint.INavigationNodeCollection.html index e394d8f20e..d4ec9c4870 100644 --- a/api/PnP.Core.Model.SharePoint.INavigationNodeCollection.html +++ b/api/PnP.Core.Model.SharePoint.INavigationNodeCollection.html @@ -579,7 +579,7 @@
Parameters
- Expression<Func<INavigationNode, Object>>[] + Expression<Func<INavigationNode, System.Object>>[] selectors

- Expression<Func<INavigationNode, Object>>[] + Expression<Func<INavigationNode, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -643,7 +643,7 @@
Parameters
- Expression<Func<INavigationNode, Object>>[] + Expression<Func<INavigationNode, System.Object>>[] selectors

The expressions declaring the fields to select

diff --git a/api/PnP.Core.Model.SharePoint.IPage.html b/api/PnP.Core.Model.SharePoint.IPage.html index 8c61d04cbc..bcc8d58cd3 100644 --- a/api/PnP.Core.Model.SharePoint.IPage.html +++ b/api/PnP.Core.Model.SharePoint.IPage.html @@ -2610,7 +2610,7 @@
Parameters
- Expression<Func<IComment, Object>>[] + Expression<Func<IComment, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -2665,7 +2665,7 @@
Parameters
- Expression<Func<IComment, Object>>[] + Expression<Func<IComment, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -3080,7 +3080,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the file

@@ -3136,7 +3136,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the file

diff --git a/api/PnP.Core.Model.SharePoint.IPersonProperties.html b/api/PnP.Core.Model.SharePoint.IPersonProperties.html index 08e6550858..43c3505b87 100644 --- a/api/PnP.Core.Model.SharePoint.IPersonProperties.html +++ b/api/PnP.Core.Model.SharePoint.IPersonProperties.html @@ -709,7 +709,7 @@
Property Value
diff --git a/api/PnP.Core.Model.SharePoint.IRecycleBinItem.html b/api/PnP.Core.Model.SharePoint.IRecycleBinItem.html index e397c80c05..202ad1371b 100644 --- a/api/PnP.Core.Model.SharePoint.IRecycleBinItem.html +++ b/api/PnP.Core.Model.SharePoint.IRecycleBinItem.html @@ -233,7 +233,7 @@
Property Value
- Dictionary<String, Object> + Dictionary<String, System.Object>

diff --git a/api/PnP.Core.Model.SharePoint.IRecycleBinItemCollection.html b/api/PnP.Core.Model.SharePoint.IRecycleBinItemCollection.html index aeb1057bc0..dcf711df7e 100644 --- a/api/PnP.Core.Model.SharePoint.IRecycleBinItemCollection.html +++ b/api/PnP.Core.Model.SharePoint.IRecycleBinItemCollection.html @@ -700,7 +700,7 @@
Parameters
- Object + System.Object

- Expression<Func<IRecycleBinItem, Object>>[] + Expression<Func<IRecycleBinItem, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -764,7 +764,7 @@
Parameters
- Expression<Func<IRecycleBinItem, Object>>[] + Expression<Func<IRecycleBinItem, System.Object>>[] selectors

The expressions declaring the fields to select

diff --git a/api/PnP.Core.Model.SharePoint.IRegionalSettings.html b/api/PnP.Core.Model.SharePoint.IRegionalSettings.html index 1a8671104b..2502fd6db5 100644 --- a/api/PnP.Core.Model.SharePoint.IRegionalSettings.html +++ b/api/PnP.Core.Model.SharePoint.IRegionalSettings.html @@ -197,7 +197,7 @@
Property Value
diff --git a/api/PnP.Core.Model.SharePoint.ISearchResult.html b/api/PnP.Core.Model.SharePoint.ISearchResult.html index 8f0a614741..17bfc24652 100644 --- a/api/PnP.Core.Model.SharePoint.ISearchResult.html +++ b/api/PnP.Core.Model.SharePoint.ISearchResult.html @@ -225,7 +225,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.SharePoint.ISite.html b/api/PnP.Core.Model.SharePoint.ISite.html index 1972ddebea..e4cb22db1e 100644 --- a/api/PnP.Core.Model.SharePoint.ISite.html +++ b/api/PnP.Core.Model.SharePoint.ISite.html @@ -233,7 +233,7 @@
Property Value
- PnP.Core.Model.SharePoint.List<Dictionary<String, Object>> + PnP.Core.Model.SharePoint.List<Dictionary<String, System.Object>>

diff --git a/api/PnP.Core.Model.SharePoint.IStorageMetrics.html b/api/PnP.Core.Model.SharePoint.IStorageMetrics.html index 04e8b6a4cc..101e513d05 100644 --- a/api/PnP.Core.Model.SharePoint.IStorageMetrics.html +++ b/api/PnP.Core.Model.SharePoint.IStorageMetrics.html @@ -185,7 +185,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.SharePoint.ITermGroupCollection.html b/api/PnP.Core.Model.SharePoint.ITermGroupCollection.html index 8c4716c1d8..4d97be2f3c 100644 --- a/api/PnP.Core.Model.SharePoint.ITermGroupCollection.html +++ b/api/PnP.Core.Model.SharePoint.ITermGroupCollection.html @@ -628,7 +628,7 @@
Parameters
- Object + System.Object

- Expression<Func<ITermGroup, Object>>[] + Expression<Func<ITermGroup, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -692,7 +692,7 @@
Parameters
- Expression<Func<ITermGroup, Object>>[] + Expression<Func<ITermGroup, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -756,7 +756,7 @@
Parameters
- Expression<Func<ITermGroup, Object>>[] + Expression<Func<ITermGroup, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -820,7 +820,7 @@
Parameters
- Expression<Func<ITermGroup, Object>>[] + Expression<Func<ITermGroup, System.Object>>[] selectors

The expressions declaring the fields to select

diff --git a/api/PnP.Core.Model.SharePoint.ITermSetCollection.html b/api/PnP.Core.Model.SharePoint.ITermSetCollection.html index 4597fc0be6..488d36c330 100644 --- a/api/PnP.Core.Model.SharePoint.ITermSetCollection.html +++ b/api/PnP.Core.Model.SharePoint.ITermSetCollection.html @@ -580,7 +580,7 @@
Parameters
- Expression<Func<ITermSet, Object>>[] + Expression<Func<ITermSet, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -644,7 +644,7 @@
Parameters
- Expression<Func<ITermSet, Object>>[] + Expression<Func<ITermSet, System.Object>>[] selectors

The expressions declaring the fields to select

diff --git a/api/PnP.Core.Model.SharePoint.ITermStore.html b/api/PnP.Core.Model.SharePoint.ITermStore.html index 023a010f65..67fe08db9a 100644 --- a/api/PnP.Core.Model.SharePoint.ITermStore.html +++ b/api/PnP.Core.Model.SharePoint.ITermStore.html @@ -408,7 +408,7 @@
Parameters
- Expression<Func<ITerm, Object>>[] + Expression<Func<ITerm, System.Object>>[] selectors

Properties to load for the term

@@ -480,7 +480,7 @@
Parameters
- Expression<Func<ITerm, Object>>[] + Expression<Func<ITerm, System.Object>>[] selectors

Properties to load for the term

@@ -560,7 +560,7 @@
Parameters
- Expression<Func<ITerm, Object>>[] + Expression<Func<ITerm, System.Object>>[] selectors

Properties to load for the term

@@ -632,7 +632,7 @@
Parameters
- Expression<Func<ITerm, Object>>[] + Expression<Func<ITerm, System.Object>>[] selectors

Properties to load for the term

@@ -712,7 +712,7 @@
Parameters
- Expression<Func<ITerm, Object>>[] + Expression<Func<ITerm, System.Object>>[] selectors

Properties to load for the term

@@ -784,7 +784,7 @@
Parameters
- Expression<Func<ITerm, Object>>[] + Expression<Func<ITerm, System.Object>>[] selectors

Properties to load for the term

@@ -848,7 +848,7 @@
Parameters
- Expression<Func<ITermSet, Object>>[] + Expression<Func<ITermSet, System.Object>>[] selectors

Properties to load for the termset

@@ -912,7 +912,7 @@
Parameters
- Expression<Func<ITermSet, Object>>[] + Expression<Func<ITermSet, System.Object>>[] selectors

Properties to load for the termset

@@ -984,7 +984,7 @@
Parameters
- Expression<Func<ITermSet, Object>>[] + Expression<Func<ITermSet, System.Object>>[] selectors

Properties to load for the termset

@@ -1048,7 +1048,7 @@
Parameters
- Expression<Func<ITermSet, Object>>[] + Expression<Func<ITermSet, System.Object>>[] selectors

Properties to load for the termset

@@ -1120,7 +1120,7 @@
Parameters
- Expression<Func<ITermSet, Object>>[] + Expression<Func<ITermSet, System.Object>>[] selectors

Properties to load for the termset

@@ -1184,7 +1184,7 @@
Parameters
- Expression<Func<ITermSet, Object>>[] + Expression<Func<ITermSet, System.Object>>[] selectors

Properties to load for the termset

diff --git a/api/PnP.Core.Model.SharePoint.ITimeZone.html b/api/PnP.Core.Model.SharePoint.ITimeZone.html index 762532f7e9..52b35e4198 100644 --- a/api/PnP.Core.Model.SharePoint.ITimeZone.html +++ b/api/PnP.Core.Model.SharePoint.ITimeZone.html @@ -197,7 +197,7 @@
Property Value
diff --git a/api/PnP.Core.Model.SharePoint.IUserCustomAction.html b/api/PnP.Core.Model.SharePoint.IUserCustomAction.html index 7d1846580f..d56874a17e 100644 --- a/api/PnP.Core.Model.SharePoint.IUserCustomAction.html +++ b/api/PnP.Core.Model.SharePoint.IUserCustomAction.html @@ -233,7 +233,7 @@
Property Value
- Object + System.Object

diff --git a/api/PnP.Core.Model.SharePoint.IUserProfile.html b/api/PnP.Core.Model.SharePoint.IUserProfile.html index c3e9f94c6b..0264e294d2 100644 --- a/api/PnP.Core.Model.SharePoint.IUserProfile.html +++ b/api/PnP.Core.Model.SharePoint.IUserProfile.html @@ -283,7 +283,7 @@
Parameters
- Object + System.Object

- Expression<Func<IPersonProperties, Object>>[] + Expression<Func<IPersonProperties, System.Object>>[] selectors

Specific properties to return

@@ -339,7 +339,7 @@
Parameters
- Expression<Func<IPersonProperties, Object>>[] + Expression<Func<IPersonProperties, System.Object>>[] selectors

Specific properties to return

@@ -403,7 +403,7 @@
Parameters
- Expression<Func<IPersonProperties, Object>>[] + Expression<Func<IPersonProperties, System.Object>>[] selectors

Specific properties to return

@@ -467,7 +467,7 @@
Parameters
- Expression<Func<IPersonProperties, Object>>[] + Expression<Func<IPersonProperties, System.Object>>[] selectors

Specific properties to return

diff --git a/api/PnP.Core.Model.SharePoint.IView.html b/api/PnP.Core.Model.SharePoint.IView.html index 86f6c32cef..d0ceb695b0 100644 --- a/api/PnP.Core.Model.SharePoint.IView.html +++ b/api/PnP.Core.Model.SharePoint.IView.html @@ -321,7 +321,7 @@
Property Value
diff --git a/api/PnP.Core.Model.SharePoint.IWeb.html b/api/PnP.Core.Model.SharePoint.IWeb.html index f5d10a36a7..c44133fbcf 100644 --- a/api/PnP.Core.Model.SharePoint.IWeb.html +++ b/api/PnP.Core.Model.SharePoint.IWeb.html @@ -435,7 +435,7 @@
Property Value
- Object + System.Object

@@ -6184,7 +6184,7 @@
Parameters
- Object + System.Object

- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the requested IFile

@@ -6248,7 +6248,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the requested IFile

@@ -6312,7 +6312,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the requested IFile

@@ -6384,7 +6384,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the requested IFile

@@ -6448,7 +6448,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the requested IFile

@@ -6520,7 +6520,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the requested IFile

@@ -6584,7 +6584,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the requested IFile

@@ -6648,7 +6648,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the requested IFile

@@ -6712,7 +6712,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the requested IFile

@@ -6776,7 +6776,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the requested IFile

@@ -6848,7 +6848,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the requested IFile

@@ -6912,7 +6912,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the requested IFile

@@ -6984,7 +6984,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the requested IFile

@@ -7048,7 +7048,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the requested IFile

@@ -7112,7 +7112,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the requested IFile

@@ -7176,7 +7176,7 @@
Parameters
- Expression<Func<IFile, Object>>[] + Expression<Func<IFile, System.Object>>[] expressions

Properties to load for the requested IFile

@@ -7240,7 +7240,7 @@
Parameters
- Expression<Func<IFolder, Object>>[] + Expression<Func<IFolder, System.Object>>[] expressions

Expressions needed to create the request

@@ -7304,7 +7304,7 @@
Parameters
- Expression<Func<IFolder, Object>>[] + Expression<Func<IFolder, System.Object>>[] expressions

Expressions needed to create the request

@@ -7368,7 +7368,7 @@
Parameters
- Expression<Func<IFolder, Object>>[] + Expression<Func<IFolder, System.Object>>[] expressions

Expressions needed to create the request

@@ -7440,7 +7440,7 @@
Parameters
- Expression<Func<IFolder, Object>>[] + Expression<Func<IFolder, System.Object>>[] expressions

Expressions needed to create the request

@@ -7504,7 +7504,7 @@
Parameters
- Expression<Func<IFolder, Object>>[] + Expression<Func<IFolder, System.Object>>[] expressions

Expressions needed to create the request

@@ -7576,7 +7576,7 @@
Parameters
- Expression<Func<IFolder, Object>>[] + Expression<Func<IFolder, System.Object>>[] expressions

Expressions needed to create the request

@@ -7640,7 +7640,7 @@
Parameters
- Expression<Func<IFolder, Object>>[] + Expression<Func<IFolder, System.Object>>[] expressions

Expressions needed to create the request

@@ -7704,7 +7704,7 @@
Parameters
- Expression<Func<IFolder, Object>>[] + Expression<Func<IFolder, System.Object>>[] expressions

Expressions needed to create the request

@@ -7776,7 +7776,7 @@
Parameters
- Expression<Func<IFolder, Object>>[] + Expression<Func<IFolder, System.Object>>[] expressions

Expressions needed to create the request

@@ -7840,7 +7840,7 @@
Parameters
- Expression<Func<IFolder, Object>>[] + Expression<Func<IFolder, System.Object>>[] expressions

Expressions needed to create the request

@@ -7912,7 +7912,7 @@
Parameters
- Expression<Func<IFolder, Object>>[] + Expression<Func<IFolder, System.Object>>[] expressions

Expressions needed to create the request

@@ -7976,7 +7976,7 @@
Parameters
- Expression<Func<IFolder, Object>>[] + Expression<Func<IFolder, System.Object>>[] expressions

Expressions needed to create the request

diff --git a/api/PnP.Core.Model.SharePoint.LongRunningOperationOptions.html b/api/PnP.Core.Model.SharePoint.LongRunningOperationOptions.html index a58d0eb694..957dfce3f2 100644 --- a/api/PnP.Core.Model.SharePoint.LongRunningOperationOptions.html +++ b/api/PnP.Core.Model.SharePoint.LongRunningOperationOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
LongRunningOperationOptions
diff --git a/api/PnP.Core.Model.SharePoint.MoveCopyOptions.html b/api/PnP.Core.Model.SharePoint.MoveCopyOptions.html index 03d5728d33..125847658b 100644 --- a/api/PnP.Core.Model.SharePoint.MoveCopyOptions.html +++ b/api/PnP.Core.Model.SharePoint.MoveCopyOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
MoveCopyOptions
diff --git a/api/PnP.Core.Model.SharePoint.NavigationNodeOptions.html b/api/PnP.Core.Model.SharePoint.NavigationNodeOptions.html index a7db1fa783..c38ee4ee2e 100644 --- a/api/PnP.Core.Model.SharePoint.NavigationNodeOptions.html +++ b/api/PnP.Core.Model.SharePoint.NavigationNodeOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
NavigationNodeOptions
diff --git a/api/PnP.Core.Model.SharePoint.PageImageOptions.html b/api/PnP.Core.Model.SharePoint.PageImageOptions.html index 19898224d9..1a306cc599 100644 --- a/api/PnP.Core.Model.SharePoint.PageImageOptions.html +++ b/api/PnP.Core.Model.SharePoint.PageImageOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PageImageOptions
diff --git a/api/PnP.Core.Model.SharePoint.PageTranslationOptions.html b/api/PnP.Core.Model.SharePoint.PageTranslationOptions.html index 8328eab18c..4c97d3a7fb 100644 --- a/api/PnP.Core.Model.SharePoint.PageTranslationOptions.html +++ b/api/PnP.Core.Model.SharePoint.PageTranslationOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PageTranslationOptions
diff --git a/api/PnP.Core.Model.SharePoint.PreviewOptions.html b/api/PnP.Core.Model.SharePoint.PreviewOptions.html index c4a1d135cd..606dd47e1b 100644 --- a/api/PnP.Core.Model.SharePoint.PreviewOptions.html +++ b/api/PnP.Core.Model.SharePoint.PreviewOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PreviewOptions
diff --git a/api/PnP.Core.Model.SharePoint.QuickView.html b/api/PnP.Core.Model.SharePoint.QuickView.html index 3216f65da4..9510168750 100644 --- a/api/PnP.Core.Model.SharePoint.QuickView.html +++ b/api/PnP.Core.Model.SharePoint.QuickView.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
QuickView
diff --git a/api/PnP.Core.Model.SharePoint.QuickViewAction.html b/api/PnP.Core.Model.SharePoint.QuickViewAction.html index 3c6df24a23..50ec4d163e 100644 --- a/api/PnP.Core.Model.SharePoint.QuickViewAction.html +++ b/api/PnP.Core.Model.SharePoint.QuickViewAction.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AdaptiveCardAction
AdaptiveCardAction<QuickViewActionParameter>
QuickViewAction
diff --git a/api/PnP.Core.Model.SharePoint.QuickViewActionParameter.html b/api/PnP.Core.Model.SharePoint.QuickViewActionParameter.html index 4d187eeb10..12470a8588 100644 --- a/api/PnP.Core.Model.SharePoint.QuickViewActionParameter.html +++ b/api/PnP.Core.Model.SharePoint.QuickViewActionParameter.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
QuickViewActionParameter
diff --git a/api/PnP.Core.Model.SharePoint.RecycleBinQueryOptions.html b/api/PnP.Core.Model.SharePoint.RecycleBinQueryOptions.html index d41b4d6abf..66f4d20239 100644 --- a/api/PnP.Core.Model.SharePoint.RecycleBinQueryOptions.html +++ b/api/PnP.Core.Model.SharePoint.RecycleBinQueryOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
RecycleBinQueryOptions
diff --git a/api/PnP.Core.Model.SharePoint.RenderListDataOptions.html b/api/PnP.Core.Model.SharePoint.RenderListDataOptions.html index 9767770de6..611321eb89 100644 --- a/api/PnP.Core.Model.SharePoint.RenderListDataOptions.html +++ b/api/PnP.Core.Model.SharePoint.RenderListDataOptions.html @@ -92,7 +92,7 @@

Inheritance
-
Object
+
System.Object
RenderListDataOptions
diff --git a/api/PnP.Core.Model.SharePoint.SearchOptions.html b/api/PnP.Core.Model.SharePoint.SearchOptions.html index 8c82f096f3..82adb58b8f 100644 --- a/api/PnP.Core.Model.SharePoint.SearchOptions.html +++ b/api/PnP.Core.Model.SharePoint.SearchOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
SearchOptions
diff --git a/api/PnP.Core.Model.SharePoint.SortOption.html b/api/PnP.Core.Model.SharePoint.SortOption.html index 324ae16719..8653201c14 100644 --- a/api/PnP.Core.Model.SharePoint.SortOption.html +++ b/api/PnP.Core.Model.SharePoint.SortOption.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
SortOption
diff --git a/api/PnP.Core.Model.SharePoint.SyntexModelPublishOptions.html b/api/PnP.Core.Model.SharePoint.SyntexModelPublishOptions.html index d2a3b510d0..b995975f13 100644 --- a/api/PnP.Core.Model.SharePoint.SyntexModelPublishOptions.html +++ b/api/PnP.Core.Model.SharePoint.SyntexModelPublishOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
SyntexModelUnPublishOptions
SyntexModelPublishOptions
diff --git a/api/PnP.Core.Model.SharePoint.SyntexModelUnPublishOptions.html b/api/PnP.Core.Model.SharePoint.SyntexModelUnPublishOptions.html index 2565337d11..73ec690f57 100644 --- a/api/PnP.Core.Model.SharePoint.SyntexModelUnPublishOptions.html +++ b/api/PnP.Core.Model.SharePoint.SyntexModelUnPublishOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
SyntexModelUnPublishOptions
diff --git a/api/PnP.Core.Model.SharePoint.TeamsACE.html b/api/PnP.Core.Model.SharePoint.TeamsACE.html index cb9ea1568c..763b0bb9cb 100644 --- a/api/PnP.Core.Model.SharePoint.TeamsACE.html +++ b/api/PnP.Core.Model.SharePoint.TeamsACE.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
AdaptiveCardExtension
AdaptiveCardExtension<TeamsACEProperties>
TeamsACE
diff --git a/api/PnP.Core.Model.SharePoint.TeamsACEApp.html b/api/PnP.Core.Model.SharePoint.TeamsACEApp.html index 33a12ee91e..dbca209ba8 100644 --- a/api/PnP.Core.Model.SharePoint.TeamsACEApp.html +++ b/api/PnP.Core.Model.SharePoint.TeamsACEApp.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
TeamsACEApp
diff --git a/api/PnP.Core.Model.SharePoint.TeamsACEAppIconProperties.html b/api/PnP.Core.Model.SharePoint.TeamsACEAppIconProperties.html index ed88977505..6f567a49c1 100644 --- a/api/PnP.Core.Model.SharePoint.TeamsACEAppIconProperties.html +++ b/api/PnP.Core.Model.SharePoint.TeamsACEAppIconProperties.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
TeamsACEAppIconProperties
diff --git a/api/PnP.Core.Model.SharePoint.TeamsACEFactory.html b/api/PnP.Core.Model.SharePoint.TeamsACEFactory.html index 68c7fea0ad..fbea37d7f4 100644 --- a/api/PnP.Core.Model.SharePoint.TeamsACEFactory.html +++ b/api/PnP.Core.Model.SharePoint.TeamsACEFactory.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ACEFactory
TeamsACEFactory
diff --git a/api/PnP.Core.Model.SharePoint.TeamsACEProperties.html b/api/PnP.Core.Model.SharePoint.TeamsACEProperties.html index b1265c989d..becf02019b 100644 --- a/api/PnP.Core.Model.SharePoint.TeamsACEProperties.html +++ b/api/PnP.Core.Model.SharePoint.TeamsACEProperties.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ACEProperties
TeamsACEProperties
diff --git a/api/PnP.Core.Model.SharePoint.ThumbnailOptions.html b/api/PnP.Core.Model.SharePoint.ThumbnailOptions.html index 2e2960b225..6719e6aa21 100644 --- a/api/PnP.Core.Model.SharePoint.ThumbnailOptions.html +++ b/api/PnP.Core.Model.SharePoint.ThumbnailOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ThumbnailOptions
diff --git a/api/PnP.Core.Model.SharePoint.UnfurlOptions.html b/api/PnP.Core.Model.SharePoint.UnfurlOptions.html index 79ff6833fa..4ccbd1509b 100644 --- a/api/PnP.Core.Model.SharePoint.UnfurlOptions.html +++ b/api/PnP.Core.Model.SharePoint.UnfurlOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
UnfurlOptions
diff --git a/api/PnP.Core.Model.SharePoint.ViewOptions.html b/api/PnP.Core.Model.SharePoint.ViewOptions.html index 495e6a3970..8b668ec2e5 100644 --- a/api/PnP.Core.Model.SharePoint.ViewOptions.html +++ b/api/PnP.Core.Model.SharePoint.ViewOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ViewOptions
diff --git a/api/PnP.Core.Model.SharePoint.WebOptions.html b/api/PnP.Core.Model.SharePoint.WebOptions.html index b761e40824..f3186bcd67 100644 --- a/api/PnP.Core.Model.SharePoint.WebOptions.html +++ b/api/PnP.Core.Model.SharePoint.WebOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
WebOptions
diff --git a/api/PnP.Core.Model.Teams.ChatMessageAttachmentOptions.html b/api/PnP.Core.Model.Teams.ChatMessageAttachmentOptions.html index fe02e0c595..5e7ca75cbd 100644 --- a/api/PnP.Core.Model.Teams.ChatMessageAttachmentOptions.html +++ b/api/PnP.Core.Model.Teams.ChatMessageAttachmentOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ChatMessageAttachmentOptions
diff --git a/api/PnP.Core.Model.Teams.ChatMessageHostedContentOptions.html b/api/PnP.Core.Model.Teams.ChatMessageHostedContentOptions.html index f5e723c215..227affa559 100644 --- a/api/PnP.Core.Model.Teams.ChatMessageHostedContentOptions.html +++ b/api/PnP.Core.Model.Teams.ChatMessageHostedContentOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ChatMessageHostedContentOptions
diff --git a/api/PnP.Core.Model.Teams.ChatMessageMentionOptions.html b/api/PnP.Core.Model.Teams.ChatMessageMentionOptions.html index 32837c6cce..7d15c3e123 100644 --- a/api/PnP.Core.Model.Teams.ChatMessageMentionOptions.html +++ b/api/PnP.Core.Model.Teams.ChatMessageMentionOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ChatMessageMentionOptions
diff --git a/api/PnP.Core.Model.Teams.ChatMessageOptions.html b/api/PnP.Core.Model.Teams.ChatMessageOptions.html index 797b9069e9..640fb146d9 100644 --- a/api/PnP.Core.Model.Teams.ChatMessageOptions.html +++ b/api/PnP.Core.Model.Teams.ChatMessageOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ChatMessageOptions
diff --git a/api/PnP.Core.Model.Teams.EventAddressOptions.html b/api/PnP.Core.Model.Teams.EventAddressOptions.html index 55f43f6d47..dc9c9076c6 100644 --- a/api/PnP.Core.Model.Teams.EventAddressOptions.html +++ b/api/PnP.Core.Model.Teams.EventAddressOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
EventAddressOptions
diff --git a/api/PnP.Core.Model.Teams.EventAttendeeOptions.html b/api/PnP.Core.Model.Teams.EventAttendeeOptions.html index 23ec71b584..e81a4d7144 100644 --- a/api/PnP.Core.Model.Teams.EventAttendeeOptions.html +++ b/api/PnP.Core.Model.Teams.EventAttendeeOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
EventAttendeeOptions
diff --git a/api/PnP.Core.Model.Teams.EventCoordinateOptions.html b/api/PnP.Core.Model.Teams.EventCoordinateOptions.html index 75bdfeb585..20abb733d7 100644 --- a/api/PnP.Core.Model.Teams.EventCoordinateOptions.html +++ b/api/PnP.Core.Model.Teams.EventCoordinateOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
EventCoordinateOptions
diff --git a/api/PnP.Core.Model.Teams.EventCreateOptions.html b/api/PnP.Core.Model.Teams.EventCreateOptions.html index 6c0dfa8a5a..2504c438eb 100644 --- a/api/PnP.Core.Model.Teams.EventCreateOptions.html +++ b/api/PnP.Core.Model.Teams.EventCreateOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
EventCreateOptions
diff --git a/api/PnP.Core.Model.Teams.EventLocationOptions.html b/api/PnP.Core.Model.Teams.EventLocationOptions.html index 57fca040d5..6423f978ac 100644 --- a/api/PnP.Core.Model.Teams.EventLocationOptions.html +++ b/api/PnP.Core.Model.Teams.EventLocationOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
EventLocationOptions
diff --git a/api/PnP.Core.Model.Teams.EventRecipientOptions.html b/api/PnP.Core.Model.Teams.EventRecipientOptions.html index f17385f608..b3d77b6f37 100644 --- a/api/PnP.Core.Model.Teams.EventRecipientOptions.html +++ b/api/PnP.Core.Model.Teams.EventRecipientOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
EventRecipientOptions
diff --git a/api/PnP.Core.Model.Teams.EventRecurrenceOptions.html b/api/PnP.Core.Model.Teams.EventRecurrenceOptions.html index 3f560ee01f..b12b23f426 100644 --- a/api/PnP.Core.Model.Teams.EventRecurrenceOptions.html +++ b/api/PnP.Core.Model.Teams.EventRecurrenceOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
EventRecurrenceOptions
diff --git a/api/PnP.Core.Model.Teams.EventRecurrencePatternOptions.html b/api/PnP.Core.Model.Teams.EventRecurrencePatternOptions.html index 5945be3733..e78d0e64b5 100644 --- a/api/PnP.Core.Model.Teams.EventRecurrencePatternOptions.html +++ b/api/PnP.Core.Model.Teams.EventRecurrencePatternOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
EventRecurrencePatternOptions
diff --git a/api/PnP.Core.Model.Teams.EventRecurrenceRangeOptions.html b/api/PnP.Core.Model.Teams.EventRecurrenceRangeOptions.html index 6263417ad5..9965346c12 100644 --- a/api/PnP.Core.Model.Teams.EventRecurrenceRangeOptions.html +++ b/api/PnP.Core.Model.Teams.EventRecurrenceRangeOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
EventRecurrenceRangeOptions
diff --git a/api/PnP.Core.Model.Teams.EventUpdateOptions.html b/api/PnP.Core.Model.Teams.EventUpdateOptions.html index 51ffddff24..51aecda85f 100644 --- a/api/PnP.Core.Model.Teams.EventUpdateOptions.html +++ b/api/PnP.Core.Model.Teams.EventUpdateOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
EventUpdateOptions
diff --git a/api/PnP.Core.Model.Teams.ITeamChannel.html b/api/PnP.Core.Model.Teams.ITeamChannel.html index 96c38c4c44..47a1701d1d 100644 --- a/api/PnP.Core.Model.Teams.ITeamChannel.html +++ b/api/PnP.Core.Model.Teams.ITeamChannel.html @@ -721,7 +721,7 @@
Parameters
- Expression<Func<IFolder, Object>>[] + Expression<Func<IFolder, System.Object>>[] expressions

Properties of the folder to load

@@ -777,7 +777,7 @@
Parameters
- Expression<Func<IFolder, Object>>[] + Expression<Func<IFolder, System.Object>>[] expressions

Properties of the folder to load

diff --git a/api/PnP.Core.Model.Teams.ITeamChannelCollection.html b/api/PnP.Core.Model.Teams.ITeamChannelCollection.html index 93b05087cd..7cafee85d8 100644 --- a/api/PnP.Core.Model.Teams.ITeamChannelCollection.html +++ b/api/PnP.Core.Model.Teams.ITeamChannelCollection.html @@ -986,7 +986,7 @@
Parameters
- Expression<Func<ITeamChannel, Object>>[] + Expression<Func<ITeamChannel, System.Object>>[] selectors

The expressions declaring the fields to select

@@ -1050,7 +1050,7 @@
Parameters
- Expression<Func<ITeamChannel, Object>>[] + Expression<Func<ITeamChannel, System.Object>>[] selectors

The expressions declaring the fields to select

diff --git a/api/PnP.Core.Model.Teams.TeamChannelOptions.html b/api/PnP.Core.Model.Teams.TeamChannelOptions.html index 37ca5b0dc4..36de361f9c 100644 --- a/api/PnP.Core.Model.Teams.TeamChannelOptions.html +++ b/api/PnP.Core.Model.Teams.TeamChannelOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
TeamChannelOptions
diff --git a/api/PnP.Core.Model.Teams.TeamChannelTabConstants.html b/api/PnP.Core.Model.Teams.TeamChannelTabConstants.html index a273b85dfb..ea40e7f9da 100644 --- a/api/PnP.Core.Model.Teams.TeamChannelTabConstants.html +++ b/api/PnP.Core.Model.Teams.TeamChannelTabConstants.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
TeamChannelTabConstants
diff --git a/api/PnP.Core.Model.Teams.TeamTagOptions.html b/api/PnP.Core.Model.Teams.TeamTagOptions.html index 24669ca3f1..7007675972 100644 --- a/api/PnP.Core.Model.Teams.TeamTagOptions.html +++ b/api/PnP.Core.Model.Teams.TeamTagOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
TeamTagOptions
diff --git a/api/PnP.Core.Model.Teams.TeamTagUserOptions.html b/api/PnP.Core.Model.Teams.TeamTagUserOptions.html index 13c751f0d5..bc3b09c66c 100644 --- a/api/PnP.Core.Model.Teams.TeamTagUserOptions.html +++ b/api/PnP.Core.Model.Teams.TeamTagUserOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
TeamTagUserOptions
diff --git a/api/PnP.Core.Model.TransientDictionary.html b/api/PnP.Core.Model.TransientDictionary.html index e53022271b..59a0d47c3c 100644 --- a/api/PnP.Core.Model.TransientDictionary.html +++ b/api/PnP.Core.Model.TransientDictionary.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
TransientDictionary
@@ -197,7 +197,7 @@
Property Value
@@ -247,7 +247,7 @@
Parameters
- Object + System.Object

- Object + System.Object value

Value of the item to add

diff --git a/api/PnP.Core.PnPException.html b/api/PnP.Core.PnPException.html index 7f9a71e5c1..e5bdcba967 100644 --- a/api/PnP.Core.PnPException.html +++ b/api/PnP.Core.PnPException.html @@ -91,7 +91,7 @@

Class PnPExcepti
Inheritance
-
Object
+
System.Object
PnPException
diff --git a/api/PnP.Core.QueryModel.BaseDataModelExtensions.html b/api/PnP.Core.QueryModel.BaseDataModelExtensions.html index baae5be37c..7c2a78e16e 100644 --- a/api/PnP.Core.QueryModel.BaseDataModelExtensions.html +++ b/api/PnP.Core.QueryModel.BaseDataModelExtensions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
BaseDataModelExtensions
diff --git a/api/PnP.Core.QueryModel.BaseQueryProvider.html b/api/PnP.Core.QueryModel.BaseQueryProvider.html index c75d2d5ba8..caa3f6490d 100644 --- a/api/PnP.Core.QueryModel.BaseQueryProvider.html +++ b/api/PnP.Core.QueryModel.BaseQueryProvider.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
BaseQueryProvider
@@ -408,7 +408,7 @@
Returns
@@ -613,7 +613,7 @@
Returns
- Object + System.Object

diff --git a/api/PnP.Core.QueryModel.FilterItem.html b/api/PnP.Core.QueryModel.FilterItem.html index db77e512ec..e20ce92151 100644 --- a/api/PnP.Core.QueryModel.FilterItem.html +++ b/api/PnP.Core.QueryModel.FilterItem.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ODataFilter
FilterItem
@@ -237,7 +237,7 @@
Property Value
- Task<Object> + Task<System.Object>

diff --git a/api/PnP.Core.QueryModel.FiltersGroup.html b/api/PnP.Core.QueryModel.FiltersGroup.html index 3a2dd0bbee..813e9677a6 100644 --- a/api/PnP.Core.QueryModel.FiltersGroup.html +++ b/api/PnP.Core.QueryModel.FiltersGroup.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ODataFilter
FiltersGroup
diff --git a/api/PnP.Core.QueryModel.ODataFilter.html b/api/PnP.Core.QueryModel.ODataFilter.html index 8b3516a2f1..7e58579d10 100644 --- a/api/PnP.Core.QueryModel.ODataFilter.html +++ b/api/PnP.Core.QueryModel.ODataFilter.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ODataFilter
diff --git a/api/PnP.Core.QueryModel.OrderByItem.html b/api/PnP.Core.QueryModel.OrderByItem.html index 13bc49d53c..7d2a5f12f9 100644 --- a/api/PnP.Core.QueryModel.OrderByItem.html +++ b/api/PnP.Core.QueryModel.OrderByItem.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
OrderByItem
diff --git a/api/PnP.Core.QueryModel.QueryableExtensions.html b/api/PnP.Core.QueryModel.QueryableExtensions.html index 87a40feef7..03807faa9e 100644 --- a/api/PnP.Core.QueryModel.QueryableExtensions.html +++ b/api/PnP.Core.QueryModel.QueryableExtensions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
QueryableExtensions
@@ -971,7 +971,7 @@
Parameters
- Object + System.Object

- Expression<Func<TResult, Object>>[] + Expression<Func<TResult, System.Object>>[] selectors

An array of selectors for the fields/metadata

@@ -1045,7 +1045,7 @@
Parameters
- Expression<Func<TResult, Object>>[] + Expression<Func<TResult, System.Object>>[] selectors

A selector for a field/metadata

diff --git a/api/PnP.Core.ServiceError.html b/api/PnP.Core.ServiceError.html index 7848bf94ce..263e8a4d49 100644 --- a/api/PnP.Core.ServiceError.html +++ b/api/PnP.Core.ServiceError.html @@ -91,7 +91,7 @@

Class ServiceErr
Inheritance
-
Object
+
System.Object
BaseError
ServiceError
diff --git a/api/PnP.Core.ServiceException.html b/api/PnP.Core.ServiceException.html index 37c8217cfd..4a0678d3ed 100644 --- a/api/PnP.Core.ServiceException.html +++ b/api/PnP.Core.ServiceException.html @@ -91,7 +91,7 @@

Class Se
Inheritance
-
Object
+
System.Object
PnPException
ServiceException
diff --git a/api/PnP.Core.Services.ApiRequest.html b/api/PnP.Core.Services.ApiRequest.html index f0e6b1b9ae..2a5416f78b 100644 --- a/api/PnP.Core.Services.ApiRequest.html +++ b/api/PnP.Core.Services.ApiRequest.html @@ -91,7 +91,7 @@

Cl
Inheritance
-
Object
+
System.Object
ApiRequest
diff --git a/api/PnP.Core.Services.ApiRequestResponse.html b/api/PnP.Core.Services.ApiRequestResponse.html index 64e268d056..667f968c53 100644 --- a/api/PnP.Core.Services.ApiRequestResponse.html +++ b/api/PnP.Core.Services.ApiRequestResponse.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
ApiRequestResponse
diff --git a/api/PnP.Core.Services.Batch.html b/api/PnP.Core.Services.Batch.html index 1baed15af7..ec21fd3d2a 100644 --- a/api/PnP.Core.Services.Batch.html +++ b/api/PnP.Core.Services.Batch.html @@ -91,7 +91,7 @@

Class Batch
Inheritance
-
Object
+
System.Object
Batch
diff --git a/api/PnP.Core.Services.BatchRequest.html b/api/PnP.Core.Services.BatchRequest.html index e5a8b6b23c..b844460472 100644 --- a/api/PnP.Core.Services.BatchRequest.html +++ b/api/PnP.Core.Services.BatchRequest.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
BatchRequest
diff --git a/api/PnP.Core.Services.BatchResult.html b/api/PnP.Core.Services.BatchResult.html index 517f9f9f6b..a44c5d6be7 100644 --- a/api/PnP.Core.Services.BatchResult.html +++ b/api/PnP.Core.Services.BatchResult.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
BatchResult
diff --git a/api/PnP.Core.Services.BatchResultValue-1.html b/api/PnP.Core.Services.BatchResultValue-1.html index 777de72e08..785c47e3e1 100644 --- a/api/PnP.Core.Services.BatchResultValue-1.html +++ b/api/PnP.Core.Services.BatchResultValue-1.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
BatchResultValue<T>
diff --git a/api/PnP.Core.Services.Builder.Configuration.PnPCoreContextOptions.html b/api/PnP.Core.Services.Builder.Configuration.PnPCoreContextOptions.html index c15710bca7..8a69e104ac 100644 --- a/api/PnP.Core.Services.Builder.Configuration.PnPCoreContextOptions.html +++ b/api/PnP.Core.Services.Builder.Configuration.PnPCoreContextOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreContextOptions
diff --git a/api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsAzureActiveDirectoryOptions.html b/api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsAzureActiveDirectoryOptions.html index 73d261d8ff..dc49038cb5 100644 --- a/api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsAzureActiveDirectoryOptions.html +++ b/api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsAzureActiveDirectoryOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreHttpRequestsAzureActiveDirectoryOptions
diff --git a/api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsGraphOptions.html b/api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsGraphOptions.html index ee39f0eb89..3ed5d3297d 100644 --- a/api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsGraphOptions.html +++ b/api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsGraphOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreHttpRequestsGraphOptions
diff --git a/api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsOptions.html b/api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsOptions.html index 4008c8fe44..8db9d775bc 100644 --- a/api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsOptions.html +++ b/api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreHttpRequestsOptions
diff --git a/api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsSharePointRestOptions.html b/api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsSharePointRestOptions.html index f2ecac789e..c7059b434d 100644 --- a/api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsSharePointRestOptions.html +++ b/api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsSharePointRestOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreHttpRequestsSharePointRestOptions
diff --git a/api/PnP.Core.Services.Builder.Configuration.PnPCoreOptions.html b/api/PnP.Core.Services.Builder.Configuration.PnPCoreOptions.html index 45f5f4c0af..84d010efbb 100644 --- a/api/PnP.Core.Services.Builder.Configuration.PnPCoreOptions.html +++ b/api/PnP.Core.Services.Builder.Configuration.PnPCoreOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreOptions
diff --git a/api/PnP.Core.Services.Builder.Configuration.PnPCoreSiteOptions.html b/api/PnP.Core.Services.Builder.Configuration.PnPCoreSiteOptions.html index b1f1ca9e28..ac41e315cd 100644 --- a/api/PnP.Core.Services.Builder.Configuration.PnPCoreSiteOptions.html +++ b/api/PnP.Core.Services.Builder.Configuration.PnPCoreSiteOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreSiteOptions
diff --git a/api/PnP.Core.Services.Builder.Configuration.PnPCoreSitesOptions.html b/api/PnP.Core.Services.Builder.Configuration.PnPCoreSitesOptions.html index 4d4d14443f..122c0f4032 100644 --- a/api/PnP.Core.Services.Builder.Configuration.PnPCoreSitesOptions.html +++ b/api/PnP.Core.Services.Builder.Configuration.PnPCoreSitesOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreSitesOptions
diff --git a/api/PnP.Core.Services.Builder.PnPCoreBuilder.html b/api/PnP.Core.Services.Builder.PnPCoreBuilder.html index 34b89abdda..182e55f639 100644 --- a/api/PnP.Core.Services.Builder.PnPCoreBuilder.html +++ b/api/PnP.Core.Services.Builder.PnPCoreBuilder.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPCoreBuilder
diff --git a/api/PnP.Core.Services.EventHub.html b/api/PnP.Core.Services.EventHub.html index 96df0d0140..ad3e339bed 100644 --- a/api/PnP.Core.Services.EventHub.html +++ b/api/PnP.Core.Services.EventHub.html @@ -91,7 +91,7 @@

Class
Inheritance
-
Object
+
System.Object
EventHub
diff --git a/api/PnP.Core.Services.FromJson.html b/api/PnP.Core.Services.FromJson.html index 0170e287e4..f8069345c1 100644 --- a/api/PnP.Core.Services.FromJson.html +++ b/api/PnP.Core.Services.FromJson.html @@ -91,7 +91,7 @@

Class
Inheritance
-
Object
+
System.Object
FromJson
diff --git a/api/PnP.Core.Services.IPnPContext.html b/api/PnP.Core.Services.IPnPContext.html index da1bec73a1..3ef94ea836 100644 --- a/api/PnP.Core.Services.IPnPContext.html +++ b/api/PnP.Core.Services.IPnPContext.html @@ -709,7 +709,7 @@

Property Value
diff --git a/api/PnP.Core.Services.IPnPContextExtensionsImplementation.html b/api/PnP.Core.Services.IPnPContextExtensionsImplementation.html index 1b3cda7a13..7e86ac1dd0 100644 --- a/api/PnP.Core.Services.IPnPContextExtensionsImplementation.html +++ b/api/PnP.Core.Services.IPnPContextExtensionsImplementation.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
IPnPContextExtensionsImplementation
diff --git a/api/PnP.Core.Services.IRateLimitEvent.html b/api/PnP.Core.Services.IRateLimitEvent.html index f6ac9be101..f896e0494d 100644 --- a/api/PnP.Core.Services.IRateLimitEvent.html +++ b/api/PnP.Core.Services.IRateLimitEvent.html @@ -181,7 +181,7 @@
Property Value
- IDictionary<String, Object> + IDictionary<String, System.Object>

diff --git a/api/PnP.Core.Services.IRetryEvent.html b/api/PnP.Core.Services.IRetryEvent.html index 1ed09ba6fa..15d3188448 100644 --- a/api/PnP.Core.Services.IRetryEvent.html +++ b/api/PnP.Core.Services.IRetryEvent.html @@ -225,7 +225,7 @@
Property Value
- IDictionary<String, Object> + IDictionary<String, System.Object>

diff --git a/api/PnP.Core.Services.MicrosoftGraphClient.html b/api/PnP.Core.Services.MicrosoftGraphClient.html index 30b316619c..60d2c0175f 100644 --- a/api/PnP.Core.Services.MicrosoftGraphClient.html +++ b/api/PnP.Core.Services.MicrosoftGraphClient.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
MicrosoftGraphClient
diff --git a/api/PnP.Core.Services.PnPContext.html b/api/PnP.Core.Services.PnPContext.html index b676bd85be..c509f09099 100644 --- a/api/PnP.Core.Services.PnPContext.html +++ b/api/PnP.Core.Services.PnPContext.html @@ -91,7 +91,7 @@

Cl
Inheritance
-
Object
+
System.Object
PnPContext
@@ -784,7 +784,7 @@

Property Value
- IDictionary<String, Object> + IDictionary<String, System.Object>

diff --git a/api/PnP.Core.Services.PnPContextExtensions.html b/api/PnP.Core.Services.PnPContextExtensions.html index 3682328e54..dbe7a88c5c 100644 --- a/api/PnP.Core.Services.PnPContextExtensions.html +++ b/api/PnP.Core.Services.PnPContextExtensions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPContextExtensions
diff --git a/api/PnP.Core.Services.PnPContextFactory.html b/api/PnP.Core.Services.PnPContextFactory.html index 5357a25940..777adfc4c0 100644 --- a/api/PnP.Core.Services.PnPContextFactory.html +++ b/api/PnP.Core.Services.PnPContextFactory.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPContextFactory
diff --git a/api/PnP.Core.Services.PnPContextFactoryCollectionExtensions.html b/api/PnP.Core.Services.PnPContextFactoryCollectionExtensions.html index 0d521b7f0d..cc0145cc06 100644 --- a/api/PnP.Core.Services.PnPContextFactoryCollectionExtensions.html +++ b/api/PnP.Core.Services.PnPContextFactoryCollectionExtensions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPContextFactoryCollectionExtensions
diff --git a/api/PnP.Core.Services.PnPContextFactoryOptions.html b/api/PnP.Core.Services.PnPContextFactoryOptions.html index 94ff89b7a1..ce388cb478 100644 --- a/api/PnP.Core.Services.PnPContextFactoryOptions.html +++ b/api/PnP.Core.Services.PnPContextFactoryOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPContextFactoryOptions
diff --git a/api/PnP.Core.Services.PnPContextFactoryOptionsConfiguration.html b/api/PnP.Core.Services.PnPContextFactoryOptionsConfiguration.html index 88846fe1d1..9436044a13 100644 --- a/api/PnP.Core.Services.PnPContextFactoryOptionsConfiguration.html +++ b/api/PnP.Core.Services.PnPContextFactoryOptionsConfiguration.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPContextFactoryOptionsConfiguration
diff --git a/api/PnP.Core.Services.PnPContextOptions.html b/api/PnP.Core.Services.PnPContextOptions.html index 26d9f65006..635fe2d3fc 100644 --- a/api/PnP.Core.Services.PnPContextOptions.html +++ b/api/PnP.Core.Services.PnPContextOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPContextOptions
@@ -142,7 +142,7 @@
Property Value
- IDictionary<String, Object> + IDictionary<String, System.Object>

@@ -186,7 +186,7 @@
Property Value
- IEnumerable<Expression<Func<ISite, Object>>> + IEnumerable<Expression<Func<ISite, System.Object>>>

@@ -230,7 +230,7 @@
Property Value
- IEnumerable<Expression<Func<IWeb, Object>>> + IEnumerable<Expression<Func<IWeb, System.Object>>>

diff --git a/api/PnP.Core.Services.PnPGlobalSettingsOptions.html b/api/PnP.Core.Services.PnPGlobalSettingsOptions.html index 508e85f471..ce977cfa7a 100644 --- a/api/PnP.Core.Services.PnPGlobalSettingsOptions.html +++ b/api/PnP.Core.Services.PnPGlobalSettingsOptions.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPGlobalSettingsOptions
diff --git a/api/PnP.Core.Services.RateLimitEvent.html b/api/PnP.Core.Services.RateLimitEvent.html index 2ed9c7246f..095fe50d61 100644 --- a/api/PnP.Core.Services.RateLimitEvent.html +++ b/api/PnP.Core.Services.RateLimitEvent.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
RateLimitEvent
@@ -244,7 +244,7 @@
Property Value
- IDictionary<String, Object> + IDictionary<String, System.Object>

diff --git a/api/PnP.Core.Services.RetryEvent.html b/api/PnP.Core.Services.RetryEvent.html index f92c1687ec..a14dd9e438 100644 --- a/api/PnP.Core.Services.RetryEvent.html +++ b/api/PnP.Core.Services.RetryEvent.html @@ -91,7 +91,7 @@

Cl
Inheritance
-
Object
+
System.Object
RetryEvent
@@ -306,7 +306,7 @@

Property Value
- IDictionary<String, Object> + IDictionary<String, System.Object>

diff --git a/api/PnP.Core.Services.SharePointRestClient.html b/api/PnP.Core.Services.SharePointRestClient.html index 700de9715e..27bb0991ac 100644 --- a/api/PnP.Core.Services.SharePointRestClient.html +++ b/api/PnP.Core.Services.SharePointRestClient.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
SharePointRestClient
diff --git a/api/PnP.Core.SharePointRestError.html b/api/PnP.Core.SharePointRestError.html index 77f8776200..a2fc980510 100644 --- a/api/PnP.Core.SharePointRestError.html +++ b/api/PnP.Core.SharePointRestError.html @@ -91,7 +91,7 @@

Cl
Inheritance
-
Object
+
System.Object
BaseError
ServiceError
SharePointRestError
diff --git a/api/PnP.Core.SharePointRestServiceException.html b/api/PnP.Core.SharePointRestServiceException.html index c54d426917..a73a914fd6 100644 --- a/api/PnP.Core.SharePointRestServiceException.html +++ b/api/PnP.Core.SharePointRestServiceException.html @@ -91,7 +91,7 @@

Inheritance
-
Object
+
System.Object
PnPException
ServiceException
SharePointRestServiceException
diff --git a/index.json b/index.json index 6f38bb8090..7420ee6a2a 100644 --- a/index.json +++ b/index.json @@ -7,7 +7,7 @@ "api/Microsoft.Extensions.DependencyInjection.AuthenticationCollectionExtensions.html": { "href": "api/Microsoft.Extensions.DependencyInjection.AuthenticationCollectionExtensions.html", "title": "Class AuthenticationCollectionExtensions | PnP Core SDK", - "keywords": "Class AuthenticationCollectionExtensions Extension methods to assist with setting up the IAuthenticationProvider infrastructure Inheritance Object AuthenticationCollectionExtensions Namespace : Microsoft.Extensions.DependencyInjection Assembly : PnP.Core.Auth.dll Syntax public static class AuthenticationCollectionExtensions : object Methods AddPnPCoreAuthentication(IServiceCollection) Adds all the IAuthenticationProvider flavors to the collection of loaded services Declaration public static IServiceCollection AddPnPCoreAuthentication(this IServiceCollection collection) Parameters IServiceCollection collection Collection of loaded services Returns IServiceCollection Collection of loaded services AddPnPCoreAuthentication(IServiceCollection, Action) Adds all the IAuthenticationProvider flavors to the collection of loaded services Declaration public static IServiceCollection AddPnPCoreAuthentication(this IServiceCollection collection, Action options) Parameters IServiceCollection collection Collection of loaded services Action < PnPCoreAuthenticationOptions > options PnPCoreAuthenticationOptions options to use for configuration Returns IServiceCollection Collection of loaded services" + "keywords": "Class AuthenticationCollectionExtensions Extension methods to assist with setting up the IAuthenticationProvider infrastructure Inheritance System.Object AuthenticationCollectionExtensions Namespace : Microsoft.Extensions.DependencyInjection Assembly : PnP.Core.Auth.dll Syntax public static class AuthenticationCollectionExtensions : object Methods AddPnPCoreAuthentication(IServiceCollection) Adds all the IAuthenticationProvider flavors to the collection of loaded services Declaration public static IServiceCollection AddPnPCoreAuthentication(this IServiceCollection collection) Parameters IServiceCollection collection Collection of loaded services Returns IServiceCollection Collection of loaded services AddPnPCoreAuthentication(IServiceCollection, Action) Adds all the IAuthenticationProvider flavors to the collection of loaded services Declaration public static IServiceCollection AddPnPCoreAuthentication(this IServiceCollection collection, Action options) Parameters IServiceCollection collection Collection of loaded services Action < PnPCoreAuthenticationOptions > options PnPCoreAuthenticationOptions options to use for configuration Returns IServiceCollection Collection of loaded services" }, "api/Microsoft.Extensions.DependencyInjection.html": { "href": "api/Microsoft.Extensions.DependencyInjection.html", @@ -17,12 +17,12 @@ "api/Microsoft.Extensions.DependencyInjection.PnPCoreServiceCollectionExtensions.html": { "href": "api/Microsoft.Extensions.DependencyInjection.PnPCoreServiceCollectionExtensions.html", "title": "Class PnPCoreServiceCollectionExtensions | PnP Core SDK", - "keywords": "Class PnPCoreServiceCollectionExtensions Extension methods for setting up PnP Core SDK services in an . Inheritance Object PnPCoreServiceCollectionExtensions Namespace : Microsoft.Extensions.DependencyInjection Assembly : PnP.Core.dll Syntax public static class PnPCoreServiceCollectionExtensions : object Methods AddPnPCore(IServiceCollection) Configures PnP Core SDK with default options Declaration public static IPnPCoreBuilder AddPnPCore(this IServiceCollection services) Parameters IServiceCollection services The collection of services in an Returns IPnPCoreBuilder A PnPCoreBuilder instance AddPnPCore(IServiceCollection, Action) Configures PnP Core SDK with custom options Declaration public static IPnPCoreBuilder AddPnPCore(this IServiceCollection services, Action options) Parameters IServiceCollection services The collection of services in an Action < PnPCoreOptions > options An Action to configure the PnP Core options Returns IPnPCoreBuilder A PnPCoreBuilder instance" + "keywords": "Class PnPCoreServiceCollectionExtensions Extension methods for setting up PnP Core SDK services in an . Inheritance System.Object PnPCoreServiceCollectionExtensions Namespace : Microsoft.Extensions.DependencyInjection Assembly : PnP.Core.dll Syntax public static class PnPCoreServiceCollectionExtensions : object Methods AddPnPCore(IServiceCollection) Configures PnP Core SDK with default options Declaration public static IPnPCoreBuilder AddPnPCore(this IServiceCollection services) Parameters IServiceCollection services The collection of services in an Returns IPnPCoreBuilder A PnPCoreBuilder instance AddPnPCore(IServiceCollection, Action) Configures PnP Core SDK with custom options Declaration public static IPnPCoreBuilder AddPnPCore(this IServiceCollection services, Action options) Parameters IServiceCollection services The collection of services in an Action < PnPCoreOptions > options An Action to configure the PnP Core options Returns IPnPCoreBuilder A PnPCoreBuilder instance" }, "api/PnP.Core.Admin.Model.Microsoft365.CreationOptions.html": { "href": "api/PnP.Core.Admin.Model.Microsoft365.CreationOptions.html", "title": "Class CreationOptions | PnP Core SDK", - "keywords": "Class CreationOptions Options to control a creation flow Inheritance Object CreationOptions Namespace : PnP.Core.Admin.Model.Microsoft365 Assembly : PnP.Core.Admin.dll Syntax public class CreationOptions : object Properties MaxStatusChecks Number of times to check for provisioning complete status. Defaults to 10 if not set. Declaration public int? MaxStatusChecks { get; set; } Property Value Nullable < Int32 > WaitAfterStatusCheck Defines the wait time in seconds after a status check. Defaults to 1 if not set. Declaration public int? WaitAfterStatusCheck { get; set; } Property Value Nullable < Int32 >" + "keywords": "Class CreationOptions Options to control a creation flow Inheritance System.Object CreationOptions Namespace : PnP.Core.Admin.Model.Microsoft365 Assembly : PnP.Core.Admin.dll Syntax public class CreationOptions : object Properties MaxStatusChecks Number of times to check for provisioning complete status. Defaults to 10 if not set. Declaration public int? MaxStatusChecks { get; set; } Property Value Nullable < Int32 > WaitAfterStatusCheck Defines the wait time in seconds after a status check. Defaults to 1 if not set. Declaration public int? WaitAfterStatusCheck { get; set; } Property Value Nullable < Int32 >" }, "api/PnP.Core.Admin.Model.Microsoft365.GeoLocation.html": { "href": "api/PnP.Core.Admin.Model.Microsoft365.GeoLocation.html", @@ -32,7 +32,7 @@ "api/PnP.Core.Admin.Model.Microsoft365.GraphGroupOptions.html": { "href": "api/PnP.Core.Admin.Model.Microsoft365.GraphGroupOptions.html", "title": "Class GraphGroupOptions | PnP Core SDK", - "keywords": "Class GraphGroupOptions Contains the available options for creating a group with Graph Api Inheritance Object GraphGroupOptions Namespace : PnP.Core.Admin.Model.Microsoft365 Assembly : PnP.Core.Admin.dll Syntax public class GraphGroupOptions : object Properties Classification Classification of this group Declaration public string Classification { get; set; } Property Value String CreationOptions Allows defining creation options for SharePoint Site Creation Declaration public List CreationOptions { get; set; } Property Value List < String > Description Description of the Microsoft 365 Group Declaration public string Description { get; set; } Property Value String DisplayName Name of the Microsoft 365 Group Declaration public string DisplayName { get; set; } Property Value String GroupTypes Group types Declaration public List GroupTypes { get; } Property Value List < String > MailEnabled Is this group mail enabled Declaration public bool MailEnabled { get; set; } Property Value Boolean MailNickname Mail nickname of this Microsoft 365 group Declaration public string MailNickname { get; set; } Property Value String Members Members data, list of UPN's of the users who need to be added as owner Declaration public string[] Members { get; set; } Property Value String [] Owners Owners data, list of UPN's of the users who need to be added as owner Declaration public string[] Owners { get; set; } Property Value String [] PreferredDataLocation Preferred data location Declaration public string PreferredDataLocation { get; set; } Property Value String ResourceBehaviorOptions Allows defining the resource behavior options for the group See https://learn.microsoft.com/en-us/graph/group-set-options#configure-groups Declaration public List ResourceBehaviorOptions { get; set; } Property Value List < String > SecurityEnabled If it is a security enabled group Declaration public bool SecurityEnabled { get; } Property Value Boolean Visibility Visibility of this group Declaration public string Visibility { get; set; } Property Value String" + "keywords": "Class GraphGroupOptions Contains the available options for creating a group with Graph Api Inheritance System.Object GraphGroupOptions Namespace : PnP.Core.Admin.Model.Microsoft365 Assembly : PnP.Core.Admin.dll Syntax public class GraphGroupOptions : object Properties Classification Classification of this group Declaration public string Classification { get; set; } Property Value String CreationOptions Allows defining creation options for SharePoint Site Creation Declaration public List CreationOptions { get; set; } Property Value List < String > Description Description of the Microsoft 365 Group Declaration public string Description { get; set; } Property Value String DisplayName Name of the Microsoft 365 Group Declaration public string DisplayName { get; set; } Property Value String GroupTypes Group types Declaration public List GroupTypes { get; } Property Value List < String > MailEnabled Is this group mail enabled Declaration public bool MailEnabled { get; set; } Property Value Boolean MailNickname Mail nickname of this Microsoft 365 group Declaration public string MailNickname { get; set; } Property Value String Members Members data, list of UPN's of the users who need to be added as owner Declaration public string[] Members { get; set; } Property Value String [] Owners Owners data, list of UPN's of the users who need to be added as owner Declaration public string[] Owners { get; set; } Property Value String [] PreferredDataLocation Preferred data location Declaration public string PreferredDataLocation { get; set; } Property Value String ResourceBehaviorOptions Allows defining the resource behavior options for the group See https://learn.microsoft.com/en-us/graph/group-set-options#configure-groups Declaration public List ResourceBehaviorOptions { get; set; } Property Value List < String > SecurityEnabled If it is a security enabled group Declaration public bool SecurityEnabled { get; } Property Value Boolean Visibility Visibility of this group Declaration public string Visibility { get; set; } Property Value String" }, "api/PnP.Core.Admin.Model.Microsoft365.html": { "href": "api/PnP.Core.Admin.Model.Microsoft365.html", @@ -72,7 +72,7 @@ "api/PnP.Core.Admin.Model.SharePoint.ClassicSiteOptions.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.ClassicSiteOptions.html", "title": "Class ClassicSiteOptions | PnP Core SDK", - "keywords": "Class ClassicSiteOptions Contains the available options for creating a classic site collection (e.g. classic team site) Inheritance Object CommonSiteOptions ClassicSiteOptions Inherited Members CommonSiteOptions.Language CommonSiteOptions.WebTemplate Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public class ClassicSiteOptions : CommonSiteOptions Constructors ClassicSiteOptions(Uri, String, String, String, Language, TimeZone) Default constuctor for creating a ClassicSiteOptions object used to define a classic site collection creation Declaration public ClassicSiteOptions(Uri url, string title, string webTemplate, string siteOwnerLogin, Language language, TimeZone timeZone) Parameters Uri url Url of the classic site collection to create String title Title of the classic site collection to create String webTemplate Web template of the classic site collection to create String siteOwnerLogin Owner of the classic site collection to create Language language Language to use for the site TimeZone timeZone Time zone of the classic site collection to create Properties Owner Owner of the classic site Declaration public string Owner { get; set; } Property Value String TimeZone Time zone id for the classic site Declaration public TimeZone TimeZone { get; set; } Property Value TimeZone Title Title of the classic site Declaration public string Title { get; set; } Property Value String Url Url of the classic site Declaration public Uri Url { get; set; } Property Value Uri" + "keywords": "Class ClassicSiteOptions Contains the available options for creating a classic site collection (e.g. classic team site) Inheritance System.Object CommonSiteOptions ClassicSiteOptions Inherited Members CommonSiteOptions.Language CommonSiteOptions.WebTemplate Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public class ClassicSiteOptions : CommonSiteOptions Constructors ClassicSiteOptions(Uri, String, String, String, Language, TimeZone) Default constuctor for creating a ClassicSiteOptions object used to define a classic site collection creation Declaration public ClassicSiteOptions(Uri url, string title, string webTemplate, string siteOwnerLogin, Language language, TimeZone timeZone) Parameters Uri url Url of the classic site collection to create String title Title of the classic site collection to create String webTemplate Web template of the classic site collection to create String siteOwnerLogin Owner of the classic site collection to create Language language Language to use for the site TimeZone timeZone Time zone of the classic site collection to create Properties Owner Owner of the classic site Declaration public string Owner { get; set; } Property Value String TimeZone Time zone id for the classic site Declaration public TimeZone TimeZone { get; set; } Property Value TimeZone Title Title of the classic site Declaration public string Title { get; set; } Property Value String Url Url of the classic site Declaration public Uri Url { get; set; } Property Value Uri" }, "api/PnP.Core.Admin.Model.SharePoint.CollectionUpdateOptions.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.CollectionUpdateOptions.html", @@ -82,17 +82,17 @@ "api/PnP.Core.Admin.Model.SharePoint.CommonGroupSiteOptions.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.CommonGroupSiteOptions.html", "title": "Class CommonGroupSiteOptions | PnP Core SDK", - "keywords": "Class CommonGroupSiteOptions Generic site collection creation options that apply for all types of site collections that are backed by a Microsoft 365 group Inheritance Object CommonSiteOptions CommonGroupSiteOptions ConnectSiteToGroupOptions TeamSiteOptions Inherited Members CommonSiteOptions.Language CommonSiteOptions.WebTemplate Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public abstract class CommonGroupSiteOptions : CommonSiteOptions Constructors CommonGroupSiteOptions(String, String) Default constructor to configure the common options for group connected sites Declaration public CommonGroupSiteOptions(string alias, string displayName) Parameters String alias Alias for the group to create String displayName Display name for the group to create Properties Alias Alias of the underlying Office 365 Group Declaration public string Alias { get; set; } Property Value String Classification The Site classification to use. For instance 'Contoso Classified'. See https://www.youtube.com/watch?v=E-8Z2ggHcS0 for more information Declaration public string Classification { get; set; } Property Value String Description The description of the site to be created. Declaration public string Description { get; set; } Property Value String DisplayName The title of the site to create Declaration public string DisplayName { get; set; } Property Value String HubSiteId The Guid of the hub site to be used. If specified will associate the modern team site to the hub site. (not applicable when application permissions are used) Declaration public Guid HubSiteId { get; set; } Property Value Guid IsPublic Defines whether the Office 365 Group will be public (default), or private. Declaration public bool IsPublic { get; set; } Property Value Boolean PreferredDataLocation The geography in which to create the site collection. Only applicable to multi-geo enabled tenants Declaration public GeoLocation? PreferredDataLocation { get; set; } Property Value Nullable < GeoLocation > SensitivityLabelId The Sensitivity label to use. See https://www.youtube.com/watch?v=NxvUXBiPFcw for more information. (not applicable when application permissions are used) Declaration public Guid SensitivityLabelId { get; set; } Property Value Guid SiteAlias SiteAlias of the underlying Office 365 Group, i.e. the site part of the url: https://contoso.sharepoint.com/sites/ (not applicable when application permissions are used) Declaration public string SiteAlias { get; set; } Property Value String" + "keywords": "Class CommonGroupSiteOptions Generic site collection creation options that apply for all types of site collections that are backed by a Microsoft 365 group Inheritance System.Object CommonSiteOptions CommonGroupSiteOptions ConnectSiteToGroupOptions TeamSiteOptions Inherited Members CommonSiteOptions.Language CommonSiteOptions.WebTemplate Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public abstract class CommonGroupSiteOptions : CommonSiteOptions Constructors CommonGroupSiteOptions(String, String) Default constructor to configure the common options for group connected sites Declaration public CommonGroupSiteOptions(string alias, string displayName) Parameters String alias Alias for the group to create String displayName Display name for the group to create Properties Alias Alias of the underlying Office 365 Group Declaration public string Alias { get; set; } Property Value String Classification The Site classification to use. For instance 'Contoso Classified'. See https://www.youtube.com/watch?v=E-8Z2ggHcS0 for more information Declaration public string Classification { get; set; } Property Value String Description The description of the site to be created. Declaration public string Description { get; set; } Property Value String DisplayName The title of the site to create Declaration public string DisplayName { get; set; } Property Value String HubSiteId The Guid of the hub site to be used. If specified will associate the modern team site to the hub site. (not applicable when application permissions are used) Declaration public Guid HubSiteId { get; set; } Property Value Guid IsPublic Defines whether the Office 365 Group will be public (default), or private. Declaration public bool IsPublic { get; set; } Property Value Boolean PreferredDataLocation The geography in which to create the site collection. Only applicable to multi-geo enabled tenants Declaration public GeoLocation? PreferredDataLocation { get; set; } Property Value Nullable < GeoLocation > SensitivityLabelId The Sensitivity label to use. See https://www.youtube.com/watch?v=NxvUXBiPFcw for more information. (not applicable when application permissions are used) Declaration public Guid SensitivityLabelId { get; set; } Property Value Guid SiteAlias SiteAlias of the underlying Office 365 Group, i.e. the site part of the url: https://contoso.sharepoint.com/sites/ (not applicable when application permissions are used) Declaration public string SiteAlias { get; set; } Property Value String" }, "api/PnP.Core.Admin.Model.SharePoint.CommonNoGroupSiteOptions.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.CommonNoGroupSiteOptions.html", "title": "Class CommonNoGroupSiteOptions | PnP Core SDK", - "keywords": "Class CommonNoGroupSiteOptions Generic site collection creation options that apply for all types of site collections that are not backed by a Microsoft 365 group Inheritance Object CommonSiteOptions CommonNoGroupSiteOptions CommunicationSiteOptions TeamSiteWithoutGroupOptions Inherited Members CommonSiteOptions.Language CommonSiteOptions.WebTemplate Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public abstract class CommonNoGroupSiteOptions : CommonSiteOptions Constructors CommonNoGroupSiteOptions(Uri, String) Default constructor, sets url and title Declaration public CommonNoGroupSiteOptions(Uri url, string title) Parameters Uri url Url of the site to create String title Title of the site to create Properties Classification The Site classification to use. For instance 'Contoso Classified'. See https://www.youtube.com/watch?v=E-8Z2ggHcS0 for more information Declaration public string Classification { get; set; } Property Value String Description The description to use for the site. Declaration public string Description { get; set; } Property Value String HubSiteId The Guid of the hub site to be used. If specified will associate the communication site to the hub site Declaration public Guid HubSiteId { get; set; } Property Value Guid Owner The owner of the site. Reserved for future use. Declaration public string Owner { get; set; } Property Value String SensitivityLabelId The Sensitivity label to use. See https://www.youtube.com/watch?v=NxvUXBiPFcw for more information. Declaration public Guid SensitivityLabelId { get; set; } Property Value Guid ShareByEmailEnabled If set to true sharing files by email is enabled. Defaults to false. Declaration public bool ShareByEmailEnabled { get; set; } Property Value Boolean SiteDesignId The Guid of the site design to be used. Declaration public Guid SiteDesignId { get; set; } Property Value Guid TimeZone The time zone to use for the site. Declaration public TimeZone? TimeZone { get; set; } Property Value Nullable < TimeZone > Title The title of the site to create Declaration public string Title { get; set; } Property Value String Url The fully qualified URL (e.g. https://yourtenant.sharepoint.com/sites/mysitecollection ) of the site. Declaration public Uri Url { get; set; } Property Value Uri" + "keywords": "Class CommonNoGroupSiteOptions Generic site collection creation options that apply for all types of site collections that are not backed by a Microsoft 365 group Inheritance System.Object CommonSiteOptions CommonNoGroupSiteOptions CommunicationSiteOptions TeamSiteWithoutGroupOptions Inherited Members CommonSiteOptions.Language CommonSiteOptions.WebTemplate Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public abstract class CommonNoGroupSiteOptions : CommonSiteOptions Constructors CommonNoGroupSiteOptions(Uri, String) Default constructor, sets url and title Declaration public CommonNoGroupSiteOptions(Uri url, string title) Parameters Uri url Url of the site to create String title Title of the site to create Properties Classification The Site classification to use. For instance 'Contoso Classified'. See https://www.youtube.com/watch?v=E-8Z2ggHcS0 for more information Declaration public string Classification { get; set; } Property Value String Description The description to use for the site. Declaration public string Description { get; set; } Property Value String HubSiteId The Guid of the hub site to be used. If specified will associate the communication site to the hub site Declaration public Guid HubSiteId { get; set; } Property Value Guid Owner The owner of the site. Reserved for future use. Declaration public string Owner { get; set; } Property Value String SensitivityLabelId The Sensitivity label to use. See https://www.youtube.com/watch?v=NxvUXBiPFcw for more information. Declaration public Guid SensitivityLabelId { get; set; } Property Value Guid ShareByEmailEnabled If set to true sharing files by email is enabled. Defaults to false. Declaration public bool ShareByEmailEnabled { get; set; } Property Value Boolean SiteDesignId The Guid of the site design to be used. Declaration public Guid SiteDesignId { get; set; } Property Value Guid TimeZone The time zone to use for the site. Declaration public TimeZone? TimeZone { get; set; } Property Value Nullable < TimeZone > Title The title of the site to create Declaration public string Title { get; set; } Property Value String Url The fully qualified URL (e.g. https://yourtenant.sharepoint.com/sites/mysitecollection ) of the site. Declaration public Uri Url { get; set; } Property Value Uri" }, "api/PnP.Core.Admin.Model.SharePoint.CommonSiteOptions.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.CommonSiteOptions.html", "title": "Class CommonSiteOptions | PnP Core SDK", - "keywords": "Class CommonSiteOptions Generic site collection creation options that apply for all types of site collections Inheritance Object CommonSiteOptions ClassicSiteOptions CommonGroupSiteOptions CommonNoGroupSiteOptions Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public abstract class CommonSiteOptions : object Properties Language The language to use for the site. Declaration public Language Language { get; set; } Property Value Language WebTemplate The Web template to use for the site. Declaration public string WebTemplate { get; protected set; } Property Value String" + "keywords": "Class CommonSiteOptions Generic site collection creation options that apply for all types of site collections Inheritance System.Object CommonSiteOptions ClassicSiteOptions CommonGroupSiteOptions CommonNoGroupSiteOptions Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public abstract class CommonSiteOptions : object Properties Language The language to use for the site. Declaration public Language Language { get; set; } Property Value Language WebTemplate The Web template to use for the site. Declaration public string WebTemplate { get; protected set; } Property Value String" }, "api/PnP.Core.Admin.Model.SharePoint.CommunicationSiteDesign.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.CommunicationSiteDesign.html", @@ -102,7 +102,7 @@ "api/PnP.Core.Admin.Model.SharePoint.CommunicationSiteOptions.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.CommunicationSiteOptions.html", "title": "Class CommunicationSiteOptions | PnP Core SDK", - "keywords": "Class CommunicationSiteOptions Contains the available options for creating a communication site collection Inheritance Object CommonSiteOptions CommonNoGroupSiteOptions CommunicationSiteOptions Inherited Members CommonNoGroupSiteOptions.Url CommonNoGroupSiteOptions.Title CommonNoGroupSiteOptions.Owner CommonNoGroupSiteOptions.ShareByEmailEnabled CommonNoGroupSiteOptions.Classification CommonNoGroupSiteOptions.Description CommonNoGroupSiteOptions.SiteDesignId CommonNoGroupSiteOptions.HubSiteId CommonNoGroupSiteOptions.SensitivityLabelId CommonNoGroupSiteOptions.TimeZone CommonSiteOptions.Language CommonSiteOptions.WebTemplate Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public class CommunicationSiteOptions : CommonNoGroupSiteOptions Constructors CommunicationSiteOptions(Uri, String) Default constuctor for creating a CommunicationSiteOptions object used to define a communication site collection creation Declaration public CommunicationSiteOptions(Uri url, string title) Parameters Uri url Url of the communication site to create String title Title of the communication site to create Properties SiteDesign The built-in site design to used. If both SiteDesignId and SiteDesign have been specified, the GUID specified as SiteDesignId will be used. Declaration public CommunicationSiteDesign SiteDesign { get; set; } Property Value CommunicationSiteDesign" + "keywords": "Class CommunicationSiteOptions Contains the available options for creating a communication site collection Inheritance System.Object CommonSiteOptions CommonNoGroupSiteOptions CommunicationSiteOptions Inherited Members CommonNoGroupSiteOptions.Url CommonNoGroupSiteOptions.Title CommonNoGroupSiteOptions.Owner CommonNoGroupSiteOptions.ShareByEmailEnabled CommonNoGroupSiteOptions.Classification CommonNoGroupSiteOptions.Description CommonNoGroupSiteOptions.SiteDesignId CommonNoGroupSiteOptions.HubSiteId CommonNoGroupSiteOptions.SensitivityLabelId CommonNoGroupSiteOptions.TimeZone CommonSiteOptions.Language CommonSiteOptions.WebTemplate Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public class CommunicationSiteOptions : CommonNoGroupSiteOptions Constructors CommunicationSiteOptions(Uri, String) Default constuctor for creating a CommunicationSiteOptions object used to define a communication site collection creation Declaration public CommunicationSiteOptions(Uri url, string title) Parameters Uri url Url of the communication site to create String title Title of the communication site to create Properties SiteDesign The built-in site design to used. If both SiteDesignId and SiteDesign have been specified, the GUID specified as SiteDesignId will be used. Declaration public CommunicationSiteDesign SiteDesign { get; set; } Property Value CommunicationSiteDesign" }, "api/PnP.Core.Admin.Model.SharePoint.CompanyWideSharingLinksPolicy.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.CompanyWideSharingLinksPolicy.html", @@ -112,12 +112,12 @@ "api/PnP.Core.Admin.Model.SharePoint.ConnectSiteToGroupOptions.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.ConnectSiteToGroupOptions.html", "title": "Class ConnectSiteToGroupOptions | PnP Core SDK", - "keywords": "Class ConnectSiteToGroupOptions Defines the information need to connect a group to an existing site Inheritance Object CommonSiteOptions CommonGroupSiteOptions ConnectSiteToGroupOptions Inherited Members CommonGroupSiteOptions.Alias CommonGroupSiteOptions.DisplayName CommonGroupSiteOptions.IsPublic CommonGroupSiteOptions.Description CommonGroupSiteOptions.Classification CommonGroupSiteOptions.HubSiteId CommonGroupSiteOptions.SensitivityLabelId CommonGroupSiteOptions.SiteAlias CommonGroupSiteOptions.PreferredDataLocation CommonSiteOptions.Language CommonSiteOptions.WebTemplate Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public class ConnectSiteToGroupOptions : CommonGroupSiteOptions Constructors ConnectSiteToGroupOptions(Uri, String, String) Creates an ConnectSiteToGroupOptions class Declaration public ConnectSiteToGroupOptions(Uri url, string alias, string displayName) Parameters Uri url The url for the site to group connect String alias Alias for the group that will be connected to the site String displayName Name of the site Properties KeepOldHomePage If the site already has a modern home page, do we want to keep it? Declaration public bool KeepOldHomePage { get; set; } Property Value Boolean Owners Set the owners of the group connected site. Specify the UPN values in a string array. Declaration public string[] Owners { get; set; } Property Value String [] Url The url for the site to group connect Declaration public Uri Url { get; set; } Property Value Uri" + "keywords": "Class ConnectSiteToGroupOptions Defines the information need to connect a group to an existing site Inheritance System.Object CommonSiteOptions CommonGroupSiteOptions ConnectSiteToGroupOptions Inherited Members CommonGroupSiteOptions.Alias CommonGroupSiteOptions.DisplayName CommonGroupSiteOptions.IsPublic CommonGroupSiteOptions.Description CommonGroupSiteOptions.Classification CommonGroupSiteOptions.HubSiteId CommonGroupSiteOptions.SensitivityLabelId CommonGroupSiteOptions.SiteAlias CommonGroupSiteOptions.PreferredDataLocation CommonSiteOptions.Language CommonSiteOptions.WebTemplate Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public class ConnectSiteToGroupOptions : CommonGroupSiteOptions Constructors ConnectSiteToGroupOptions(Uri, String, String) Creates an ConnectSiteToGroupOptions class Declaration public ConnectSiteToGroupOptions(Uri url, string alias, string displayName) Parameters Uri url The url for the site to group connect String alias Alias for the group that will be connected to the site String displayName Name of the site Properties KeepOldHomePage If the site already has a modern home page, do we want to keep it? Declaration public bool KeepOldHomePage { get; set; } Property Value Boolean Owners Set the owners of the group connected site. Specify the UPN values in a string array. Declaration public string[] Owners { get; set; } Property Value String [] Url The url for the site to group connect Declaration public Uri Url { get; set; } Property Value Uri" }, "api/PnP.Core.Admin.Model.SharePoint.CreationOptions.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.CreationOptions.html", "title": "Class CreationOptions | PnP Core SDK", - "keywords": "Class CreationOptions Options to control a creation flow Inheritance Object CreationOptions SiteCreationOptions Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public class CreationOptions : object Properties MaxStatusChecks Number of times to check for provisioning complete status. Defaults to 12 if not set. Declaration public int? MaxStatusChecks { get; set; } Property Value Nullable < Int32 > UsingApplicationPermissions The provisioning code will work differently if Application permissions are used. Defaults to live checking of the current access token if not set. Declaration public bool? UsingApplicationPermissions { get; set; } Property Value Nullable < Boolean > WaitAfterStatusCheck Defines the wait time in seconds after a status check. Defaults to 10 if not set. Declaration public int? WaitAfterStatusCheck { get; set; } Property Value Nullable < Int32 >" + "keywords": "Class CreationOptions Options to control a creation flow Inheritance System.Object CreationOptions SiteCreationOptions Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public class CreationOptions : object Properties MaxStatusChecks Number of times to check for provisioning complete status. Defaults to 12 if not set. Declaration public int? MaxStatusChecks { get; set; } Property Value Nullable < Int32 > UsingApplicationPermissions The provisioning code will work differently if Application permissions are used. Defaults to live checking of the current access token if not set. Declaration public bool? UsingApplicationPermissions { get; set; } Property Value Nullable < Boolean > WaitAfterStatusCheck Defines the wait time in seconds after a status check. Defaults to 10 if not set. Declaration public int? WaitAfterStatusCheck { get; set; } Property Value Nullable < Int32 >" }, "api/PnP.Core.Admin.Model.SharePoint.DenyAddAndCustomizePagesStatus.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.DenyAddAndCustomizePagesStatus.html", @@ -367,7 +367,7 @@ "api/PnP.Core.Admin.Model.SharePoint.SiteCreationOptions.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.SiteCreationOptions.html", "title": "Class SiteCreationOptions | PnP Core SDK", - "keywords": "Class SiteCreationOptions Options to control the site collection creation flow Inheritance Object CreationOptions SiteCreationOptions Inherited Members CreationOptions.MaxStatusChecks CreationOptions.WaitAfterStatusCheck CreationOptions.UsingApplicationPermissions Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public class SiteCreationOptions : CreationOptions Properties MaxAsyncProvisioningStatusChecks Number of times to check for the async provisioning to be completed. Defaults to 80 if not set. Declaration public int? MaxAsyncProvisioningStatusChecks { get; set; } Property Value Nullable < Int32 > WaitAfterAsyncProvisioningStatusCheck Defines the wait time in seconds after an async provisioning complete check. Defaults to 15 if not set. Declaration public int? WaitAfterAsyncProvisioningStatusCheck { get; set; } Property Value Nullable < Int32 > WaitAfterCreation Defines the wait time in seconds after the site collection creation call returns. If specified this overrides the WaitForAsyncProvisioning setting. Declaration public int? WaitAfterCreation { get; set; } Property Value Nullable < Int32 > WaitForAsyncProvisioning Waits for the async provisioning options to be completed. Does not apply to classic site collection creation Declaration public bool? WaitForAsyncProvisioning { get; set; } Property Value Nullable < Boolean >" + "keywords": "Class SiteCreationOptions Options to control the site collection creation flow Inheritance System.Object CreationOptions SiteCreationOptions Inherited Members CreationOptions.MaxStatusChecks CreationOptions.WaitAfterStatusCheck CreationOptions.UsingApplicationPermissions Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public class SiteCreationOptions : CreationOptions Properties MaxAsyncProvisioningStatusChecks Number of times to check for the async provisioning to be completed. Defaults to 80 if not set. Declaration public int? MaxAsyncProvisioningStatusChecks { get; set; } Property Value Nullable < Int32 > WaitAfterAsyncProvisioningStatusCheck Defines the wait time in seconds after an async provisioning complete check. Defaults to 15 if not set. Declaration public int? WaitAfterAsyncProvisioningStatusCheck { get; set; } Property Value Nullable < Int32 > WaitAfterCreation Defines the wait time in seconds after the site collection creation call returns. If specified this overrides the WaitForAsyncProvisioning setting. Declaration public int? WaitAfterCreation { get; set; } Property Value Nullable < Int32 > WaitForAsyncProvisioning Waits for the async provisioning options to be completed. Does not apply to classic site collection creation Declaration public bool? WaitForAsyncProvisioning { get; set; } Property Value Nullable < Boolean >" }, "api/PnP.Core.Admin.Model.SharePoint.SiteUserInfoVisibilityPolicyValue.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.SiteUserInfoVisibilityPolicyValue.html", @@ -412,12 +412,12 @@ "api/PnP.Core.Admin.Model.SharePoint.TeamSiteOptions.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.TeamSiteOptions.html", "title": "Class TeamSiteOptions | PnP Core SDK", - "keywords": "Class TeamSiteOptions Contains the available options for creating a group connected team site collection Inheritance Object CommonSiteOptions CommonGroupSiteOptions TeamSiteOptions Inherited Members CommonGroupSiteOptions.Alias CommonGroupSiteOptions.DisplayName CommonGroupSiteOptions.IsPublic CommonGroupSiteOptions.Description CommonGroupSiteOptions.Classification CommonGroupSiteOptions.HubSiteId CommonGroupSiteOptions.SensitivityLabelId CommonGroupSiteOptions.SiteAlias CommonGroupSiteOptions.PreferredDataLocation CommonSiteOptions.Language CommonSiteOptions.WebTemplate Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public class TeamSiteOptions : CommonGroupSiteOptions Constructors TeamSiteOptions(String, String) Default constuctor for creating a TeamSiteOptions object used to define a team site collection creation Declaration public TeamSiteOptions(string alias, string displayName) Parameters String alias Alias for the group to create String displayName Displayname for the group to create Properties AllowOnlyMembersToPost If true, only group members can post conversations to the group. Only applies when using application permissions to create the site. Declaration public bool? AllowOnlyMembersToPost { get; set; } Property Value Nullable < Boolean > CalendarMemberReadOnly If true, members can view the group calendar in Outlook but cannot make changes. Only applies when using application permissions to create the site. Declaration public bool? CalendarMemberReadOnly { get; set; } Property Value Nullable < Boolean > ConnectorsDisabled If true, changes made to the group in Exchange Online are not synced back to on-premises Active Directory. Only applies when using application permissions to create the site. Declaration public bool? ConnectorsDisabled { get; set; } Property Value Nullable < Boolean > HideGroupInOutlook If true, this group is hidden in Outlook experiences. Only applies when using application permissions to create the site. Declaration public bool? HideGroupInOutlook { get; set; } Property Value Nullable < Boolean > Members Set the members of the team site connected group. Specify the UPN values in a string array. Note: Only applicable when application permissions are used. Declaration public string[] Members { get; set; } Property Value String [] Owners Set the owners of the team site connected group. Specify the UPN values in a string array. Declaration public string[] Owners { get; set; } Property Value String [] SiteDesignId The ID of the Site Design to apply, if any (not applicable when application permissions are used) Declaration public Guid? SiteDesignId { get; set; } Property Value Nullable < Guid > SubscribeMembersToCalendarEventsDisabled If true, members are not subscribed to the group's calendar events in Outlook. Only applies when using application permissions to create the site. Declaration public bool? SubscribeMembersToCalendarEventsDisabled { get; set; } Property Value Nullable < Boolean > SubscribeNewGroupMembers If true, group members are subscribed to receive group conversations. Only applies when using application permissions to create the site. Declaration public bool? SubscribeNewGroupMembers { get; set; } Property Value Nullable < Boolean > WelcomeEmailDisabled If true, welcome emails are not sent to new members. Only applies when using application permissions to create the site. Declaration public bool? WelcomeEmailDisabled { get; set; } Property Value Nullable < Boolean >" + "keywords": "Class TeamSiteOptions Contains the available options for creating a group connected team site collection Inheritance System.Object CommonSiteOptions CommonGroupSiteOptions TeamSiteOptions Inherited Members CommonGroupSiteOptions.Alias CommonGroupSiteOptions.DisplayName CommonGroupSiteOptions.IsPublic CommonGroupSiteOptions.Description CommonGroupSiteOptions.Classification CommonGroupSiteOptions.HubSiteId CommonGroupSiteOptions.SensitivityLabelId CommonGroupSiteOptions.SiteAlias CommonGroupSiteOptions.PreferredDataLocation CommonSiteOptions.Language CommonSiteOptions.WebTemplate Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public class TeamSiteOptions : CommonGroupSiteOptions Constructors TeamSiteOptions(String, String) Default constuctor for creating a TeamSiteOptions object used to define a team site collection creation Declaration public TeamSiteOptions(string alias, string displayName) Parameters String alias Alias for the group to create String displayName Displayname for the group to create Properties AllowOnlyMembersToPost If true, only group members can post conversations to the group. Only applies when using application permissions to create the site. Declaration public bool? AllowOnlyMembersToPost { get; set; } Property Value Nullable < Boolean > CalendarMemberReadOnly If true, members can view the group calendar in Outlook but cannot make changes. Only applies when using application permissions to create the site. Declaration public bool? CalendarMemberReadOnly { get; set; } Property Value Nullable < Boolean > ConnectorsDisabled If true, changes made to the group in Exchange Online are not synced back to on-premises Active Directory. Only applies when using application permissions to create the site. Declaration public bool? ConnectorsDisabled { get; set; } Property Value Nullable < Boolean > HideGroupInOutlook If true, this group is hidden in Outlook experiences. Only applies when using application permissions to create the site. Declaration public bool? HideGroupInOutlook { get; set; } Property Value Nullable < Boolean > Members Set the members of the team site connected group. Specify the UPN values in a string array. Note: Only applicable when application permissions are used. Declaration public string[] Members { get; set; } Property Value String [] Owners Set the owners of the team site connected group. Specify the UPN values in a string array. Declaration public string[] Owners { get; set; } Property Value String [] SiteDesignId The ID of the Site Design to apply, if any (not applicable when application permissions are used) Declaration public Guid? SiteDesignId { get; set; } Property Value Nullable < Guid > SubscribeMembersToCalendarEventsDisabled If true, members are not subscribed to the group's calendar events in Outlook. Only applies when using application permissions to create the site. Declaration public bool? SubscribeMembersToCalendarEventsDisabled { get; set; } Property Value Nullable < Boolean > SubscribeNewGroupMembers If true, group members are subscribed to receive group conversations. Only applies when using application permissions to create the site. Declaration public bool? SubscribeNewGroupMembers { get; set; } Property Value Nullable < Boolean > WelcomeEmailDisabled If true, welcome emails are not sent to new members. Only applies when using application permissions to create the site. Declaration public bool? WelcomeEmailDisabled { get; set; } Property Value Nullable < Boolean >" }, "api/PnP.Core.Admin.Model.SharePoint.TeamSiteWithoutGroupOptions.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.TeamSiteWithoutGroupOptions.html", "title": "Class TeamSiteWithoutGroupOptions | PnP Core SDK", - "keywords": "Class TeamSiteWithoutGroupOptions Contains the available options for creating a team site collection without a group Inheritance Object CommonSiteOptions CommonNoGroupSiteOptions TeamSiteWithoutGroupOptions Inherited Members CommonNoGroupSiteOptions.Url CommonNoGroupSiteOptions.Title CommonNoGroupSiteOptions.Owner CommonNoGroupSiteOptions.ShareByEmailEnabled CommonNoGroupSiteOptions.Classification CommonNoGroupSiteOptions.Description CommonNoGroupSiteOptions.SiteDesignId CommonNoGroupSiteOptions.HubSiteId CommonNoGroupSiteOptions.SensitivityLabelId CommonNoGroupSiteOptions.TimeZone CommonSiteOptions.Language CommonSiteOptions.WebTemplate Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public class TeamSiteWithoutGroupOptions : CommonNoGroupSiteOptions Constructors TeamSiteWithoutGroupOptions(Uri, String) Default constuctor for creating a TeamSiteWithoutGroupOptions object used to define a team site collection creation Declaration public TeamSiteWithoutGroupOptions(Uri url, string title) Parameters Uri url Url of the team site without group String title Title of the team site without group" + "keywords": "Class TeamSiteWithoutGroupOptions Contains the available options for creating a team site collection without a group Inheritance System.Object CommonSiteOptions CommonNoGroupSiteOptions TeamSiteWithoutGroupOptions Inherited Members CommonNoGroupSiteOptions.Url CommonNoGroupSiteOptions.Title CommonNoGroupSiteOptions.Owner CommonNoGroupSiteOptions.ShareByEmailEnabled CommonNoGroupSiteOptions.Classification CommonNoGroupSiteOptions.Description CommonNoGroupSiteOptions.SiteDesignId CommonNoGroupSiteOptions.HubSiteId CommonNoGroupSiteOptions.SensitivityLabelId CommonNoGroupSiteOptions.TimeZone CommonSiteOptions.Language CommonSiteOptions.WebTemplate Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public class TeamSiteWithoutGroupOptions : CommonNoGroupSiteOptions Constructors TeamSiteWithoutGroupOptions(Uri, String) Default constuctor for creating a TeamSiteWithoutGroupOptions object used to define a team site collection creation Declaration public TeamSiteWithoutGroupOptions(Uri url, string title) Parameters Uri url Url of the team site without group String title Title of the team site without group" }, "api/PnP.Core.Admin.Model.SharePoint.TenantBrowseUserInfoPolicyValue.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.TenantBrowseUserInfoPolicyValue.html", @@ -432,7 +432,7 @@ "api/PnP.Core.Admin.Model.SharePoint.VanityUrlOptions.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.VanityUrlOptions.html", "title": "Class VanityUrlOptions | PnP Core SDK", - "keywords": "Class VanityUrlOptions When you're using a vanity URL tenant you can specify your custom URLs here Inheritance Object VanityUrlOptions Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public class VanityUrlOptions : object Properties AdminCenterUri Sets the admin center URL (e.g. https://sharepointadmin.contoso.com ) Declaration public Uri AdminCenterUri { get; set; } Property Value Uri MySiteHostUri Sets the vanity my site host URL (e.g. https://my.contoso.com ) Declaration public Uri MySiteHostUri { get; set; } Property Value Uri PortalUri Sets the vanity portal URL (e.g. https://portal.contoso.com ) Declaration public Uri PortalUri { get; set; } Property Value Uri" + "keywords": "Class VanityUrlOptions When you're using a vanity URL tenant you can specify your custom URLs here Inheritance System.Object VanityUrlOptions Namespace : PnP.Core.Admin.Model.SharePoint Assembly : PnP.Core.Admin.dll Syntax public class VanityUrlOptions : object Properties AdminCenterUri Sets the admin center URL (e.g. https://sharepointadmin.contoso.com ) Declaration public Uri AdminCenterUri { get; set; } Property Value Uri MySiteHostUri Sets the vanity my site host URL (e.g. https://my.contoso.com ) Declaration public Uri MySiteHostUri { get; set; } Property Value Uri PortalUri Sets the vanity portal URL (e.g. https://portal.contoso.com ) Declaration public Uri PortalUri { get; set; } Property Value Uri" }, "api/PnP.Core.Admin.Model.SharePoint.Workflows2013State.html": { "href": "api/PnP.Core.Admin.Model.SharePoint.Workflows2013State.html", @@ -452,37 +452,37 @@ "api/PnP.Core.Admin.Model.Teams.TeamCreationOptions.html": { "href": "api/PnP.Core.Admin.Model.Teams.TeamCreationOptions.html", "title": "Class TeamCreationOptions | PnP Core SDK", - "keywords": "Class TeamCreationOptions Options to control the Teams creation flow Inheritance Object TeamCreationOptions Namespace : PnP.Core.Admin.Model.Teams Assembly : PnP.Core.Admin.dll Syntax public class TeamCreationOptions : object Properties MaxStatusChecks Number of times to check for provisioning complete status. Defaults to 12 if not set. Declaration public int? MaxStatusChecks { get; set; } Property Value Nullable < Int32 > WaitAfterStatusCheck Defines the wait time in seconds after a status check. Defaults to 10 if not set. Declaration public int? WaitAfterStatusCheck { get; set; } Property Value Nullable < Int32 >" + "keywords": "Class TeamCreationOptions Options to control the Teams creation flow Inheritance System.Object TeamCreationOptions Namespace : PnP.Core.Admin.Model.Teams Assembly : PnP.Core.Admin.dll Syntax public class TeamCreationOptions : object Properties MaxStatusChecks Number of times to check for provisioning complete status. Defaults to 12 if not set. Declaration public int? MaxStatusChecks { get; set; } Property Value Nullable < Int32 > WaitAfterStatusCheck Defines the wait time in seconds after a status check. Defaults to 10 if not set. Declaration public int? WaitAfterStatusCheck { get; set; } Property Value Nullable < Int32 >" }, "api/PnP.Core.Admin.Model.Teams.TeamForGroupOptions.html": { "href": "api/PnP.Core.Admin.Model.Teams.TeamForGroupOptions.html", "title": "Class TeamForGroupOptions | PnP Core SDK", - "keywords": "Class TeamForGroupOptions Options to configure the created Team Inheritance Object TeamOptions TeamForGroupOptions Namespace : PnP.Core.Admin.Model.Teams Assembly : PnP.Core.Admin.dll Syntax public class TeamForGroupOptions : TeamOptions Constructors TeamForGroupOptions(Guid) Default constructor used for creating a Team Declaration public TeamForGroupOptions(Guid groupId) Parameters Guid groupId Id of the Microsoft 365 group to create the Team for Properties GroupId Id of the Microsoft 365 group to create the Team for Declaration public Guid GroupId { get; set; } Property Value Guid" + "keywords": "Class TeamForGroupOptions Options to configure the created Team Inheritance System.Object TeamOptions TeamForGroupOptions Namespace : PnP.Core.Admin.Model.Teams Assembly : PnP.Core.Admin.dll Syntax public class TeamForGroupOptions : TeamOptions Constructors TeamForGroupOptions(Guid) Default constructor used for creating a Team Declaration public TeamForGroupOptions(Guid groupId) Parameters Guid groupId Id of the Microsoft 365 group to create the Team for Properties GroupId Id of the Microsoft 365 group to create the Team for Declaration public Guid GroupId { get; set; } Property Value Guid" }, "api/PnP.Core.Admin.Model.Teams.TeamOptions.html": { "href": "api/PnP.Core.Admin.Model.Teams.TeamOptions.html", "title": "Class TeamOptions | PnP Core SDK", - "keywords": "Class TeamOptions Options to configure the created Team Inheritance Object TeamOptions TeamForGroupOptions Namespace : PnP.Core.Admin.Model.Teams Assembly : PnP.Core.Admin.dll Syntax public class TeamOptions : object" + "keywords": "Class TeamOptions Options to configure the created Team Inheritance System.Object TeamOptions TeamForGroupOptions Namespace : PnP.Core.Admin.Model.Teams Assembly : PnP.Core.Admin.dll Syntax public class TeamOptions : object" }, "api/PnP.Core.Auth.CredentialManagerAuthenticationProvider.html": { "href": "api/PnP.Core.Auth.CredentialManagerAuthenticationProvider.html", "title": "Class CredentialManagerAuthenticationProvider | PnP Core SDK", - "keywords": "Class CredentialManagerAuthenticationProvider Authentication Provider that uses a set of credentials stored in the Credentials Manager of Windows Inheritance Object OAuthAuthenticationProvider CredentialManagerAuthenticationProvider Inherited Members OAuthAuthenticationProvider.ConfigurationName OAuthAuthenticationProvider.ClientId OAuthAuthenticationProvider.TenantId OAuthAuthenticationProvider.DefaultAADAppId Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public sealed class CredentialManagerAuthenticationProvider : OAuthAuthenticationProvider, IAuthenticationProvider Constructors CredentialManagerAuthenticationProvider(ILogger, IMsalHttpClientFactory) Public constructor leveraging DI to initialize the ILogger and IMsalHttpClientFactory interfaces Declaration public CredentialManagerAuthenticationProvider(ILogger logger, IMsalHttpClientFactory msalHttpClientFactory) Parameters ILogger < OAuthAuthenticationProvider > logger The instance of the logger service provided by DI IMsalHttpClientFactory msalHttpClientFactory The instance of the Msal Http Client Factory service provided by DI CredentialManagerAuthenticationProvider(String, String, PnPCoreAuthenticationCredentialManagerOptions) Public constructor for external consumers of the library Declaration public CredentialManagerAuthenticationProvider(string clientId, string tenantId, PnPCoreAuthenticationCredentialManagerOptions options) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider PnPCoreAuthenticationCredentialManagerOptions options Options for the authentication provider CredentialManagerAuthenticationProvider(String, String, String) Public constructor for external consumers of the library Declaration public CredentialManagerAuthenticationProvider(string clientId, string tenantId, string credentialManagerName) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider String credentialManagerName The Name of the Credential Manager item for authentication Properties CredentialManagerName The name of the Windows Credential Manager settings to use Declaration public string CredentialManagerName { get; set; } Property Value String Methods AuthenticateRequestAsync(Uri, HttpRequestMessage) Authenticates the specified request message. Declaration public override async Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request) Parameters Uri resource Request uri HttpRequestMessage request The to authenticate. Returns Task The task to await. Overrides OAuthAuthenticationProvider.AuthenticateRequestAsync(Uri, HttpRequestMessage) GetAccessTokenAsync(Uri) Gets an access token for the requested resource Declaration public override async Task GetAccessTokenAsync(Uri resource) Parameters Uri resource Resource to request an access token for Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri) GetAccessTokenAsync(Uri, String[]) Gets an access token for the requested resource and scope. Provide either scopes or resource parameter. Declaration public override async Task GetAccessTokenAsync(Uri resource, string[] scopes) Parameters Uri resource Resource to request an access token for, only used if scopes is null String [] scopes Scopes to request, can be null Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri, String[])" + "keywords": "Class CredentialManagerAuthenticationProvider Authentication Provider that uses a set of credentials stored in the Credentials Manager of Windows Inheritance System.Object OAuthAuthenticationProvider CredentialManagerAuthenticationProvider Inherited Members OAuthAuthenticationProvider.ConfigurationName OAuthAuthenticationProvider.ClientId OAuthAuthenticationProvider.TenantId OAuthAuthenticationProvider.DefaultAADAppId Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public sealed class CredentialManagerAuthenticationProvider : OAuthAuthenticationProvider, IAuthenticationProvider Constructors CredentialManagerAuthenticationProvider(ILogger, IMsalHttpClientFactory) Public constructor leveraging DI to initialize the ILogger and IMsalHttpClientFactory interfaces Declaration public CredentialManagerAuthenticationProvider(ILogger logger, IMsalHttpClientFactory msalHttpClientFactory) Parameters ILogger < OAuthAuthenticationProvider > logger The instance of the logger service provided by DI IMsalHttpClientFactory msalHttpClientFactory The instance of the Msal Http Client Factory service provided by DI CredentialManagerAuthenticationProvider(String, String, PnPCoreAuthenticationCredentialManagerOptions) Public constructor for external consumers of the library Declaration public CredentialManagerAuthenticationProvider(string clientId, string tenantId, PnPCoreAuthenticationCredentialManagerOptions options) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider PnPCoreAuthenticationCredentialManagerOptions options Options for the authentication provider CredentialManagerAuthenticationProvider(String, String, String) Public constructor for external consumers of the library Declaration public CredentialManagerAuthenticationProvider(string clientId, string tenantId, string credentialManagerName) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider String credentialManagerName The Name of the Credential Manager item for authentication Properties CredentialManagerName The name of the Windows Credential Manager settings to use Declaration public string CredentialManagerName { get; set; } Property Value String Methods AuthenticateRequestAsync(Uri, HttpRequestMessage) Authenticates the specified request message. Declaration public override async Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request) Parameters Uri resource Request uri HttpRequestMessage request The to authenticate. Returns Task The task to await. Overrides OAuthAuthenticationProvider.AuthenticateRequestAsync(Uri, HttpRequestMessage) GetAccessTokenAsync(Uri) Gets an access token for the requested resource Declaration public override async Task GetAccessTokenAsync(Uri resource) Parameters Uri resource Resource to request an access token for Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri) GetAccessTokenAsync(Uri, String[]) Gets an access token for the requested resource and scope. Provide either scopes or resource parameter. Declaration public override async Task GetAccessTokenAsync(Uri resource, string[] scopes) Parameters Uri resource Resource to request an access token for, only used if scopes is null String [] scopes Scopes to request, can be null Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri, String[])" }, "api/PnP.Core.Auth.DeviceCodeAuthenticationProvider.html": { "href": "api/PnP.Core.Auth.DeviceCodeAuthenticationProvider.html", "title": "Class DeviceCodeAuthenticationProvider | PnP Core SDK", - "keywords": "Class DeviceCodeAuthenticationProvider Authentication Provider that uses a device code flow for authentication Inheritance Object OAuthAuthenticationProvider DeviceCodeAuthenticationProvider Inherited Members OAuthAuthenticationProvider.ConfigurationName OAuthAuthenticationProvider.ClientId OAuthAuthenticationProvider.TenantId OAuthAuthenticationProvider.DefaultAADAppId Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public class DeviceCodeAuthenticationProvider : OAuthAuthenticationProvider, IAuthenticationProvider Constructors DeviceCodeAuthenticationProvider(ILogger, IMsalHttpClientFactory) Public constructor leveraging DI to initialize the ILogger and IMsalHttpClientFactory interfaces Declaration public DeviceCodeAuthenticationProvider(ILogger logger, IMsalHttpClientFactory msalHttpClientFactory) Parameters ILogger < OAuthAuthenticationProvider > logger The instance of the logger service provided by DI IMsalHttpClientFactory msalHttpClientFactory The instance of the Msal Http Client Factory service provided by DI DeviceCodeAuthenticationProvider(String, String, PnPCoreAuthenticationDeviceCodeOptions, Action) Public constructor for external consumers of the library Declaration public DeviceCodeAuthenticationProvider(string clientId, string tenantId, PnPCoreAuthenticationDeviceCodeOptions options, Action deviceCodeVerification) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider PnPCoreAuthenticationDeviceCodeOptions options Options for the authentication provider Action < DeviceCodeNotification > deviceCodeVerification External action to manage the Device Code verification DeviceCodeAuthenticationProvider(String, String, Uri, Action) Public constructor for external consumers of the library Declaration public DeviceCodeAuthenticationProvider(string clientId, string tenantId, Uri redirectUri, Action deviceCodeVerification) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider Uri redirectUri The Redirect URI for the authentication flow Action < DeviceCodeNotification > deviceCodeVerification External action to manage the Device Code verification Properties DeviceCodeVerification Action to notify the end user about the device code request Declaration public Action DeviceCodeVerification { get; set; } Property Value Action < DeviceCodeNotification > RedirectUri The Redirect URI for the authentication flow Declaration public Uri RedirectUri { get; set; } Property Value Uri Methods AuthenticateRequestAsync(Uri, HttpRequestMessage) Authenticates the specified request message. Declaration public override async Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request) Parameters Uri resource Request uri HttpRequestMessage request The to authenticate. Returns Task The task to await. Overrides OAuthAuthenticationProvider.AuthenticateRequestAsync(Uri, HttpRequestMessage) GetAccessTokenAsync(Uri) Gets an access token for the requested resource Declaration public override async Task GetAccessTokenAsync(Uri resource) Parameters Uri resource Resource to request an access token for Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri) GetAccessTokenAsync(Uri, String[]) Gets an access token for the requested resource and scope Declaration public override async Task GetAccessTokenAsync(Uri resource, string[] scopes) Parameters Uri resource Resource to request an access token for (unused) String [] scopes Scopes to request Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri, String[])" + "keywords": "Class DeviceCodeAuthenticationProvider Authentication Provider that uses a device code flow for authentication Inheritance System.Object OAuthAuthenticationProvider DeviceCodeAuthenticationProvider Inherited Members OAuthAuthenticationProvider.ConfigurationName OAuthAuthenticationProvider.ClientId OAuthAuthenticationProvider.TenantId OAuthAuthenticationProvider.DefaultAADAppId Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public class DeviceCodeAuthenticationProvider : OAuthAuthenticationProvider, IAuthenticationProvider Constructors DeviceCodeAuthenticationProvider(ILogger, IMsalHttpClientFactory) Public constructor leveraging DI to initialize the ILogger and IMsalHttpClientFactory interfaces Declaration public DeviceCodeAuthenticationProvider(ILogger logger, IMsalHttpClientFactory msalHttpClientFactory) Parameters ILogger < OAuthAuthenticationProvider > logger The instance of the logger service provided by DI IMsalHttpClientFactory msalHttpClientFactory The instance of the Msal Http Client Factory service provided by DI DeviceCodeAuthenticationProvider(String, String, PnPCoreAuthenticationDeviceCodeOptions, Action) Public constructor for external consumers of the library Declaration public DeviceCodeAuthenticationProvider(string clientId, string tenantId, PnPCoreAuthenticationDeviceCodeOptions options, Action deviceCodeVerification) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider PnPCoreAuthenticationDeviceCodeOptions options Options for the authentication provider Action < DeviceCodeNotification > deviceCodeVerification External action to manage the Device Code verification DeviceCodeAuthenticationProvider(String, String, Uri, Action) Public constructor for external consumers of the library Declaration public DeviceCodeAuthenticationProvider(string clientId, string tenantId, Uri redirectUri, Action deviceCodeVerification) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider Uri redirectUri The Redirect URI for the authentication flow Action < DeviceCodeNotification > deviceCodeVerification External action to manage the Device Code verification Properties DeviceCodeVerification Action to notify the end user about the device code request Declaration public Action DeviceCodeVerification { get; set; } Property Value Action < DeviceCodeNotification > RedirectUri The Redirect URI for the authentication flow Declaration public Uri RedirectUri { get; set; } Property Value Uri Methods AuthenticateRequestAsync(Uri, HttpRequestMessage) Authenticates the specified request message. Declaration public override async Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request) Parameters Uri resource Request uri HttpRequestMessage request The to authenticate. Returns Task The task to await. Overrides OAuthAuthenticationProvider.AuthenticateRequestAsync(Uri, HttpRequestMessage) GetAccessTokenAsync(Uri) Gets an access token for the requested resource Declaration public override async Task GetAccessTokenAsync(Uri resource) Parameters Uri resource Resource to request an access token for Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri) GetAccessTokenAsync(Uri, String[]) Gets an access token for the requested resource and scope Declaration public override async Task GetAccessTokenAsync(Uri resource, string[] scopes) Parameters Uri resource Resource to request an access token for (unused) String [] scopes Scopes to request Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri, String[])" }, "api/PnP.Core.Auth.DeviceCodeNotification.html": { "href": "api/PnP.Core.Auth.DeviceCodeNotification.html", "title": "Class DeviceCodeNotification | PnP Core SDK", - "keywords": "Class DeviceCodeNotification Provides information about the Device Code authentication request Inheritance Object DeviceCodeNotification Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public class DeviceCodeNotification : object Properties Message User friendly text response that can be used for display purpose. Declaration public string Message { get; set; } Property Value String UserCode Device code returned by the service Declaration public string UserCode { get; set; } Property Value String VerificationUrl Verification URL where the user must navigate to authenticate using the device code and credentials Declaration public Uri VerificationUrl { get; set; } Property Value Uri" + "keywords": "Class DeviceCodeNotification Provides information about the Device Code authentication request Inheritance System.Object DeviceCodeNotification Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public class DeviceCodeNotification : object Properties Message User friendly text response that can be used for display purpose. Declaration public string Message { get; set; } Property Value String UserCode Device code returned by the service Declaration public string UserCode { get; set; } Property Value String VerificationUrl Verification URL where the user must navigate to authenticate using the device code and credentials Declaration public Uri VerificationUrl { get; set; } Property Value Uri" }, "api/PnP.Core.Auth.ExternalAuthenticationProvider.html": { "href": "api/PnP.Core.Auth.ExternalAuthenticationProvider.html", "title": "Class ExternalAuthenticationProvider | PnP Core SDK", - "keywords": "Class ExternalAuthenticationProvider Authentication Provider that relies on an external token provider Inheritance Object OAuthAuthenticationProvider ExternalAuthenticationProvider Inherited Members OAuthAuthenticationProvider.ConfigurationName OAuthAuthenticationProvider.ClientId OAuthAuthenticationProvider.TenantId OAuthAuthenticationProvider.DefaultAADAppId Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public sealed class ExternalAuthenticationProvider : OAuthAuthenticationProvider, IAuthenticationProvider Constructors ExternalAuthenticationProvider(Func) Public constructor for external consumers of the library Declaration public ExternalAuthenticationProvider(Func accessTokenProvider) Parameters Func < Uri , String [], String > accessTokenProvider A function providing the access token to use ExternalAuthenticationProvider(Func>) Public constructor for external consumers of the library Declaration public ExternalAuthenticationProvider(Func> accessTokenProvider) Parameters Func < Uri , String [], Task < String >> accessTokenProvider A function providing the access token to use ExternalAuthenticationProvider(ILogger) Public constructor leveraging DI to initialize the ILogger interfafce Declaration public ExternalAuthenticationProvider(ILogger logger) Parameters ILogger < OAuthAuthenticationProvider > logger The instance of the logger service provided by DI Properties AccessTokenProvider A function providing the access token to use Declaration public Func AccessTokenProvider { get; set; } Property Value Func < Uri , String [], String > AccessTokenTaskProvider A function providing the access token to use Declaration public Func> AccessTokenTaskProvider { get; set; } Property Value Func < Uri , String [], Task < String >> Methods AuthenticateRequestAsync(Uri, HttpRequestMessage) Authenticates the specified request message. Declaration public override async Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request) Parameters Uri resource Request uri HttpRequestMessage request The to authenticate. Returns Task The task to await. Overrides OAuthAuthenticationProvider.AuthenticateRequestAsync(Uri, HttpRequestMessage) GetAccessTokenAsync(Uri) Gets an access token for the requested resource Declaration public override async Task GetAccessTokenAsync(Uri resource) Parameters Uri resource Resource to request an access token for Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri) GetAccessTokenAsync(Uri, String[]) Gets an access token for the requested resource and scope Declaration public override async Task GetAccessTokenAsync(Uri resource, string[] scopes) Parameters Uri resource Resource to request an access token for String [] scopes Scopes to request Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri, String[])" + "keywords": "Class ExternalAuthenticationProvider Authentication Provider that relies on an external token provider Inheritance System.Object OAuthAuthenticationProvider ExternalAuthenticationProvider Inherited Members OAuthAuthenticationProvider.ConfigurationName OAuthAuthenticationProvider.ClientId OAuthAuthenticationProvider.TenantId OAuthAuthenticationProvider.DefaultAADAppId Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public sealed class ExternalAuthenticationProvider : OAuthAuthenticationProvider, IAuthenticationProvider Constructors ExternalAuthenticationProvider(Func) Public constructor for external consumers of the library Declaration public ExternalAuthenticationProvider(Func accessTokenProvider) Parameters Func < Uri , String [], String > accessTokenProvider A function providing the access token to use ExternalAuthenticationProvider(Func>) Public constructor for external consumers of the library Declaration public ExternalAuthenticationProvider(Func> accessTokenProvider) Parameters Func < Uri , String [], Task < String >> accessTokenProvider A function providing the access token to use ExternalAuthenticationProvider(ILogger) Public constructor leveraging DI to initialize the ILogger interfafce Declaration public ExternalAuthenticationProvider(ILogger logger) Parameters ILogger < OAuthAuthenticationProvider > logger The instance of the logger service provided by DI Properties AccessTokenProvider A function providing the access token to use Declaration public Func AccessTokenProvider { get; set; } Property Value Func < Uri , String [], String > AccessTokenTaskProvider A function providing the access token to use Declaration public Func> AccessTokenTaskProvider { get; set; } Property Value Func < Uri , String [], Task < String >> Methods AuthenticateRequestAsync(Uri, HttpRequestMessage) Authenticates the specified request message. Declaration public override async Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request) Parameters Uri resource Request uri HttpRequestMessage request The to authenticate. Returns Task The task to await. Overrides OAuthAuthenticationProvider.AuthenticateRequestAsync(Uri, HttpRequestMessage) GetAccessTokenAsync(Uri) Gets an access token for the requested resource Declaration public override async Task GetAccessTokenAsync(Uri resource) Parameters Uri resource Resource to request an access token for Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri) GetAccessTokenAsync(Uri, String[]) Gets an access token for the requested resource and scope Declaration public override async Task GetAccessTokenAsync(Uri resource, string[] scopes) Parameters Uri resource Resource to request an access token for String [] scopes Scopes to request Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri, String[])" }, "api/PnP.Core.Auth.html": { "href": "api/PnP.Core.Auth.html", @@ -492,27 +492,27 @@ "api/PnP.Core.Auth.InteractiveAuthenticationProvider.html": { "href": "api/PnP.Core.Auth.InteractiveAuthenticationProvider.html", "title": "Class InteractiveAuthenticationProvider | PnP Core SDK", - "keywords": "Class InteractiveAuthenticationProvider Authentication Provider that uses an interactive flow prompting the user for credentials Inheritance Object OAuthAuthenticationProvider InteractiveAuthenticationProvider Inherited Members OAuthAuthenticationProvider.ConfigurationName OAuthAuthenticationProvider.ClientId OAuthAuthenticationProvider.TenantId OAuthAuthenticationProvider.DefaultAADAppId Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public class InteractiveAuthenticationProvider : OAuthAuthenticationProvider, IAuthenticationProvider Constructors InteractiveAuthenticationProvider() Public constructor for external consumers of the library Declaration public InteractiveAuthenticationProvider() InteractiveAuthenticationProvider(ILogger, IMsalHttpClientFactory) Public constructor leveraging DI to initialize the ILogger and IMsalHttpClientFactory interfaces Declaration public InteractiveAuthenticationProvider(ILogger logger, IMsalHttpClientFactory msalHttpClientFactory) Parameters ILogger < OAuthAuthenticationProvider > logger The instance of the logger service provided by DI IMsalHttpClientFactory msalHttpClientFactory The instance of the Msal Http Client Factory service provided by DI InteractiveAuthenticationProvider(String, String, PnPCoreAuthenticationInteractiveOptions) Public constructor for external consumers of the library Declaration public InteractiveAuthenticationProvider(string clientId, string tenantId, PnPCoreAuthenticationInteractiveOptions options) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider PnPCoreAuthenticationInteractiveOptions options Options for the authentication provider InteractiveAuthenticationProvider(String, String, Uri) Public constructor for external consumers of the library Declaration public InteractiveAuthenticationProvider(string clientId, string tenantId, Uri redirectUri) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider Uri redirectUri The Redirect URI for the authentication flow Properties RedirectUri The Redirect URI for the authentication flow Declaration public Uri RedirectUri { get; set; } Property Value Uri Methods AuthenticateRequestAsync(Uri, HttpRequestMessage) Authenticates the specified request message. Declaration public override async Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request) Parameters Uri resource Request uri HttpRequestMessage request The to authenticate. Returns Task The task to await. Overrides OAuthAuthenticationProvider.AuthenticateRequestAsync(Uri, HttpRequestMessage) GetAccessTokenAsync(Uri) Gets an access token for the requested resource Declaration public override async Task GetAccessTokenAsync(Uri resource) Parameters Uri resource Resource to request an access token for Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri) GetAccessTokenAsync(Uri, String[]) Gets an access token for the requested resource and scope Declaration public override async Task GetAccessTokenAsync(Uri resource, string[] scopes) Parameters Uri resource Resource to request an access token for (unused) String [] scopes Scopes to request Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri, String[])" + "keywords": "Class InteractiveAuthenticationProvider Authentication Provider that uses an interactive flow prompting the user for credentials Inheritance System.Object OAuthAuthenticationProvider InteractiveAuthenticationProvider Inherited Members OAuthAuthenticationProvider.ConfigurationName OAuthAuthenticationProvider.ClientId OAuthAuthenticationProvider.TenantId OAuthAuthenticationProvider.DefaultAADAppId Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public class InteractiveAuthenticationProvider : OAuthAuthenticationProvider, IAuthenticationProvider Constructors InteractiveAuthenticationProvider() Public constructor for external consumers of the library Declaration public InteractiveAuthenticationProvider() InteractiveAuthenticationProvider(ILogger, IMsalHttpClientFactory) Public constructor leveraging DI to initialize the ILogger and IMsalHttpClientFactory interfaces Declaration public InteractiveAuthenticationProvider(ILogger logger, IMsalHttpClientFactory msalHttpClientFactory) Parameters ILogger < OAuthAuthenticationProvider > logger The instance of the logger service provided by DI IMsalHttpClientFactory msalHttpClientFactory The instance of the Msal Http Client Factory service provided by DI InteractiveAuthenticationProvider(String, String, PnPCoreAuthenticationInteractiveOptions) Public constructor for external consumers of the library Declaration public InteractiveAuthenticationProvider(string clientId, string tenantId, PnPCoreAuthenticationInteractiveOptions options) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider PnPCoreAuthenticationInteractiveOptions options Options for the authentication provider InteractiveAuthenticationProvider(String, String, Uri) Public constructor for external consumers of the library Declaration public InteractiveAuthenticationProvider(string clientId, string tenantId, Uri redirectUri) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider Uri redirectUri The Redirect URI for the authentication flow Properties RedirectUri The Redirect URI for the authentication flow Declaration public Uri RedirectUri { get; set; } Property Value Uri Methods AuthenticateRequestAsync(Uri, HttpRequestMessage) Authenticates the specified request message. Declaration public override async Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request) Parameters Uri resource Request uri HttpRequestMessage request The to authenticate. Returns Task The task to await. Overrides OAuthAuthenticationProvider.AuthenticateRequestAsync(Uri, HttpRequestMessage) GetAccessTokenAsync(Uri) Gets an access token for the requested resource Declaration public override async Task GetAccessTokenAsync(Uri resource) Parameters Uri resource Resource to request an access token for Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri) GetAccessTokenAsync(Uri, String[]) Gets an access token for the requested resource and scope Declaration public override async Task GetAccessTokenAsync(Uri resource, string[] scopes) Parameters Uri resource Resource to request an access token for (unused) String [] scopes Scopes to request Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri, String[])" }, "api/PnP.Core.Auth.OAuthAuthenticationProvider.html": { "href": "api/PnP.Core.Auth.OAuthAuthenticationProvider.html", "title": "Class OAuthAuthenticationProvider | PnP Core SDK", - "keywords": "Class OAuthAuthenticationProvider Base authentication provider class Inheritance Object OAuthAuthenticationProvider CredentialManagerAuthenticationProvider DeviceCodeAuthenticationProvider ExternalAuthenticationProvider InteractiveAuthenticationProvider OnBehalfOfAuthenticationProvider UsernamePasswordAuthenticationProvider X509CertificateAuthenticationProvider Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public abstract class OAuthAuthenticationProvider : object, IAuthenticationProvider Constructors OAuthAuthenticationProvider(ILogger) Public constructor for any OAuth Authentication privider Declaration public OAuthAuthenticationProvider(ILogger logger) Parameters ILogger < OAuthAuthenticationProvider > logger Fields DefaultAADAppId Default Azure AD application id (PnP Management Shell) Declaration protected const string DefaultAADAppId = null Field Value String Properties ClientId The ClientId of the application to use for authentication Declaration public string ClientId { get; set; } Property Value String ConfigurationName The Name of the configuration for the Authentication Provider Declaration public string ConfigurationName { get; set; } Property Value String TenantId The Tenant ID for the application, default value is \"organizations\" for multi-tenant applications Declaration public string TenantId { get; set; } Property Value String Methods AuthenticateRequestAsync(Uri, HttpRequestMessage) Authenticates the specified request message. Declaration public abstract Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request) Parameters Uri resource Request uri HttpRequestMessage request The to authenticate. Returns Task The task to await. GetAccessTokenAsync(Uri) Gets an access token for the requested resource Declaration public abstract Task GetAccessTokenAsync(Uri resource) Parameters Uri resource Resource to request an access token for Returns Task < String > An access token GetAccessTokenAsync(Uri, String[]) Gets an access token for the requested resource and scope Declaration public abstract Task GetAccessTokenAsync(Uri resource, string[] scopes) Parameters Uri resource Resource to request an access token for String [] scopes Scopes to request Returns Task < String > An access token" + "keywords": "Class OAuthAuthenticationProvider Base authentication provider class Inheritance System.Object OAuthAuthenticationProvider CredentialManagerAuthenticationProvider DeviceCodeAuthenticationProvider ExternalAuthenticationProvider InteractiveAuthenticationProvider OnBehalfOfAuthenticationProvider UsernamePasswordAuthenticationProvider X509CertificateAuthenticationProvider Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public abstract class OAuthAuthenticationProvider : object, IAuthenticationProvider Constructors OAuthAuthenticationProvider(ILogger) Public constructor for any OAuth Authentication privider Declaration public OAuthAuthenticationProvider(ILogger logger) Parameters ILogger < OAuthAuthenticationProvider > logger Fields DefaultAADAppId Default Azure AD application id (PnP Management Shell) Declaration protected const string DefaultAADAppId = null Field Value String Properties ClientId The ClientId of the application to use for authentication Declaration public string ClientId { get; set; } Property Value String ConfigurationName The Name of the configuration for the Authentication Provider Declaration public string ConfigurationName { get; set; } Property Value String TenantId The Tenant ID for the application, default value is \"organizations\" for multi-tenant applications Declaration public string TenantId { get; set; } Property Value String Methods AuthenticateRequestAsync(Uri, HttpRequestMessage) Authenticates the specified request message. Declaration public abstract Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request) Parameters Uri resource Request uri HttpRequestMessage request The to authenticate. Returns Task The task to await. GetAccessTokenAsync(Uri) Gets an access token for the requested resource Declaration public abstract Task GetAccessTokenAsync(Uri resource) Parameters Uri resource Resource to request an access token for Returns Task < String > An access token GetAccessTokenAsync(Uri, String[]) Gets an access token for the requested resource and scope Declaration public abstract Task GetAccessTokenAsync(Uri resource, string[] scopes) Parameters Uri resource Resource to request an access token for String [] scopes Scopes to request Returns Task < String > An access token" }, "api/PnP.Core.Auth.OnBehalfOfAuthenticationProvider.html": { "href": "api/PnP.Core.Auth.OnBehalfOfAuthenticationProvider.html", "title": "Class OnBehalfOfAuthenticationProvider | PnP Core SDK", - "keywords": "Class OnBehalfOfAuthenticationProvider Authentication Provider based on the OnBehalfOf flow Inheritance Object OAuthAuthenticationProvider OnBehalfOfAuthenticationProvider Inherited Members OAuthAuthenticationProvider.ConfigurationName OAuthAuthenticationProvider.ClientId OAuthAuthenticationProvider.TenantId OAuthAuthenticationProvider.DefaultAADAppId Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public sealed class OnBehalfOfAuthenticationProvider : OAuthAuthenticationProvider, IAuthenticationProvider Remarks You can find further details about the On-Behalf-Of flow here: https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow Constructors OnBehalfOfAuthenticationProvider(ILogger, IMsalHttpClientFactory) Public constructor leveraging DI to initialize the ILogger and IMsalHttpClientFactory interfaces Declaration public OnBehalfOfAuthenticationProvider(ILogger logger, IMsalHttpClientFactory msalHttpClientFactory) Parameters ILogger < OAuthAuthenticationProvider > logger The instance of the logger service provided by DI IMsalHttpClientFactory msalHttpClientFactory The instance of the Msal Http Client Factory service provided by DI OnBehalfOfAuthenticationProvider(String, String, PnPCoreAuthenticationOnBehalfOfOptions, Func) Public constructor for external consumers of the library Declaration public OnBehalfOfAuthenticationProvider(string clientId, string tenantId, PnPCoreAuthenticationOnBehalfOfOptions options, Func userTokenProvider) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider PnPCoreAuthenticationOnBehalfOfOptions options Options for the authentication provider Func < String > userTokenProvider A function providing the consumer user access token to use for the On-Behalf-Of flow OnBehalfOfAuthenticationProvider(String, String, SecureString, Func) Public constructor for external consumers of the library Declaration public OnBehalfOfAuthenticationProvider(string clientId, string tenantId, SecureString clientSecret, Func userTokenProvider) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider SecureString clientSecret The Client Secret of the app Func < String > userTokenProvider A function providing the consumer user access token to use for the On-Behalf-Of flow OnBehalfOfAuthenticationProvider(String, String, StoreName, StoreLocation, String, Func) Public constructor for external consumers of the library Declaration public OnBehalfOfAuthenticationProvider(string clientId, string tenantId, StoreName storeName, StoreLocation storeLocation, string thumbprint, Func userTokenProvider) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider StoreName storeName The Store Name to get the X.509 certificate from StoreLocation storeLocation The Store Location to get the X.509 certificate from String thumbprint The Thumbprint of the X.509 certificate Func < String > userTokenProvider A function providing the consumer user access token to use for the On-Behalf-Of flow OnBehalfOfAuthenticationProvider(String, String, X509Certificate2, Func) Public constructor for external consumers of the library Declaration public OnBehalfOfAuthenticationProvider(string clientId, string tenantId, X509Certificate2 certificate, Func userTokenProvider) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider X509Certificate2 certificate The X.509 certificate to use for authentication Func < String > userTokenProvider A function providing the consumer user access token to use for the On-Behalf-Of flow Properties Certificate The X.509 Certificate to use for app authentication Declaration public X509Certificate2 Certificate { get; set; } Property Value X509Certificate2 ClientSecret The ClientSecret to authenticate the app with ClientId Declaration public SecureString ClientSecret { get; set; } Property Value SecureString UserTokenProvider A function providing the consumer user access token to use for the On-Behalf-Of flow Declaration public Func UserTokenProvider { get; set; } Property Value Func < String > Methods AuthenticateRequestAsync(Uri, HttpRequestMessage) Authenticates the specified request message. Declaration public override async Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request) Parameters Uri resource Request uri HttpRequestMessage request The to authenticate. Returns Task The task to await. Overrides OAuthAuthenticationProvider.AuthenticateRequestAsync(Uri, HttpRequestMessage) GetAccessTokenAsync(Uri) Gets an access token for the requested resource Declaration public override async Task GetAccessTokenAsync(Uri resource) Parameters Uri resource Resource to request an access token for Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri) GetAccessTokenAsync(Uri, String[]) Gets an access token for the requested resource and scope Declaration public override async Task GetAccessTokenAsync(Uri resource, string[] scopes) Parameters Uri resource Resource to request an access token for (unused) String [] scopes Scopes to request Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri, String[])" + "keywords": "Class OnBehalfOfAuthenticationProvider Authentication Provider based on the OnBehalfOf flow Inheritance System.Object OAuthAuthenticationProvider OnBehalfOfAuthenticationProvider Inherited Members OAuthAuthenticationProvider.ConfigurationName OAuthAuthenticationProvider.ClientId OAuthAuthenticationProvider.TenantId OAuthAuthenticationProvider.DefaultAADAppId Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public sealed class OnBehalfOfAuthenticationProvider : OAuthAuthenticationProvider, IAuthenticationProvider Remarks You can find further details about the On-Behalf-Of flow here: https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow Constructors OnBehalfOfAuthenticationProvider(ILogger, IMsalHttpClientFactory) Public constructor leveraging DI to initialize the ILogger and IMsalHttpClientFactory interfaces Declaration public OnBehalfOfAuthenticationProvider(ILogger logger, IMsalHttpClientFactory msalHttpClientFactory) Parameters ILogger < OAuthAuthenticationProvider > logger The instance of the logger service provided by DI IMsalHttpClientFactory msalHttpClientFactory The instance of the Msal Http Client Factory service provided by DI OnBehalfOfAuthenticationProvider(String, String, PnPCoreAuthenticationOnBehalfOfOptions, Func) Public constructor for external consumers of the library Declaration public OnBehalfOfAuthenticationProvider(string clientId, string tenantId, PnPCoreAuthenticationOnBehalfOfOptions options, Func userTokenProvider) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider PnPCoreAuthenticationOnBehalfOfOptions options Options for the authentication provider Func < String > userTokenProvider A function providing the consumer user access token to use for the On-Behalf-Of flow OnBehalfOfAuthenticationProvider(String, String, SecureString, Func) Public constructor for external consumers of the library Declaration public OnBehalfOfAuthenticationProvider(string clientId, string tenantId, SecureString clientSecret, Func userTokenProvider) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider SecureString clientSecret The Client Secret of the app Func < String > userTokenProvider A function providing the consumer user access token to use for the On-Behalf-Of flow OnBehalfOfAuthenticationProvider(String, String, StoreName, StoreLocation, String, Func) Public constructor for external consumers of the library Declaration public OnBehalfOfAuthenticationProvider(string clientId, string tenantId, StoreName storeName, StoreLocation storeLocation, string thumbprint, Func userTokenProvider) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider StoreName storeName The Store Name to get the X.509 certificate from StoreLocation storeLocation The Store Location to get the X.509 certificate from String thumbprint The Thumbprint of the X.509 certificate Func < String > userTokenProvider A function providing the consumer user access token to use for the On-Behalf-Of flow OnBehalfOfAuthenticationProvider(String, String, X509Certificate2, Func) Public constructor for external consumers of the library Declaration public OnBehalfOfAuthenticationProvider(string clientId, string tenantId, X509Certificate2 certificate, Func userTokenProvider) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider X509Certificate2 certificate The X.509 certificate to use for authentication Func < String > userTokenProvider A function providing the consumer user access token to use for the On-Behalf-Of flow Properties Certificate The X.509 Certificate to use for app authentication Declaration public X509Certificate2 Certificate { get; set; } Property Value X509Certificate2 ClientSecret The ClientSecret to authenticate the app with ClientId Declaration public SecureString ClientSecret { get; set; } Property Value SecureString UserTokenProvider A function providing the consumer user access token to use for the On-Behalf-Of flow Declaration public Func UserTokenProvider { get; set; } Property Value Func < String > Methods AuthenticateRequestAsync(Uri, HttpRequestMessage) Authenticates the specified request message. Declaration public override async Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request) Parameters Uri resource Request uri HttpRequestMessage request The to authenticate. Returns Task The task to await. Overrides OAuthAuthenticationProvider.AuthenticateRequestAsync(Uri, HttpRequestMessage) GetAccessTokenAsync(Uri) Gets an access token for the requested resource Declaration public override async Task GetAccessTokenAsync(Uri resource) Parameters Uri resource Resource to request an access token for Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri) GetAccessTokenAsync(Uri, String[]) Gets an access token for the requested resource and scope Declaration public override async Task GetAccessTokenAsync(Uri resource, string[] scopes) Parameters Uri resource Resource to request an access token for (unused) String [] scopes Scopes to request Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri, String[])" }, "api/PnP.Core.Auth.Services.AuthenticationProviderFactory.html": { "href": "api/PnP.Core.Auth.Services.AuthenticationProviderFactory.html", "title": "Class AuthenticationProviderFactory | PnP Core SDK", - "keywords": "Class AuthenticationProviderFactory Public factory service to create IAuthenticationProvider object instances Inheritance Object AuthenticationProviderFactory Namespace : PnP.Core.Auth.Services Assembly : PnP.Core.Auth.dll Syntax public class AuthenticationProviderFactory : object, IAuthenticationProviderFactory Constructors AuthenticationProviderFactory(IOptionsMonitor, ILogger, IServiceProvider) AuthenticationProviderFactory constructor Declaration public AuthenticationProviderFactory(IOptionsMonitor options, ILogger logger, IServiceProvider serviceProvider) Parameters IOptionsMonitor < PnPCoreAuthenticationOptions > options Options to configure the AuthenticationProviderFactory ILogger < PnPContext > logger Logger for log output IServiceProvider serviceProvider DI container service Methods Create(String) Creates a new instance of IAuthenticationProvider based on a provided configuration name Declaration public IAuthenticationProvider Create(string name) Parameters String name The name of the IAuthenticationProvider configuration to use Returns IAuthenticationProvider An object that implements IAuthenticationProvider based on the provided configuration name Implements IAuthenticationProviderFactory.Create(String) CreateDefault() Creates the default instance of IAuthenticationProvider based on the configuration Declaration public IAuthenticationProvider CreateDefault() Returns IAuthenticationProvider An object that implements IAuthenticationProvider based on the configuration Implements IAuthenticationProviderFactory.CreateDefault()" + "keywords": "Class AuthenticationProviderFactory Public factory service to create IAuthenticationProvider object instances Inheritance System.Object AuthenticationProviderFactory Namespace : PnP.Core.Auth.Services Assembly : PnP.Core.Auth.dll Syntax public class AuthenticationProviderFactory : object, IAuthenticationProviderFactory Constructors AuthenticationProviderFactory(IOptionsMonitor, ILogger, IServiceProvider) AuthenticationProviderFactory constructor Declaration public AuthenticationProviderFactory(IOptionsMonitor options, ILogger logger, IServiceProvider serviceProvider) Parameters IOptionsMonitor < PnPCoreAuthenticationOptions > options Options to configure the AuthenticationProviderFactory ILogger < PnPContext > logger Logger for log output IServiceProvider serviceProvider DI container service Methods Create(String) Creates a new instance of IAuthenticationProvider based on a provided configuration name Declaration public IAuthenticationProvider Create(string name) Parameters String name The name of the IAuthenticationProvider configuration to use Returns IAuthenticationProvider An object that implements IAuthenticationProvider based on the provided configuration name Implements IAuthenticationProviderFactory.Create(String) CreateDefault() Creates the default instance of IAuthenticationProvider based on the configuration Declaration public IAuthenticationProvider CreateDefault() Returns IAuthenticationProvider An object that implements IAuthenticationProvider based on the configuration Implements IAuthenticationProviderFactory.CreateDefault()" }, "api/PnP.Core.Auth.Services.Builder.Configuration.AuthenticationProvidersOptionsConfigurator.html": { "href": "api/PnP.Core.Auth.Services.Builder.Configuration.AuthenticationProvidersOptionsConfigurator.html", "title": "Class AuthenticationProvidersOptionsConfigurator | PnP Core SDK", - "keywords": "Class AuthenticationProvidersOptionsConfigurator Handles the configuration of PnPCoreOptions based on the AuthenticationOptions settings Inheritance Object AuthenticationProvidersOptionsConfigurator Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class AuthenticationProvidersOptionsConfigurator : IConfigureOptions Constructors AuthenticationProvidersOptionsConfigurator(IOptions, IAuthenticationProviderFactory) Default constructor Declaration public AuthenticationProvidersOptionsConfigurator(IOptions authenticationOptions, IAuthenticationProviderFactory authenticationProviderFactory) Parameters IOptions < PnPCoreAuthenticationOptions > authenticationOptions PnPCoreAuthenticationOptions authentication options IAuthenticationProviderFactory authenticationProviderFactory Authentication factory Methods Configure(PnPCoreOptions) Process the PnPCoreOptions options Declaration public void Configure(PnPCoreOptions options) Parameters PnPCoreOptions options" + "keywords": "Class AuthenticationProvidersOptionsConfigurator Handles the configuration of PnPCoreOptions based on the AuthenticationOptions settings Inheritance System.Object AuthenticationProvidersOptionsConfigurator Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class AuthenticationProvidersOptionsConfigurator : IConfigureOptions Constructors AuthenticationProvidersOptionsConfigurator(IOptions, IAuthenticationProviderFactory) Default constructor Declaration public AuthenticationProvidersOptionsConfigurator(IOptions authenticationOptions, IAuthenticationProviderFactory authenticationProviderFactory) Parameters IOptions < PnPCoreAuthenticationOptions > authenticationOptions PnPCoreAuthenticationOptions authentication options IAuthenticationProviderFactory authenticationProviderFactory Authentication factory Methods Configure(PnPCoreOptions) Process the PnPCoreOptions options Declaration public void Configure(PnPCoreOptions options) Parameters PnPCoreOptions options" }, "api/PnP.Core.Auth.Services.Builder.Configuration.html": { "href": "api/PnP.Core.Auth.Services.Builder.Configuration.html", @@ -522,67 +522,67 @@ "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationBaseOptions.html": { "href": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationBaseOptions.html", "title": "Class PnPCoreAuthenticationBaseOptions | PnP Core SDK", - "keywords": "Class PnPCoreAuthenticationBaseOptions Options for the DeviceCodeAuthenticationProvider Inheritance Object PnPCoreAuthenticationBaseOptions PnPCoreAuthenticationCredentialManagerOptions PnPCoreAuthenticationDeviceCodeOptions PnPCoreAuthenticationInteractiveOptions PnPCoreAuthenticationOnBehalfOfOptions PnPCoreAuthenticationUsernamePasswordOptions PnPCoreAuthenticationX509CertificateOptions Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public abstract class PnPCoreAuthenticationBaseOptions : object Properties AuthorityUri The Authority URI for the authentication flow Declaration public Uri AuthorityUri { get; set; } Property Value Uri RedirectUri The Redirect URI for the authentication flow Declaration public Uri RedirectUri { get; set; } Property Value Uri" + "keywords": "Class PnPCoreAuthenticationBaseOptions Options for the DeviceCodeAuthenticationProvider Inheritance System.Object PnPCoreAuthenticationBaseOptions PnPCoreAuthenticationCredentialManagerOptions PnPCoreAuthenticationDeviceCodeOptions PnPCoreAuthenticationInteractiveOptions PnPCoreAuthenticationOnBehalfOfOptions PnPCoreAuthenticationUsernamePasswordOptions PnPCoreAuthenticationX509CertificateOptions Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public abstract class PnPCoreAuthenticationBaseOptions : object Properties AuthorityUri The Authority URI for the authentication flow Declaration public Uri AuthorityUri { get; set; } Property Value Uri RedirectUri The Redirect URI for the authentication flow Declaration public Uri RedirectUri { get; set; } Property Value Uri" }, "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialConfigurationOptions.html": { "href": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialConfigurationOptions.html", "title": "Class PnPCoreAuthenticationCredentialConfigurationOptions | PnP Core SDK", - "keywords": "Class PnPCoreAuthenticationCredentialConfigurationOptions Options for one configured credentials Inheritance Object PnPCoreAuthenticationCredentialConfigurationOptions Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationCredentialConfigurationOptions : object Properties AzureADLoginAuthority Returns the Azure AD Login authority (e.g. login.microsoftonline.com) to use when Environment is set to Custom Declaration public string AzureADLoginAuthority { get; set; } Property Value String ClientId The ClientId of the application to use for authentication Declaration public string ClientId { get; set; } Property Value String CredentialManager The options for the Credential Manager Authentication Provider Declaration public PnPCoreAuthenticationCredentialManagerOptions CredentialManager { get; set; } Property Value PnPCoreAuthenticationCredentialManagerOptions DeviceCode The options for the Device Code Provider Declaration public PnPCoreAuthenticationDeviceCodeOptions DeviceCode { get; set; } Property Value PnPCoreAuthenticationDeviceCodeOptions Environment The Microsoft 365 cloud environment that's used Declaration public Microsoft365Environment? Environment { get; set; } Property Value Nullable < Microsoft365Environment > Interactive The options for the Interactive Authentication Provider Declaration public PnPCoreAuthenticationInteractiveOptions Interactive { get; set; } Property Value PnPCoreAuthenticationInteractiveOptions OnBehalfOf The options for the On Behalf Of Authentication Provider Declaration public PnPCoreAuthenticationOnBehalfOfOptions OnBehalfOf { get; set; } Property Value PnPCoreAuthenticationOnBehalfOfOptions TenantId The Tenant ID for the application, can be null Declaration public string TenantId { get; set; } Property Value String UsernamePassword The options for the Username and Password Authentication Provider Declaration public PnPCoreAuthenticationUsernamePasswordOptions UsernamePassword { get; set; } Property Value PnPCoreAuthenticationUsernamePasswordOptions X509Certificate The options for the X509 Certificate Authentication Provider Declaration public PnPCoreAuthenticationX509CertificateOptions X509Certificate { get; set; } Property Value PnPCoreAuthenticationX509CertificateOptions" + "keywords": "Class PnPCoreAuthenticationCredentialConfigurationOptions Options for one configured credentials Inheritance System.Object PnPCoreAuthenticationCredentialConfigurationOptions Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationCredentialConfigurationOptions : object Properties AzureADLoginAuthority Returns the Azure AD Login authority (e.g. login.microsoftonline.com) to use when Environment is set to Custom Declaration public string AzureADLoginAuthority { get; set; } Property Value String ClientId The ClientId of the application to use for authentication Declaration public string ClientId { get; set; } Property Value String CredentialManager The options for the Credential Manager Authentication Provider Declaration public PnPCoreAuthenticationCredentialManagerOptions CredentialManager { get; set; } Property Value PnPCoreAuthenticationCredentialManagerOptions DeviceCode The options for the Device Code Provider Declaration public PnPCoreAuthenticationDeviceCodeOptions DeviceCode { get; set; } Property Value PnPCoreAuthenticationDeviceCodeOptions Environment The Microsoft 365 cloud environment that's used Declaration public Microsoft365Environment? Environment { get; set; } Property Value Nullable < Microsoft365Environment > Interactive The options for the Interactive Authentication Provider Declaration public PnPCoreAuthenticationInteractiveOptions Interactive { get; set; } Property Value PnPCoreAuthenticationInteractiveOptions OnBehalfOf The options for the On Behalf Of Authentication Provider Declaration public PnPCoreAuthenticationOnBehalfOfOptions OnBehalfOf { get; set; } Property Value PnPCoreAuthenticationOnBehalfOfOptions TenantId The Tenant ID for the application, can be null Declaration public string TenantId { get; set; } Property Value String UsernamePassword The options for the Username and Password Authentication Provider Declaration public PnPCoreAuthenticationUsernamePasswordOptions UsernamePassword { get; set; } Property Value PnPCoreAuthenticationUsernamePasswordOptions X509Certificate The options for the X509 Certificate Authentication Provider Declaration public PnPCoreAuthenticationX509CertificateOptions X509Certificate { get; set; } Property Value PnPCoreAuthenticationX509CertificateOptions" }, "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialManagerOptions.html": { "href": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialManagerOptions.html", "title": "Class PnPCoreAuthenticationCredentialManagerOptions | PnP Core SDK", - "keywords": "Class PnPCoreAuthenticationCredentialManagerOptions Options for the CredentialManagerAuthenticationProvider Inheritance Object PnPCoreAuthenticationBaseOptions PnPCoreAuthenticationCredentialManagerOptions Inherited Members PnPCoreAuthenticationBaseOptions.RedirectUri PnPCoreAuthenticationBaseOptions.AuthorityUri Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationCredentialManagerOptions : PnPCoreAuthenticationBaseOptions Properties CredentialManagerName The name of the Windows Credential Manager settings to use Declaration public string CredentialManagerName { get; set; } Property Value String" + "keywords": "Class PnPCoreAuthenticationCredentialManagerOptions Options for the CredentialManagerAuthenticationProvider Inheritance System.Object PnPCoreAuthenticationBaseOptions PnPCoreAuthenticationCredentialManagerOptions Inherited Members PnPCoreAuthenticationBaseOptions.RedirectUri PnPCoreAuthenticationBaseOptions.AuthorityUri Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationCredentialManagerOptions : PnPCoreAuthenticationBaseOptions Properties CredentialManagerName The name of the Windows Credential Manager settings to use Declaration public string CredentialManagerName { get; set; } Property Value String" }, "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialsConfigurationsOptions.html": { "href": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialsConfigurationsOptions.html", "title": "Class PnPCoreAuthenticationCredentialsConfigurationsOptions | PnP Core SDK", - "keywords": "Class PnPCoreAuthenticationCredentialsConfigurationsOptions Options for configuring PnP Core SDK Inheritance Object PnPCoreAuthenticationCredentialsConfigurationsOptions Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationCredentialsConfigurationsOptions : Dictionary" + "keywords": "Class PnPCoreAuthenticationCredentialsConfigurationsOptions Options for configuring PnP Core SDK Inheritance System.Object PnPCoreAuthenticationCredentialsConfigurationsOptions Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationCredentialsConfigurationsOptions : Dictionary" }, "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialsOptions.html": { "href": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialsOptions.html", "title": "Class PnPCoreAuthenticationCredentialsOptions | PnP Core SDK", - "keywords": "Class PnPCoreAuthenticationCredentialsOptions Defines a collection of credential settings for secure connections to the target resources Inheritance Object PnPCoreAuthenticationCredentialsOptions Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationCredentialsOptions : object Properties Configurations The credentials options Declaration public PnPCoreAuthenticationCredentialsConfigurationsOptions Configurations { get; } Property Value PnPCoreAuthenticationCredentialsConfigurationsOptions DefaultConfiguration Defines the name of the default configuration Declaration public string DefaultConfiguration { get; set; } Property Value String" + "keywords": "Class PnPCoreAuthenticationCredentialsOptions Defines a collection of credential settings for secure connections to the target resources Inheritance System.Object PnPCoreAuthenticationCredentialsOptions Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationCredentialsOptions : object Properties Configurations The credentials options Declaration public PnPCoreAuthenticationCredentialsConfigurationsOptions Configurations { get; } Property Value PnPCoreAuthenticationCredentialsConfigurationsOptions DefaultConfiguration Defines the name of the default configuration Declaration public string DefaultConfiguration { get; set; } Property Value String" }, "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationDeviceCodeOptions.html": { "href": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationDeviceCodeOptions.html", "title": "Class PnPCoreAuthenticationDeviceCodeOptions | PnP Core SDK", - "keywords": "Class PnPCoreAuthenticationDeviceCodeOptions Options for the DeviceCodeAuthenticationProvider Inheritance Object PnPCoreAuthenticationBaseOptions PnPCoreAuthenticationDeviceCodeOptions Inherited Members PnPCoreAuthenticationBaseOptions.RedirectUri PnPCoreAuthenticationBaseOptions.AuthorityUri Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationDeviceCodeOptions : PnPCoreAuthenticationBaseOptions" + "keywords": "Class PnPCoreAuthenticationDeviceCodeOptions Options for the DeviceCodeAuthenticationProvider Inheritance System.Object PnPCoreAuthenticationBaseOptions PnPCoreAuthenticationDeviceCodeOptions Inherited Members PnPCoreAuthenticationBaseOptions.RedirectUri PnPCoreAuthenticationBaseOptions.AuthorityUri Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationDeviceCodeOptions : PnPCoreAuthenticationBaseOptions" }, "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationInteractiveOptions.html": { "href": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationInteractiveOptions.html", "title": "Class PnPCoreAuthenticationInteractiveOptions | PnP Core SDK", - "keywords": "Class PnPCoreAuthenticationInteractiveOptions Options for the InteractiveAuthenticationProvider Inheritance Object PnPCoreAuthenticationBaseOptions PnPCoreAuthenticationInteractiveOptions Inherited Members PnPCoreAuthenticationBaseOptions.RedirectUri PnPCoreAuthenticationBaseOptions.AuthorityUri Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationInteractiveOptions : PnPCoreAuthenticationBaseOptions" + "keywords": "Class PnPCoreAuthenticationInteractiveOptions Options for the InteractiveAuthenticationProvider Inheritance System.Object PnPCoreAuthenticationBaseOptions PnPCoreAuthenticationInteractiveOptions Inherited Members PnPCoreAuthenticationBaseOptions.RedirectUri PnPCoreAuthenticationBaseOptions.AuthorityUri Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationInteractiveOptions : PnPCoreAuthenticationBaseOptions" }, "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationOnBehalfOfOptions.html": { "href": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationOnBehalfOfOptions.html", "title": "Class PnPCoreAuthenticationOnBehalfOfOptions | PnP Core SDK", - "keywords": "Class PnPCoreAuthenticationOnBehalfOfOptions Options for the OnBehalfOfAuthenticationProvider Inheritance Object PnPCoreAuthenticationBaseOptions PnPCoreAuthenticationOnBehalfOfOptions Inherited Members PnPCoreAuthenticationBaseOptions.RedirectUri PnPCoreAuthenticationBaseOptions.AuthorityUri Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationOnBehalfOfOptions : PnPCoreAuthenticationBaseOptions Properties Certificate Certificate can be set directly, if required Declaration public X509Certificate2 Certificate { get; set; } Property Value X509Certificate2 ClientSecret The ClientSecret to authenticate the app with ClientId Declaration public string ClientSecret { get; set; } Property Value String StoreLocation The location in the certificate store Declaration public StoreLocation StoreLocation { get; set; } Property Value StoreLocation StoreName The name of the certificate store Declaration public StoreName StoreName { get; set; } Property Value StoreName Thumbprint The thumbprint of the certificate Declaration public string Thumbprint { get; set; } Property Value String" + "keywords": "Class PnPCoreAuthenticationOnBehalfOfOptions Options for the OnBehalfOfAuthenticationProvider Inheritance System.Object PnPCoreAuthenticationBaseOptions PnPCoreAuthenticationOnBehalfOfOptions Inherited Members PnPCoreAuthenticationBaseOptions.RedirectUri PnPCoreAuthenticationBaseOptions.AuthorityUri Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationOnBehalfOfOptions : PnPCoreAuthenticationBaseOptions Properties Certificate Certificate can be set directly, if required Declaration public X509Certificate2 Certificate { get; set; } Property Value X509Certificate2 ClientSecret The ClientSecret to authenticate the app with ClientId Declaration public string ClientSecret { get; set; } Property Value String StoreLocation The location in the certificate store Declaration public StoreLocation StoreLocation { get; set; } Property Value StoreLocation StoreName The name of the certificate store Declaration public StoreName StoreName { get; set; } Property Value StoreName Thumbprint The thumbprint of the certificate Declaration public string Thumbprint { get; set; } Property Value String" }, "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationOptions.html": { "href": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationOptions.html", "title": "Class PnPCoreAuthenticationOptions | PnP Core SDK", - "keywords": "Class PnPCoreAuthenticationOptions Options for configuring the PnP Core SDK Authentication Providers Inheritance Object PnPCoreAuthenticationOptions Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationOptions : object Properties AzureADLoginAuthority Returns the Azure AD Login authority (e.g. login.microsoftonline.com) to use when Environment is set to Custom Declaration public string AzureADLoginAuthority { get; set; } Property Value String Credentials The credential options Declaration public PnPCoreAuthenticationCredentialsOptions Credentials { get; set; } Property Value PnPCoreAuthenticationCredentialsOptions Environment The Microsoft 365 cloud environment that's used Declaration public string Environment { get; set; } Property Value String Sites The sites options Declaration public PnPCoreAuthenticationSitesOptions Sites { get; } Property Value PnPCoreAuthenticationSitesOptions" + "keywords": "Class PnPCoreAuthenticationOptions Options for configuring the PnP Core SDK Authentication Providers Inheritance System.Object PnPCoreAuthenticationOptions Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationOptions : object Properties AzureADLoginAuthority Returns the Azure AD Login authority (e.g. login.microsoftonline.com) to use when Environment is set to Custom Declaration public string AzureADLoginAuthority { get; set; } Property Value String Credentials The credential options Declaration public PnPCoreAuthenticationCredentialsOptions Credentials { get; set; } Property Value PnPCoreAuthenticationCredentialsOptions Environment The Microsoft 365 cloud environment that's used Declaration public string Environment { get; set; } Property Value String Sites The sites options Declaration public PnPCoreAuthenticationSitesOptions Sites { get; } Property Value PnPCoreAuthenticationSitesOptions" }, "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationSiteOptions.html": { "href": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationSiteOptions.html", "title": "Class PnPCoreAuthenticationSiteOptions | PnP Core SDK", - "keywords": "Class PnPCoreAuthenticationSiteOptions Options for configuring a single site in PnP Core SDK Inheritance Object PnPCoreAuthenticationSiteOptions Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationSiteOptions : object Properties AuthenticationProviderName The Authentication Provider name Declaration public string AuthenticationProviderName { get; set; } Property Value String" + "keywords": "Class PnPCoreAuthenticationSiteOptions Options for configuring a single site in PnP Core SDK Inheritance System.Object PnPCoreAuthenticationSiteOptions Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationSiteOptions : object Properties AuthenticationProviderName The Authentication Provider name Declaration public string AuthenticationProviderName { get; set; } Property Value String" }, "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationSitesOptions.html": { "href": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationSitesOptions.html", "title": "Class PnPCoreAuthenticationSitesOptions | PnP Core SDK", - "keywords": "Class PnPCoreAuthenticationSitesOptions Options for configuring PnP Core SDK Inheritance Object PnPCoreAuthenticationSitesOptions Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationSitesOptions : Dictionary" + "keywords": "Class PnPCoreAuthenticationSitesOptions Options for configuring PnP Core SDK Inheritance System.Object PnPCoreAuthenticationSitesOptions Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationSitesOptions : Dictionary" }, "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationUsernamePasswordOptions.html": { "href": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationUsernamePasswordOptions.html", "title": "Class PnPCoreAuthenticationUsernamePasswordOptions | PnP Core SDK", - "keywords": "Class PnPCoreAuthenticationUsernamePasswordOptions Options for the UsernamePasswordAuthenticationProvider Inheritance Object PnPCoreAuthenticationBaseOptions PnPCoreAuthenticationUsernamePasswordOptions Inherited Members PnPCoreAuthenticationBaseOptions.RedirectUri PnPCoreAuthenticationBaseOptions.AuthorityUri Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationUsernamePasswordOptions : PnPCoreAuthenticationBaseOptions Properties Password The password for authentication Declaration public string Password { get; set; } Property Value String Username The username for authentication Declaration public string Username { get; set; } Property Value String" + "keywords": "Class PnPCoreAuthenticationUsernamePasswordOptions Options for the UsernamePasswordAuthenticationProvider Inheritance System.Object PnPCoreAuthenticationBaseOptions PnPCoreAuthenticationUsernamePasswordOptions Inherited Members PnPCoreAuthenticationBaseOptions.RedirectUri PnPCoreAuthenticationBaseOptions.AuthorityUri Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationUsernamePasswordOptions : PnPCoreAuthenticationBaseOptions Properties Password The password for authentication Declaration public string Password { get; set; } Property Value String Username The username for authentication Declaration public string Username { get; set; } Property Value String" }, "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationX509CertificateOptions.html": { "href": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationX509CertificateOptions.html", "title": "Class PnPCoreAuthenticationX509CertificateOptions | PnP Core SDK", - "keywords": "Class PnPCoreAuthenticationX509CertificateOptions Options for the X509CertificateAuthenticationProvider Inheritance Object PnPCoreAuthenticationBaseOptions PnPCoreAuthenticationX509CertificateOptions Inherited Members PnPCoreAuthenticationBaseOptions.RedirectUri PnPCoreAuthenticationBaseOptions.AuthorityUri Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationX509CertificateOptions : PnPCoreAuthenticationBaseOptions Properties Certificate Certificate can be set directly, if required Declaration public X509Certificate2 Certificate { get; set; } Property Value X509Certificate2 StoreLocation The location in the certificate store Declaration public StoreLocation StoreLocation { get; set; } Property Value StoreLocation StoreName The name of the certificate store Declaration public StoreName StoreName { get; set; } Property Value StoreName Thumbprint The thumbprint of the certificate Declaration public string Thumbprint { get; set; } Property Value String" + "keywords": "Class PnPCoreAuthenticationX509CertificateOptions Options for the X509CertificateAuthenticationProvider Inheritance System.Object PnPCoreAuthenticationBaseOptions PnPCoreAuthenticationX509CertificateOptions Inherited Members PnPCoreAuthenticationBaseOptions.RedirectUri PnPCoreAuthenticationBaseOptions.AuthorityUri Namespace : PnP.Core.Auth.Services.Builder.Configuration Assembly : PnP.Core.Auth.dll Syntax public class PnPCoreAuthenticationX509CertificateOptions : PnPCoreAuthenticationBaseOptions Properties Certificate Certificate can be set directly, if required Declaration public X509Certificate2 Certificate { get; set; } Property Value X509Certificate2 StoreLocation The location in the certificate store Declaration public StoreLocation StoreLocation { get; set; } Property Value StoreLocation StoreName The name of the certificate store Declaration public StoreName StoreName { get; set; } Property Value StoreName Thumbprint The thumbprint of the certificate Declaration public string Thumbprint { get; set; } Property Value String" }, "api/PnP.Core.Auth.Services.html": { "href": "api/PnP.Core.Auth.Services.html", @@ -597,7 +597,7 @@ "api/PnP.Core.Auth.Services.Http.MsalHttpClientFactory.html": { "href": "api/PnP.Core.Auth.Services.Http.MsalHttpClientFactory.html", "title": "Class MsalHttpClientFactory | PnP Core SDK", - "keywords": "Class MsalHttpClientFactory Factory responsible for creating HttpClient as .NET recommends to use a single instance of HttpClient. Inheritance Object MsalHttpClientFactory Namespace : PnP.Core.Auth.Services.Http Assembly : PnP.Core.Auth.dll Syntax public sealed class MsalHttpClientFactory : IMsalHttpClientFactory Constructors MsalHttpClientFactory(IHttpClientFactory) Default Constructor Declaration public MsalHttpClientFactory(IHttpClientFactory httpClientFactory) Parameters IHttpClientFactory httpClientFactory Client factory that will handle the creation Methods GetHttpClient() Returns the configured Declaration public HttpClient GetHttpClient() Returns HttpClient The configured" + "keywords": "Class MsalHttpClientFactory Factory responsible for creating HttpClient as .NET recommends to use a single instance of HttpClient. Inheritance System.Object MsalHttpClientFactory Namespace : PnP.Core.Auth.Services.Http Assembly : PnP.Core.Auth.dll Syntax public sealed class MsalHttpClientFactory : IMsalHttpClientFactory Constructors MsalHttpClientFactory(IHttpClientFactory) Default Constructor Declaration public MsalHttpClientFactory(IHttpClientFactory httpClientFactory) Parameters IHttpClientFactory httpClientFactory Client factory that will handle the creation Methods GetHttpClient() Returns the configured Declaration public HttpClient GetHttpClient() Returns HttpClient The configured" }, "api/PnP.Core.Auth.Services.IAuthenticationProviderFactory.html": { "href": "api/PnP.Core.Auth.Services.IAuthenticationProviderFactory.html", @@ -612,47 +612,47 @@ "api/PnP.Core.Auth.UsernamePasswordAuthenticationProvider.html": { "href": "api/PnP.Core.Auth.UsernamePasswordAuthenticationProvider.html", "title": "Class UsernamePasswordAuthenticationProvider | PnP Core SDK", - "keywords": "Class UsernamePasswordAuthenticationProvider Authentication Provider that uses a Resource Owner Password Credentials (ROCP) credential flow Inheritance Object OAuthAuthenticationProvider UsernamePasswordAuthenticationProvider Inherited Members OAuthAuthenticationProvider.ConfigurationName OAuthAuthenticationProvider.ClientId OAuthAuthenticationProvider.TenantId OAuthAuthenticationProvider.DefaultAADAppId Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public sealed class UsernamePasswordAuthenticationProvider : OAuthAuthenticationProvider, IAuthenticationProvider Remarks You can find further details about ROPC here: https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth-ropc Constructors UsernamePasswordAuthenticationProvider(ILogger, IMsalHttpClientFactory) Public constructor leveraging DI to initialize the ILogger and IMsalHttpClientFactory interfaces Declaration public UsernamePasswordAuthenticationProvider(ILogger logger, IMsalHttpClientFactory msalHttpClientFactory) Parameters ILogger < OAuthAuthenticationProvider > logger The instance of the logger service provided by DI IMsalHttpClientFactory msalHttpClientFactory The instance of the Msal Http Client Factory service provided by DI UsernamePasswordAuthenticationProvider(String, String, PnPCoreAuthenticationUsernamePasswordOptions) Public constructor for external consumers of the library Declaration public UsernamePasswordAuthenticationProvider(string clientId, string tenantId, PnPCoreAuthenticationUsernamePasswordOptions options) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider PnPCoreAuthenticationUsernamePasswordOptions options Options for the authentication provider UsernamePasswordAuthenticationProvider(String, String, String, SecureString) Public constructor for external consumers of the library Declaration public UsernamePasswordAuthenticationProvider(string clientId, string tenantId, string username, SecureString password) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider String username The Username for authentication SecureString password The Password for authentication Properties Password The password for authenticating Declaration public SecureString Password { get; set; } Property Value SecureString Username The username for authenticating Declaration public string Username { get; set; } Property Value String Methods AuthenticateRequestAsync(Uri, HttpRequestMessage) Authenticates the specified request message. Declaration public override async Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request) Parameters Uri resource Request uri HttpRequestMessage request The to authenticate. Returns Task The task to await. Overrides OAuthAuthenticationProvider.AuthenticateRequestAsync(Uri, HttpRequestMessage) GetAccessTokenAsync(Uri) Gets an access token for the requested resource Declaration public override async Task GetAccessTokenAsync(Uri resource) Parameters Uri resource Resource to request an access token for Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri) GetAccessTokenAsync(Uri, String[]) Gets an access token for the requested resource and scope Declaration public override async Task GetAccessTokenAsync(Uri resource, string[] scopes) Parameters Uri resource Resource to request an access token for (unused) String [] scopes Scopes to request Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri, String[])" + "keywords": "Class UsernamePasswordAuthenticationProvider Authentication Provider that uses a Resource Owner Password Credentials (ROCP) credential flow Inheritance System.Object OAuthAuthenticationProvider UsernamePasswordAuthenticationProvider Inherited Members OAuthAuthenticationProvider.ConfigurationName OAuthAuthenticationProvider.ClientId OAuthAuthenticationProvider.TenantId OAuthAuthenticationProvider.DefaultAADAppId Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public sealed class UsernamePasswordAuthenticationProvider : OAuthAuthenticationProvider, IAuthenticationProvider Remarks You can find further details about ROPC here: https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth-ropc Constructors UsernamePasswordAuthenticationProvider(ILogger, IMsalHttpClientFactory) Public constructor leveraging DI to initialize the ILogger and IMsalHttpClientFactory interfaces Declaration public UsernamePasswordAuthenticationProvider(ILogger logger, IMsalHttpClientFactory msalHttpClientFactory) Parameters ILogger < OAuthAuthenticationProvider > logger The instance of the logger service provided by DI IMsalHttpClientFactory msalHttpClientFactory The instance of the Msal Http Client Factory service provided by DI UsernamePasswordAuthenticationProvider(String, String, PnPCoreAuthenticationUsernamePasswordOptions) Public constructor for external consumers of the library Declaration public UsernamePasswordAuthenticationProvider(string clientId, string tenantId, PnPCoreAuthenticationUsernamePasswordOptions options) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider PnPCoreAuthenticationUsernamePasswordOptions options Options for the authentication provider UsernamePasswordAuthenticationProvider(String, String, String, SecureString) Public constructor for external consumers of the library Declaration public UsernamePasswordAuthenticationProvider(string clientId, string tenantId, string username, SecureString password) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider String username The Username for authentication SecureString password The Password for authentication Properties Password The password for authenticating Declaration public SecureString Password { get; set; } Property Value SecureString Username The username for authenticating Declaration public string Username { get; set; } Property Value String Methods AuthenticateRequestAsync(Uri, HttpRequestMessage) Authenticates the specified request message. Declaration public override async Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request) Parameters Uri resource Request uri HttpRequestMessage request The to authenticate. Returns Task The task to await. Overrides OAuthAuthenticationProvider.AuthenticateRequestAsync(Uri, HttpRequestMessage) GetAccessTokenAsync(Uri) Gets an access token for the requested resource Declaration public override async Task GetAccessTokenAsync(Uri resource) Parameters Uri resource Resource to request an access token for Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri) GetAccessTokenAsync(Uri, String[]) Gets an access token for the requested resource and scope Declaration public override async Task GetAccessTokenAsync(Uri resource, string[] scopes) Parameters Uri resource Resource to request an access token for (unused) String [] scopes Scopes to request Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri, String[])" }, "api/PnP.Core.Auth.X509CertificateAuthenticationProvider.html": { "href": "api/PnP.Core.Auth.X509CertificateAuthenticationProvider.html", "title": "Class X509CertificateAuthenticationProvider | PnP Core SDK", - "keywords": "Class X509CertificateAuthenticationProvider Authentication Provider based on the X.509 Certificate Inheritance Object OAuthAuthenticationProvider X509CertificateAuthenticationProvider Inherited Members OAuthAuthenticationProvider.ConfigurationName OAuthAuthenticationProvider.ClientId OAuthAuthenticationProvider.TenantId OAuthAuthenticationProvider.DefaultAADAppId Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public sealed class X509CertificateAuthenticationProvider : OAuthAuthenticationProvider, IAuthenticationProvider Constructors X509CertificateAuthenticationProvider(ILogger, IMsalHttpClientFactory) Public constructor leveraging DI to initialize the ILogger and IMsalHttpClientFactory interfaces Declaration public X509CertificateAuthenticationProvider(ILogger logger, IMsalHttpClientFactory msalHttpClientFactory) Parameters ILogger < OAuthAuthenticationProvider > logger The instance of the logger service provided by DI IMsalHttpClientFactory msalHttpClientFactory The instance of the Msal Http Client Factory service provided by DI X509CertificateAuthenticationProvider(String, String, PnPCoreAuthenticationX509CertificateOptions) Public constructor for external consumers of the library Declaration public X509CertificateAuthenticationProvider(string clientId, string tenantId, PnPCoreAuthenticationX509CertificateOptions options) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider PnPCoreAuthenticationX509CertificateOptions options Options for the authentication provider X509CertificateAuthenticationProvider(String, String, StoreName, StoreLocation, String) Public constructor for external consumers of the library Declaration public X509CertificateAuthenticationProvider(string clientId, string tenantId, StoreName storeName, StoreLocation storeLocation, string thumbprint) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider StoreName storeName The Store Name to get the X.509 certificate from StoreLocation storeLocation The Store Location to get the X.509 certificate from String thumbprint The Thumbprint of the X.509 certificate X509CertificateAuthenticationProvider(String, String, X509Certificate2) Public constructor for external consumers of the library Declaration public X509CertificateAuthenticationProvider(string clientId, string tenantId, X509Certificate2 certificate) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider X509Certificate2 certificate The X.509 certificate to use for authentication Properties Certificate The X.509 Certificate to use for app authentication Declaration public X509Certificate2 Certificate { get; set; } Property Value X509Certificate2 Methods AuthenticateRequestAsync(Uri, HttpRequestMessage) Authenticates the specified request message. Declaration public override async Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request) Parameters Uri resource Request uri HttpRequestMessage request The to authenticate. Returns Task The task to await. Overrides OAuthAuthenticationProvider.AuthenticateRequestAsync(Uri, HttpRequestMessage) GetAccessTokenAsync(Uri) Gets an access token for the requested resource Declaration public override async Task GetAccessTokenAsync(Uri resource) Parameters Uri resource Resource to request an access token for Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri) GetAccessTokenAsync(Uri, String[]) Gets an access token for the requested resource and scope Declaration public override async Task GetAccessTokenAsync(Uri resource, string[] scopes) Parameters Uri resource Resource to request an access token for (unused) String [] scopes Scopes to request Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri, String[])" + "keywords": "Class X509CertificateAuthenticationProvider Authentication Provider based on the X.509 Certificate Inheritance System.Object OAuthAuthenticationProvider X509CertificateAuthenticationProvider Inherited Members OAuthAuthenticationProvider.ConfigurationName OAuthAuthenticationProvider.ClientId OAuthAuthenticationProvider.TenantId OAuthAuthenticationProvider.DefaultAADAppId Namespace : PnP.Core.Auth Assembly : PnP.Core.Auth.dll Syntax public sealed class X509CertificateAuthenticationProvider : OAuthAuthenticationProvider, IAuthenticationProvider Constructors X509CertificateAuthenticationProvider(ILogger, IMsalHttpClientFactory) Public constructor leveraging DI to initialize the ILogger and IMsalHttpClientFactory interfaces Declaration public X509CertificateAuthenticationProvider(ILogger logger, IMsalHttpClientFactory msalHttpClientFactory) Parameters ILogger < OAuthAuthenticationProvider > logger The instance of the logger service provided by DI IMsalHttpClientFactory msalHttpClientFactory The instance of the Msal Http Client Factory service provided by DI X509CertificateAuthenticationProvider(String, String, PnPCoreAuthenticationX509CertificateOptions) Public constructor for external consumers of the library Declaration public X509CertificateAuthenticationProvider(string clientId, string tenantId, PnPCoreAuthenticationX509CertificateOptions options) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider PnPCoreAuthenticationX509CertificateOptions options Options for the authentication provider X509CertificateAuthenticationProvider(String, String, StoreName, StoreLocation, String) Public constructor for external consumers of the library Declaration public X509CertificateAuthenticationProvider(string clientId, string tenantId, StoreName storeName, StoreLocation storeLocation, string thumbprint) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider StoreName storeName The Store Name to get the X.509 certificate from StoreLocation storeLocation The Store Location to get the X.509 certificate from String thumbprint The Thumbprint of the X.509 certificate X509CertificateAuthenticationProvider(String, String, X509Certificate2) Public constructor for external consumers of the library Declaration public X509CertificateAuthenticationProvider(string clientId, string tenantId, X509Certificate2 certificate) Parameters String clientId The Client ID for the Authentication Provider String tenantId The Tenant ID for the Authentication Provider X509Certificate2 certificate The X.509 certificate to use for authentication Properties Certificate The X.509 Certificate to use for app authentication Declaration public X509Certificate2 Certificate { get; set; } Property Value X509Certificate2 Methods AuthenticateRequestAsync(Uri, HttpRequestMessage) Authenticates the specified request message. Declaration public override async Task AuthenticateRequestAsync(Uri resource, HttpRequestMessage request) Parameters Uri resource Request uri HttpRequestMessage request The to authenticate. Returns Task The task to await. Overrides OAuthAuthenticationProvider.AuthenticateRequestAsync(Uri, HttpRequestMessage) GetAccessTokenAsync(Uri) Gets an access token for the requested resource Declaration public override async Task GetAccessTokenAsync(Uri resource) Parameters Uri resource Resource to request an access token for Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri) GetAccessTokenAsync(Uri, String[]) Gets an access token for the requested resource and scope Declaration public override async Task GetAccessTokenAsync(Uri resource, string[] scopes) Parameters Uri resource Resource to request an access token for (unused) String [] scopes Scopes to request Returns Task < String > An access token Overrides OAuthAuthenticationProvider.GetAccessTokenAsync(Uri, String[])" }, "api/PnP.Core.AuthenticationError.html": { "href": "api/PnP.Core.AuthenticationError.html", "title": "Class AuthenticationError | PnP Core SDK", - "keywords": "Class AuthenticationError Error class for authentication errors Inheritance Object BaseError AuthenticationError Inherited Members BaseError.Type BaseError.PnPCorrelationId BaseError.AdditionalData BaseError.AddAdditionalData(String, Object) Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class AuthenticationError : BaseError Constructors AuthenticationError(ErrorType, JsonElement) Constructs an AuthenticationError instance Declaration public AuthenticationError(ErrorType type, JsonElement error) Parameters ErrorType type Type of the error JsonElement error Error content as AuthenticationError(ErrorType, String) Constructs an AuthenticationError instance Declaration public AuthenticationError(ErrorType type, string error) Parameters ErrorType type Type of the error String error Error content as Properties Code Error code Declaration public string Code { get; } Property Value String CorrelationId Correlation id Declaration public Guid CorrelationId { get; } Property Value Guid ErrorCodes List of returned error codes Declaration public List ErrorCodes { get; } Property Value List < Int64 > Message Error message Declaration public string Message { get; } Property Value String TimeStamp Time the error happened Declaration public string TimeStamp { get; } Property Value String TraceId Trace id Declaration public Guid TraceId { get; } Property Value Guid Methods ToString() Outputs a AuthenticationError to a string representation Declaration public override string ToString() Returns String String representation" + "keywords": "Class AuthenticationError Error class for authentication errors Inheritance System.Object BaseError AuthenticationError Inherited Members BaseError.Type BaseError.PnPCorrelationId BaseError.AdditionalData BaseError.AddAdditionalData(String, Object) Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class AuthenticationError : BaseError Constructors AuthenticationError(ErrorType, JsonElement) Constructs an AuthenticationError instance Declaration public AuthenticationError(ErrorType type, JsonElement error) Parameters ErrorType type Type of the error JsonElement error Error content as AuthenticationError(ErrorType, String) Constructs an AuthenticationError instance Declaration public AuthenticationError(ErrorType type, string error) Parameters ErrorType type Type of the error String error Error content as Properties Code Error code Declaration public string Code { get; } Property Value String CorrelationId Correlation id Declaration public Guid CorrelationId { get; } Property Value Guid ErrorCodes List of returned error codes Declaration public List ErrorCodes { get; } Property Value List < Int64 > Message Error message Declaration public string Message { get; } Property Value String TimeStamp Time the error happened Declaration public string TimeStamp { get; } Property Value String TraceId Trace id Declaration public Guid TraceId { get; } Property Value Guid Methods ToString() Outputs a AuthenticationError to a string representation Declaration public override string ToString() Returns String String representation" }, "api/PnP.Core.AuthenticationException.html": { "href": "api/PnP.Core.AuthenticationException.html", "title": "Class AuthenticationException | PnP Core SDK", - "keywords": "Class AuthenticationException Authentication exception Inheritance Object PnPException AuthenticationException Inherited Members PnPException.Error Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class AuthenticationException : PnPException Constructors AuthenticationException(ErrorType, String) AuthenticationException constructor Declaration public AuthenticationException(ErrorType type, string message) Parameters ErrorType type Type of error String message Error message AuthenticationException(ErrorType, String, Exception) AuthenticationException constructor Declaration public AuthenticationException(ErrorType type, string message, Exception innerException) Parameters ErrorType type Type of error String message Error message Exception innerException Inner exception (if any) Methods ToString() Outputs a AuthenticationException to a string representation Declaration public override string ToString() Returns String String representation" + "keywords": "Class AuthenticationException Authentication exception Inheritance System.Object PnPException AuthenticationException Inherited Members PnPException.Error Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class AuthenticationException : PnPException Constructors AuthenticationException(ErrorType, String) AuthenticationException constructor Declaration public AuthenticationException(ErrorType type, string message) Parameters ErrorType type Type of error String message Error message AuthenticationException(ErrorType, String, Exception) AuthenticationException constructor Declaration public AuthenticationException(ErrorType type, string message, Exception innerException) Parameters ErrorType type Type of error String message Error message Exception innerException Inner exception (if any) Methods ToString() Outputs a AuthenticationException to a string representation Declaration public override string ToString() Returns String String representation" }, "api/PnP.Core.BaseError.html": { "href": "api/PnP.Core.BaseError.html", "title": "Class BaseError | PnP Core SDK", - "keywords": "Class BaseError Base error information Inheritance Object BaseError AuthenticationError ClientError ServiceError Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public abstract class BaseError : object Constructors BaseError(ErrorType) Default base constructor/> Declaration public BaseError(ErrorType type) Parameters ErrorType type Type of the error Properties AdditionalData Additional data linked to an error Declaration public IDictionary AdditionalData { get; } Property Value IDictionary < String , Object > PnPCorrelationId Correlation for a PnP Core SDK operation Declaration public Guid PnPCorrelationId { get; } Property Value Guid Type ErrorType of the error Declaration public ErrorType Type { get; } Property Value ErrorType Methods AddAdditionalData(String, Object) Adds additional error data to this error as property/value pairs Declaration protected void AddAdditionalData(string propertyName, object propertyValue) Parameters String propertyName Property to add Object propertyValue Value to add" + "keywords": "Class BaseError Base error information Inheritance System.Object BaseError AuthenticationError ClientError ServiceError Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public abstract class BaseError : object Constructors BaseError(ErrorType) Default base constructor/> Declaration public BaseError(ErrorType type) Parameters ErrorType type Type of the error Properties AdditionalData Additional data linked to an error Declaration public IDictionary AdditionalData { get; } Property Value IDictionary < String , System.Object > PnPCorrelationId Correlation for a PnP Core SDK operation Declaration public Guid PnPCorrelationId { get; } Property Value Guid Type ErrorType of the error Declaration public ErrorType Type { get; } Property Value ErrorType Methods AddAdditionalData(String, Object) Adds additional error data to this error as property/value pairs Declaration protected void AddAdditionalData(string propertyName, object propertyValue) Parameters String propertyName Property to add System.Object propertyValue Value to add" }, "api/PnP.Core.ClientError.html": { "href": "api/PnP.Core.ClientError.html", "title": "Class ClientError | PnP Core SDK", - "keywords": "Class ClientError Information about the client error Inheritance Object BaseError ClientError Inherited Members BaseError.Type BaseError.PnPCorrelationId BaseError.AdditionalData BaseError.AddAdditionalData(String, Object) Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class ClientError : BaseError Constructors ClientError(ErrorType, String) ClientError constructor, creates a ClientError for the provided error type and message Declaration public ClientError(ErrorType type, string message) Parameters ErrorType type Type of the error String message Error message Properties Message Error message that was linked to the client error Declaration public string Message { get; } Property Value String" + "keywords": "Class ClientError Information about the client error Inheritance System.Object BaseError ClientError Inherited Members BaseError.Type BaseError.PnPCorrelationId BaseError.AdditionalData BaseError.AddAdditionalData(String, Object) Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class ClientError : BaseError Constructors ClientError(ErrorType, String) ClientError constructor, creates a ClientError for the provided error type and message Declaration public ClientError(ErrorType type, string message) Parameters ErrorType type Type of the error String message Error message Properties Message Error message that was linked to the client error Declaration public string Message { get; } Property Value String" }, "api/PnP.Core.ClientException.html": { "href": "api/PnP.Core.ClientException.html", "title": "Class ClientException | PnP Core SDK", - "keywords": "Class ClientException PnP Client exception Inheritance Object PnPException ClientException Inherited Members PnPException.Error Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class ClientException : PnPException Constructors ClientException(ErrorType, String) ClientException constructor Declaration public ClientException(ErrorType type, string message) Parameters ErrorType type Type of the error String message Error message ClientException(ErrorType, String, Exception) ClientException constructor Declaration public ClientException(ErrorType type, string message, Exception innerException) Parameters ErrorType type Type of the error String message Error message Exception innerException Inner exception to link to this exception Methods ToString() Outputs a ClientException to a string representation Declaration public override string ToString() Returns String String representation" + "keywords": "Class ClientException PnP Client exception Inheritance System.Object PnPException ClientException Inherited Members PnPException.Error Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class ClientException : PnPException Constructors ClientException(ErrorType, String) ClientException constructor Declaration public ClientException(ErrorType type, string message) Parameters ErrorType type Type of the error String message Error message ClientException(ErrorType, String, Exception) ClientException constructor Declaration public ClientException(ErrorType type, string message, Exception innerException) Parameters ErrorType type Type of the error String message Error message Exception innerException Inner exception to link to this exception Methods ToString() Outputs a ClientException to a string representation Declaration public override string ToString() Returns String String representation" }, "api/PnP.Core.CsomError.html": { "href": "api/PnP.Core.CsomError.html", "title": "Class CsomError | PnP Core SDK", - "keywords": "Class CsomError Csom service error Inheritance Object BaseError ServiceError CsomError Inherited Members ServiceError.HttpResponseCode ServiceError.Message ServiceError.ClientRequestId ServiceError.Code BaseError.Type BaseError.PnPCorrelationId BaseError.AdditionalData BaseError.AddAdditionalData(String, Object) Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class CsomError : ServiceError Constructors CsomError(ErrorType, Int32, JsonElement) Default constructor for the SharePointRestError error Declaration public CsomError(ErrorType type, int httpResponseCode, JsonElement errorJson) Parameters ErrorType type ErrorType type of the error Int32 httpResponseCode Http response code of the service request that failed JsonElement errorJson Json containing the error information Properties ServerErrorCode SharePoint server error code Declaration public long ServerErrorCode { get; } Property Value Int64 Methods ToString() Outputs a CsomError to a string representation Declaration public override string ToString() Returns String String representation" + "keywords": "Class CsomError Csom service error Inheritance System.Object BaseError ServiceError CsomError Inherited Members ServiceError.HttpResponseCode ServiceError.Message ServiceError.ClientRequestId ServiceError.Code BaseError.Type BaseError.PnPCorrelationId BaseError.AdditionalData BaseError.AddAdditionalData(String, Object) Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class CsomError : ServiceError Constructors CsomError(ErrorType, Int32, JsonElement) Default constructor for the SharePointRestError error Declaration public CsomError(ErrorType type, int httpResponseCode, JsonElement errorJson) Parameters ErrorType type ErrorType type of the error Int32 httpResponseCode Http response code of the service request that failed JsonElement errorJson Json containing the error information Properties ServerErrorCode SharePoint server error code Declaration public long ServerErrorCode { get; } Property Value Int64 Methods ToString() Outputs a CsomError to a string representation Declaration public override string ToString() Returns String String representation" }, "api/PnP.Core.CsomServiceException.html": { "href": "api/PnP.Core.CsomServiceException.html", "title": "Class CsomServiceException | PnP Core SDK", - "keywords": "Class CsomServiceException CSOM Service exception Inheritance Object PnPException ServiceException CsomServiceException Inherited Members PnPException.Error Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class CsomServiceException : ServiceException Constructors CsomServiceException(ErrorType, Int32, JsonElement) Creates a CsomServiceException using the provided error type, http response code and CSOM request response Declaration public CsomServiceException(ErrorType type, int httpResponseCode, JsonElement response) Parameters ErrorType type Type of the error Int32 httpResponseCode Http response code of the executed CSOM request JsonElement response JSON response of the executed CSOM request Methods ToString() Outputs a CsomServiceException to a string representation Declaration public override string ToString() Returns String String representation" + "keywords": "Class CsomServiceException CSOM Service exception Inheritance System.Object PnPException ServiceException CsomServiceException Inherited Members PnPException.Error Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class CsomServiceException : ServiceException Constructors CsomServiceException(ErrorType, Int32, JsonElement) Creates a CsomServiceException using the provided error type, http response code and CSOM request response Declaration public CsomServiceException(ErrorType type, int httpResponseCode, JsonElement response) Parameters ErrorType type Type of the error Int32 httpResponseCode Http response code of the executed CSOM request JsonElement response JSON response of the executed CSOM request Methods ToString() Outputs a CsomServiceException to a string representation Declaration public override string ToString() Returns String String representation" }, "api/PnP.Core.ErrorType.html": { "href": "api/PnP.Core.ErrorType.html", @@ -667,47 +667,47 @@ "api/PnP.Core.MicrosoftGraphError.html": { "href": "api/PnP.Core.MicrosoftGraphError.html", "title": "Class MicrosoftGraphError | PnP Core SDK", - "keywords": "Class MicrosoftGraphError Microsoft Graph service error Inheritance Object BaseError ServiceError MicrosoftGraphError Inherited Members ServiceError.HttpResponseCode ServiceError.Message ServiceError.ClientRequestId ServiceError.Code BaseError.Type BaseError.PnPCorrelationId BaseError.AdditionalData BaseError.AddAdditionalData(String, Object) Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class MicrosoftGraphError : ServiceError Constructors MicrosoftGraphError(ErrorType, Int32, JsonElement) Default constructor for the MicrosoftGraphError error Declaration public MicrosoftGraphError(ErrorType type, int httpResponseCode, JsonElement error) Parameters ErrorType type ErrorType type of the error Int32 httpResponseCode Http response code of the service request that failed JsonElement error holding the json data of the service error MicrosoftGraphError(ErrorType, Int32, String) Default constructor for the MicrosoftGraphError error Declaration public MicrosoftGraphError(ErrorType type, int httpResponseCode, string response) Parameters ErrorType type ErrorType type of the error Int32 httpResponseCode Http response code of the service request that failed String response String holding the information about the failed request Methods ToString() Outputs a MicrosoftGraphError to a string representation Declaration public override string ToString() Returns String String representation" + "keywords": "Class MicrosoftGraphError Microsoft Graph service error Inheritance System.Object BaseError ServiceError MicrosoftGraphError Inherited Members ServiceError.HttpResponseCode ServiceError.Message ServiceError.ClientRequestId ServiceError.Code BaseError.Type BaseError.PnPCorrelationId BaseError.AdditionalData BaseError.AddAdditionalData(String, Object) Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class MicrosoftGraphError : ServiceError Constructors MicrosoftGraphError(ErrorType, Int32, JsonElement) Default constructor for the MicrosoftGraphError error Declaration public MicrosoftGraphError(ErrorType type, int httpResponseCode, JsonElement error) Parameters ErrorType type ErrorType type of the error Int32 httpResponseCode Http response code of the service request that failed JsonElement error holding the json data of the service error MicrosoftGraphError(ErrorType, Int32, String) Default constructor for the MicrosoftGraphError error Declaration public MicrosoftGraphError(ErrorType type, int httpResponseCode, string response) Parameters ErrorType type ErrorType type of the error Int32 httpResponseCode Http response code of the service request that failed String response String holding the information about the failed request Methods ToString() Outputs a MicrosoftGraphError to a string representation Declaration public override string ToString() Returns String String representation" }, "api/PnP.Core.MicrosoftGraphServiceException.html": { "href": "api/PnP.Core.MicrosoftGraphServiceException.html", "title": "Class MicrosoftGraphServiceException | PnP Core SDK", - "keywords": "Class MicrosoftGraphServiceException Microsoft Graph Service exception Inheritance Object PnPException ServiceException MicrosoftGraphServiceException Inherited Members PnPException.Error Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class MicrosoftGraphServiceException : ServiceException Constructors MicrosoftGraphServiceException(ErrorType, Int32, JsonElement) Creates a MicrosoftGraphServiceException using the provided error type, http response code and request response Declaration public MicrosoftGraphServiceException(ErrorType type, int httpResponseCode, JsonElement error) Parameters ErrorType type Type of the error Int32 httpResponseCode Http response code of the executed Graph request JsonElement error Json error coming from the executed Graph request MicrosoftGraphServiceException(ErrorType, Int32, String) Creates a MicrosoftGraphServiceException using the provided error type, http response code and request response Declaration public MicrosoftGraphServiceException(ErrorType type, int httpResponseCode, string response) Parameters ErrorType type Type of the error Int32 httpResponseCode Http response code of the executed Graph request String response Response of the executed Graph request Methods ToString() Outputs a MicrosoftGraphServiceException to a string representation Declaration public override string ToString() Returns String String representation" + "keywords": "Class MicrosoftGraphServiceException Microsoft Graph Service exception Inheritance System.Object PnPException ServiceException MicrosoftGraphServiceException Inherited Members PnPException.Error Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class MicrosoftGraphServiceException : ServiceException Constructors MicrosoftGraphServiceException(ErrorType, Int32, JsonElement) Creates a MicrosoftGraphServiceException using the provided error type, http response code and request response Declaration public MicrosoftGraphServiceException(ErrorType type, int httpResponseCode, JsonElement error) Parameters ErrorType type Type of the error Int32 httpResponseCode Http response code of the executed Graph request JsonElement error Json error coming from the executed Graph request MicrosoftGraphServiceException(ErrorType, Int32, String) Creates a MicrosoftGraphServiceException using the provided error type, http response code and request response Declaration public MicrosoftGraphServiceException(ErrorType type, int httpResponseCode, string response) Parameters ErrorType type Type of the error Int32 httpResponseCode Http response code of the executed Graph request String response Response of the executed Graph request Methods ToString() Outputs a MicrosoftGraphServiceException to a string representation Declaration public override string ToString() Returns String String representation" }, "api/PnP.Core.Model.DataModelCollectionLoadExtensions.html": { "href": "api/PnP.Core.Model.DataModelCollectionLoadExtensions.html", "title": "Class DataModelCollectionLoadExtensions | PnP Core SDK", - "keywords": "Class DataModelCollectionLoadExtensions Extension methods for IDataModelCollectionLoad Inheritance Object DataModelCollectionLoadExtensions Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public static class DataModelCollectionLoadExtensions : object Methods Load(IDataModelCollectionLoad, Expression>[]) Loads the list from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static void Load(this IDataModelCollectionLoad dataModelLoad, params Expression>[] expressions) Parameters IDataModelCollectionLoad dataModelLoad Expression < Func >[] expressions The properties to select Type Parameters TModel LoadBatch(IDataModelCollectionLoad, Expression>[]) Batches the load of the list from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static IBatchResult LoadBatch(this IDataModelCollectionLoad dataModelLoad, params Expression>[] expressions) Parameters IDataModelCollectionLoad dataModelLoad Expression < Func >[] expressions The properties to select Returns IBatchResult The Domain Model object Type Parameters TModel LoadBatch(IDataModelCollectionLoad, Batch, Expression>[]) Batches the load of the list from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static IBatchResult LoadBatch(this IDataModelCollectionLoad dataModelLoad, Batch batch, params Expression>[] expressions) Parameters IDataModelCollectionLoad dataModelLoad Batch batch Batch add this request to Expression < Func >[] expressions The properties to select Returns IBatchResult The Domain Model object Type Parameters TModel LoadBatchAsync(IDataModelCollectionLoad, Expression>[]) Batches the load of the list from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static Task LoadBatchAsync(this IDataModelCollectionLoad dataModelLoad, params Expression>[] expressions) Parameters IDataModelCollectionLoad dataModelLoad Expression < Func >[] expressions The properties to select Returns Task < IBatchResult > The Domain Model object Type Parameters TModel LoadBatchAsync(IDataModelCollectionLoad, Batch, Expression>[]) Batches the load of the list from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static Task LoadBatchAsync(this IDataModelCollectionLoad dataModelLoad, Batch batch, params Expression>[] expressions) Parameters IDataModelCollectionLoad dataModelLoad Batch batch Batch add this request to Expression < Func >[] expressions The properties to select Returns Task < IBatchResult > The Domain Model object Type Parameters TModel" + "keywords": "Class DataModelCollectionLoadExtensions Extension methods for IDataModelCollectionLoad Inheritance System.Object DataModelCollectionLoadExtensions Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public static class DataModelCollectionLoadExtensions : object Methods Load(IDataModelCollectionLoad, Expression>[]) Loads the list from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static void Load(this IDataModelCollectionLoad dataModelLoad, params Expression>[] expressions) Parameters IDataModelCollectionLoad dataModelLoad Expression < Func >[] expressions The properties to select Type Parameters TModel LoadBatch(IDataModelCollectionLoad, Expression>[]) Batches the load of the list from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static IBatchResult LoadBatch(this IDataModelCollectionLoad dataModelLoad, params Expression>[] expressions) Parameters IDataModelCollectionLoad dataModelLoad Expression < Func >[] expressions The properties to select Returns IBatchResult The Domain Model object Type Parameters TModel LoadBatch(IDataModelCollectionLoad, Batch, Expression>[]) Batches the load of the list from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static IBatchResult LoadBatch(this IDataModelCollectionLoad dataModelLoad, Batch batch, params Expression>[] expressions) Parameters IDataModelCollectionLoad dataModelLoad Batch batch Batch add this request to Expression < Func >[] expressions The properties to select Returns IBatchResult The Domain Model object Type Parameters TModel LoadBatchAsync(IDataModelCollectionLoad, Expression>[]) Batches the load of the list from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static Task LoadBatchAsync(this IDataModelCollectionLoad dataModelLoad, params Expression>[] expressions) Parameters IDataModelCollectionLoad dataModelLoad Expression < Func >[] expressions The properties to select Returns Task < IBatchResult > The Domain Model object Type Parameters TModel LoadBatchAsync(IDataModelCollectionLoad, Batch, Expression>[]) Batches the load of the list from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static Task LoadBatchAsync(this IDataModelCollectionLoad dataModelLoad, Batch batch, params Expression>[] expressions) Parameters IDataModelCollectionLoad dataModelLoad Batch batch Batch add this request to Expression < Func >[] expressions The properties to select Returns Task < IBatchResult > The Domain Model object Type Parameters TModel" }, "api/PnP.Core.Model.DataModelGetExtensions.html": { "href": "api/PnP.Core.Model.DataModelGetExtensions.html", "title": "Class DataModelGetExtensions | PnP Core SDK", - "keywords": "Class DataModelGetExtensions Extension methods for PnP.Core.Model.IDataModelProcess Inheritance Object DataModelGetExtensions Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public static class DataModelGetExtensions : object Methods Get(IDataModelGet, Expression>[]) Retrieves a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static TModel Get(this IDataModelGet dataModelGet, params Expression>[] expressions) Parameters IDataModelGet dataModelGet Expression < Func >[] expressions The properties to select Returns TModel The Domain Model object Type Parameters TModel GetBatch(IDataModelGet, Expression>[]) Batches the retrieval of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static IBatchSingleResult GetBatch(this IDataModelGet dataModelGet, params Expression>[] expressions) Parameters IDataModelGet dataModelGet Expression < Func >[] expressions The properties to select Returns IBatchSingleResult The Domain Model object Type Parameters TModel GetBatch(IDataModelGet, Batch, Expression>[]) Batches the retrieval of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static IBatchSingleResult GetBatch(this IDataModelGet dataModelGet, Batch batch, params Expression>[] expressions) Parameters IDataModelGet dataModelGet Batch batch Batch add this request to Expression < Func >[] expressions The properties to select Returns IBatchSingleResult The Domain Model object Type Parameters TModel GetBatchAsync(IDataModelGet, Expression>[]) Batches the retrieval of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static Task> GetBatchAsync(this IDataModelGet dataModelGet, params Expression>[] expressions) Parameters IDataModelGet dataModelGet Expression < Func >[] expressions The properties to select Returns Task < IBatchSingleResult > The Domain Model object Type Parameters TModel GetBatchAsync(IDataModelGet, Batch, Expression>[]) Batches the retrieval of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static Task> GetBatchAsync(this IDataModelGet dataModelGet, Batch batch, params Expression>[] expressions) Parameters IDataModelGet dataModelGet Batch batch Batch add this request to Expression < Func >[] expressions The properties to select Returns Task < IBatchSingleResult > The Domain Model object Type Parameters TModel" + "keywords": "Class DataModelGetExtensions Extension methods for PnP.Core.Model.IDataModelProcess Inheritance System.Object DataModelGetExtensions Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public static class DataModelGetExtensions : object Methods Get(IDataModelGet, Expression>[]) Retrieves a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static TModel Get(this IDataModelGet dataModelGet, params Expression>[] expressions) Parameters IDataModelGet dataModelGet Expression < Func >[] expressions The properties to select Returns TModel The Domain Model object Type Parameters TModel GetBatch(IDataModelGet, Expression>[]) Batches the retrieval of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static IBatchSingleResult GetBatch(this IDataModelGet dataModelGet, params Expression>[] expressions) Parameters IDataModelGet dataModelGet Expression < Func >[] expressions The properties to select Returns IBatchSingleResult The Domain Model object Type Parameters TModel GetBatch(IDataModelGet, Batch, Expression>[]) Batches the retrieval of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static IBatchSingleResult GetBatch(this IDataModelGet dataModelGet, Batch batch, params Expression>[] expressions) Parameters IDataModelGet dataModelGet Batch batch Batch add this request to Expression < Func >[] expressions The properties to select Returns IBatchSingleResult The Domain Model object Type Parameters TModel GetBatchAsync(IDataModelGet, Expression>[]) Batches the retrieval of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static Task> GetBatchAsync(this IDataModelGet dataModelGet, params Expression>[] expressions) Parameters IDataModelGet dataModelGet Expression < Func >[] expressions The properties to select Returns Task < IBatchSingleResult > The Domain Model object Type Parameters TModel GetBatchAsync(IDataModelGet, Batch, Expression>[]) Batches the retrieval of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static Task> GetBatchAsync(this IDataModelGet dataModelGet, Batch batch, params Expression>[] expressions) Parameters IDataModelGet dataModelGet Batch batch Batch add this request to Expression < Func >[] expressions The properties to select Returns Task < IBatchSingleResult > The Domain Model object Type Parameters TModel" }, "api/PnP.Core.Model.DataModelLoadExtensions.html": { "href": "api/PnP.Core.Model.DataModelLoadExtensions.html", "title": "Class DataModelLoadExtensions | PnP Core SDK", - "keywords": "Class DataModelLoadExtensions Extension methods for PnP.Core.Model.IDataModelLoad Inheritance Object DataModelLoadExtensions Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public static class DataModelLoadExtensions : object Methods Load(IDataModelLoad, Expression>[]) Loads a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static void Load(this IDataModelLoad dataModelLoad, params Expression>[] expressions) Parameters IDataModelLoad dataModelLoad Expression < Func >[] expressions The properties to select Type Parameters TModel LoadBatch(IDataModelLoad, Expression>[]) Batches the load of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static IBatchResult LoadBatch(this IDataModelLoad dataModelLoad, params Expression>[] expressions) Parameters IDataModelLoad dataModelLoad Expression < Func >[] expressions The properties to select Returns IBatchResult The Domain Model object Type Parameters TModel LoadBatch(IDataModelLoad, Batch, Expression>[]) Batches the load of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static IBatchResult LoadBatch(this IDataModelLoad dataModelLoad, Batch batch, params Expression>[] expressions) Parameters IDataModelLoad dataModelLoad Batch batch Batch add this request to Expression < Func >[] expressions The properties to select Returns IBatchResult The Domain Model object Type Parameters TModel LoadBatchAsync(IDataModelLoad, Expression>[]) Batches the load of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static Task LoadBatchAsync(this IDataModelLoad dataModelLoad, params Expression>[] expressions) Parameters IDataModelLoad dataModelLoad Expression < Func >[] expressions The properties to select Returns Task < IBatchResult > The Domain Model object Type Parameters TModel LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) Batches the load of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static Task LoadBatchAsync(this IDataModelLoad dataModelLoad, Batch batch, params Expression>[] expressions) Parameters IDataModelLoad dataModelLoad Batch batch Batch add this request to Expression < Func >[] expressions The properties to select Returns Task < IBatchResult > The Domain Model object Type Parameters TModel QueryProperties(IDataModelLoad, Expression>[]) Loads a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static TModel QueryProperties(this IDataModelLoad dataModel, params Expression>[] expressions) Parameters IDataModelLoad dataModel Expression < Func >[] expressions The properties to select Returns TModel The Domain Model object Type Parameters TModel" + "keywords": "Class DataModelLoadExtensions Extension methods for PnP.Core.Model.IDataModelLoad Inheritance System.Object DataModelLoadExtensions Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public static class DataModelLoadExtensions : object Methods Load(IDataModelLoad, Expression>[]) Loads a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static void Load(this IDataModelLoad dataModelLoad, params Expression>[] expressions) Parameters IDataModelLoad dataModelLoad Expression < Func >[] expressions The properties to select Type Parameters TModel LoadBatch(IDataModelLoad, Expression>[]) Batches the load of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static IBatchResult LoadBatch(this IDataModelLoad dataModelLoad, params Expression>[] expressions) Parameters IDataModelLoad dataModelLoad Expression < Func >[] expressions The properties to select Returns IBatchResult The Domain Model object Type Parameters TModel LoadBatch(IDataModelLoad, Batch, Expression>[]) Batches the load of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static IBatchResult LoadBatch(this IDataModelLoad dataModelLoad, Batch batch, params Expression>[] expressions) Parameters IDataModelLoad dataModelLoad Batch batch Batch add this request to Expression < Func >[] expressions The properties to select Returns IBatchResult The Domain Model object Type Parameters TModel LoadBatchAsync(IDataModelLoad, Expression>[]) Batches the load of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static Task LoadBatchAsync(this IDataModelLoad dataModelLoad, params Expression>[] expressions) Parameters IDataModelLoad dataModelLoad Expression < Func >[] expressions The properties to select Returns Task < IBatchResult > The Domain Model object Type Parameters TModel LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) Batches the load of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static Task LoadBatchAsync(this IDataModelLoad dataModelLoad, Batch batch, params Expression>[] expressions) Parameters IDataModelLoad dataModelLoad Batch batch Batch add this request to Expression < Func >[] expressions The properties to select Returns Task < IBatchResult > The Domain Model object Type Parameters TModel QueryProperties(IDataModelLoad, Expression>[]) Loads a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration public static TModel QueryProperties(this IDataModelLoad dataModel, params Expression>[] expressions) Parameters IDataModelLoad dataModel Expression < Func >[] expressions The properties to select Returns TModel The Domain Model object Type Parameters TModel" }, "api/PnP.Core.Model.FollowDocumentData.html": { "href": "api/PnP.Core.Model.FollowDocumentData.html", "title": "Class FollowDocumentData | PnP Core SDK", - "keywords": "Class FollowDocumentData A follow document request metadata object Inheritance Object FollowData FollowDocumentData Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public class FollowDocumentData : FollowData Properties ActorType Represents an actor type. Can be either a user, site, document or tag Declaration public override SocialActorType ActorType { get; } Property Value SocialActorType Overrides FollowData.ActorType ContentUri The unique url for the site. Declaration public string ContentUri { get; set; } Property Value String" + "keywords": "Class FollowDocumentData A follow document request metadata object Inheritance System.Object FollowData FollowDocumentData Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public class FollowDocumentData : FollowData Properties ActorType Represents an actor type. Can be either a user, site, document or tag Declaration public override SocialActorType ActorType { get; } Property Value SocialActorType Overrides FollowData.ActorType ContentUri The unique url for the site. Declaration public string ContentUri { get; set; } Property Value String" }, "api/PnP.Core.Model.FollowPersonData.html": { "href": "api/PnP.Core.Model.FollowPersonData.html", "title": "Class FollowPersonData | PnP Core SDK", - "keywords": "Class FollowPersonData A follow person request metadata object Inheritance Object FollowData FollowPersonData Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public class FollowPersonData : FollowData Properties AccountName The account name in a form of \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com". Declaration public string AccountName { get; set; } Property Value String ActorType Represents an actor type. Can be either a user, site, document or tag Declaration public override SocialActorType ActorType { get; } Property Value SocialActorType Overrides FollowData.ActorType" + "keywords": "Class FollowPersonData A follow person request metadata object Inheritance System.Object FollowData FollowPersonData Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public class FollowPersonData : FollowData Properties AccountName The account name in a form of \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com". Declaration public string AccountName { get; set; } Property Value String ActorType Represents an actor type. Can be either a user, site, document or tag Declaration public override SocialActorType ActorType { get; } Property Value SocialActorType Overrides FollowData.ActorType" }, "api/PnP.Core.Model.FollowSiteData.html": { "href": "api/PnP.Core.Model.FollowSiteData.html", "title": "Class FollowSiteData | PnP Core SDK", - "keywords": "Class FollowSiteData A follow site request metadata object Inheritance Object FollowData FollowSiteData Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public class FollowSiteData : FollowData Properties ActorType Represents an actor type. Can be either a user, site, document or tag Declaration public override SocialActorType ActorType { get; } Property Value SocialActorType Overrides FollowData.ActorType ContentUri The unique url for the site. Declaration public string ContentUri { get; set; } Property Value String" + "keywords": "Class FollowSiteData A follow site request metadata object Inheritance System.Object FollowData FollowSiteData Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public class FollowSiteData : FollowData Properties ActorType Represents an actor type. Can be either a user, site, document or tag Declaration public override SocialActorType ActorType { get; } Property Value SocialActorType Overrides FollowData.ActorType ContentUri The unique url for the site. Declaration public string ContentUri { get; set; } Property Value String" }, "api/PnP.Core.Model.FollowTagData.html": { "href": "api/PnP.Core.Model.FollowTagData.html", "title": "Class FollowTagData | PnP Core SDK", - "keywords": "Class FollowTagData A follow tag request metadata object Inheritance Object FollowData FollowTagData Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public class FollowTagData : FollowData Properties ActorType Represents an actor type. Can be either a user, site, document or tag Declaration public override SocialActorType ActorType { get; } Property Value SocialActorType Overrides FollowData.ActorType TagGuid The unique Id for the tag. Declaration public Guid TagGuid { get; set; } Property Value Guid" + "keywords": "Class FollowTagData A follow tag request metadata object Inheritance System.Object FollowData FollowTagData Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public class FollowTagData : FollowData Properties ActorType Represents an actor type. Can be either a user, site, document or tag Declaration public override SocialActorType ActorType { get; } Property Value SocialActorType Overrides FollowData.ActorType TagGuid The unique Id for the tag. Declaration public Guid TagGuid { get; set; } Property Value Guid" }, "api/PnP.Core.Model.html": { "href": "api/PnP.Core.Model.html", @@ -722,7 +722,7 @@ "api/PnP.Core.Model.IBatchSingleResult.html": { "href": "api/PnP.Core.Model.IBatchSingleResult.html", "title": "Interface IBatchSingleResult | PnP Core SDK", - "keywords": "Interface IBatchSingleResult Defines a single result of a batch request Inherited Members IBatchResult.IsAvailable Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IBatchSingleResult : IBatchResult Properties ObjectResult Gets the result, once the batch is executed Declaration object ObjectResult { get; } Property Value Object" + "keywords": "Interface IBatchSingleResult Defines a single result of a batch request Inherited Members IBatchResult.IsAvailable Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IBatchSingleResult : IBatchResult Properties ObjectResult Gets the result, once the batch is executed Declaration object ObjectResult { get; } Property Value System.Object" }, "api/PnP.Core.Model.IBatchSingleResult-1.html": { "href": "api/PnP.Core.Model.IBatchSingleResult-1.html", @@ -732,7 +732,7 @@ "api/PnP.Core.Model.IDataModel-1.html": { "href": "api/PnP.Core.Model.IDataModel-1.html", "title": "Interface IDataModel | PnP Core SDK", - "keywords": "Interface IDataModel Defines the very basic interface for every Domain Model object. Add methods are implemented in their respective model interfaces Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IDataModel : IDataModelParent, IDataModelWithContext, ISupportModules Type Parameters TModel The actual type of the Domain Model object Properties Requested Defines whether this model object was requested from the back-end Declaration bool Requested { get; set; } Property Value Boolean Methods ArePropertiesAvailable(Expression>[]) Checks if the needed properties were loaded or not Declaration bool ArePropertiesAvailable(params Expression>[] expressions) Parameters Expression < Func >[] expressions Expression listing the properties to check Returns Boolean True if properties were loaded, false otherwise EnsureProperties(Expression>[]) Checks if the requested properties are loaded for the given model, if not they're loaded right now Declaration void EnsureProperties(params Expression>[] expressions) Parameters Expression < Func >[] expressions Expressions listing the properties to load EnsurePropertiesAsync(Expression>[]) Checks if the requested properties are loaded for the given model, if not they're loaded via a GetAsync call Declaration Task EnsurePropertiesAsync(params Expression>[] expressions) Parameters Expression < Func >[] expressions Expressions listing the properties to load Returns Task ExecuteRequest(ApiRequest) Executes a given API call Declaration ApiRequestResponse ExecuteRequest(ApiRequest request) Parameters ApiRequest request API call to execute Returns ApiRequestResponse The response of the API call ExecuteRequestAsync(ApiRequest) Executes a given API call Declaration Task ExecuteRequestAsync(ApiRequest request) Parameters ApiRequest request API call to execute Returns Task < ApiRequestResponse > The response of the API call ExecuteRequestBatch(ApiRequest) Executes a given API call Declaration IBatchSingleResult> ExecuteRequestBatch(ApiRequest request) Parameters ApiRequest request API call to execute Returns IBatchSingleResult < BatchResultValue < String >> The response of the API call ExecuteRequestBatch(Batch, ApiRequest) Executes a given API call Declaration IBatchSingleResult> ExecuteRequestBatch(Batch batch, ApiRequest request) Parameters Batch batch ApiRequest request API call to execute Returns IBatchSingleResult < BatchResultValue < String >> The response of the API call ExecuteRequestBatchAsync(ApiRequest) Executes a given API call Declaration Task>> ExecuteRequestBatchAsync(ApiRequest request) Parameters ApiRequest request API call to execute Returns Task < IBatchSingleResult < BatchResultValue < String >>> The response of the API call ExecuteRequestBatchAsync(Batch, ApiRequest) Executes a given API call Declaration Task>> ExecuteRequestBatchAsync(Batch batch, ApiRequest request) Parameters Batch batch ApiRequest request API call to execute Returns Task < IBatchSingleResult < BatchResultValue < String >>> The response of the API call HasChanged(String) Checks if a property on this model object has changed Declaration bool HasChanged(string propertyName = \"\") Parameters String propertyName Property to check Returns Boolean True if changed, false otherwise HasValue(String) Checks if a property on this model object has a value set Declaration bool HasValue(string propertyName = \"\") Parameters String propertyName Property to check Returns Boolean True if set, false otherwise IsPropertyAvailable(Expression>) Checks if a property is loaded or not Declaration bool IsPropertyAvailable(Expression> expression) Parameters Expression < Func > expression Expression listing the property to load Returns Boolean True if property was loaded, false otherwise Extension Methods RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IDataModel Defines the very basic interface for every Domain Model object. Add methods are implemented in their respective model interfaces Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IDataModel : IDataModelParent, IDataModelWithContext, ISupportModules Type Parameters TModel The actual type of the Domain Model object Properties Requested Defines whether this model object was requested from the back-end Declaration bool Requested { get; set; } Property Value Boolean Methods ArePropertiesAvailable(Expression>[]) Checks if the needed properties were loaded or not Declaration bool ArePropertiesAvailable(params Expression>[] expressions) Parameters Expression < Func >[] expressions Expression listing the properties to check Returns Boolean True if properties were loaded, false otherwise EnsureProperties(Expression>[]) Checks if the requested properties are loaded for the given model, if not they're loaded right now Declaration void EnsureProperties(params Expression>[] expressions) Parameters Expression < Func >[] expressions Expressions listing the properties to load EnsurePropertiesAsync(Expression>[]) Checks if the requested properties are loaded for the given model, if not they're loaded via a GetAsync call Declaration Task EnsurePropertiesAsync(params Expression>[] expressions) Parameters Expression < Func >[] expressions Expressions listing the properties to load Returns Task ExecuteRequest(ApiRequest) Executes a given API call Declaration ApiRequestResponse ExecuteRequest(ApiRequest request) Parameters ApiRequest request API call to execute Returns ApiRequestResponse The response of the API call ExecuteRequestAsync(ApiRequest) Executes a given API call Declaration Task ExecuteRequestAsync(ApiRequest request) Parameters ApiRequest request API call to execute Returns Task < ApiRequestResponse > The response of the API call ExecuteRequestBatch(ApiRequest) Executes a given API call Declaration IBatchSingleResult> ExecuteRequestBatch(ApiRequest request) Parameters ApiRequest request API call to execute Returns IBatchSingleResult < BatchResultValue < String >> The response of the API call ExecuteRequestBatch(Batch, ApiRequest) Executes a given API call Declaration IBatchSingleResult> ExecuteRequestBatch(Batch batch, ApiRequest request) Parameters Batch batch ApiRequest request API call to execute Returns IBatchSingleResult < BatchResultValue < String >> The response of the API call ExecuteRequestBatchAsync(ApiRequest) Executes a given API call Declaration Task>> ExecuteRequestBatchAsync(ApiRequest request) Parameters ApiRequest request API call to execute Returns Task < IBatchSingleResult < BatchResultValue < String >>> The response of the API call ExecuteRequestBatchAsync(Batch, ApiRequest) Executes a given API call Declaration Task>> ExecuteRequestBatchAsync(Batch batch, ApiRequest request) Parameters Batch batch ApiRequest request API call to execute Returns Task < IBatchSingleResult < BatchResultValue < String >>> The response of the API call HasChanged(String) Checks if a property on this model object has changed Declaration bool HasChanged(string propertyName = \"\") Parameters String propertyName Property to check Returns Boolean True if changed, false otherwise HasValue(String) Checks if a property on this model object has a value set Declaration bool HasValue(string propertyName = \"\") Parameters String propertyName Property to check Returns Boolean True if set, false otherwise IsPropertyAvailable(Expression>) Checks if a property is loaded or not Declaration bool IsPropertyAvailable(Expression> expression) Parameters Expression < Func > expression Expression listing the property to load Returns Boolean True if property was loaded, false otherwise Extension Methods RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.IDataModelCollection-1.html": { "href": "api/PnP.Core.Model.IDataModelCollection-1.html", @@ -757,7 +757,7 @@ "api/PnP.Core.Model.IDataModelCollectionLoad-1.html": { "href": "api/PnP.Core.Model.IDataModelCollectionLoad-1.html", "title": "Interface IDataModelCollectionLoad | PnP Core SDK", - "keywords": "Interface IDataModelCollectionLoad Defines the very basic interface for every collection of Domain Model objects which supports explicit load Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IDataModelCollectionLoad Type Parameters TModel The actual type of the Domain Model objects Methods LoadAsync(Expression>[]) Loads the list from the remote data source, eventually selecting custom properties or using a default set of properties Declaration Task LoadAsync(params Expression>[] selectors) Parameters Expression < Func >[] selectors The properties to select Returns Task The Domain Model object LoadBatchAsync(Batch, Expression>[]) Batches the load of the list from the remote data source, eventually selecting custom properties or using a default set of properties Declaration Task LoadBatchAsync(Batch batch, params Expression>[] selectors) Parameters Batch batch The batch to use Expression < Func >[] selectors The properties to select Returns Task < IBatchResult > The Domain Model object Extension Methods DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.Load(IDataModelCollectionLoad, Expression>[])" + "keywords": "Interface IDataModelCollectionLoad Defines the very basic interface for every collection of Domain Model objects which supports explicit load Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IDataModelCollectionLoad Type Parameters TModel The actual type of the Domain Model objects Methods LoadAsync(Expression>[]) Loads the list from the remote data source, eventually selecting custom properties or using a default set of properties Declaration Task LoadAsync(params Expression>[] selectors) Parameters Expression < Func >[] selectors The properties to select Returns Task The Domain Model object LoadBatchAsync(Batch, Expression>[]) Batches the load of the list from the remote data source, eventually selecting custom properties or using a default set of properties Declaration Task LoadBatchAsync(Batch batch, params Expression>[] selectors) Parameters Batch batch The batch to use Expression < Func >[] selectors The properties to select Returns Task < IBatchResult > The Domain Model object Extension Methods DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.Load(IDataModelCollectionLoad, Expression>[])" }, "api/PnP.Core.Model.IDataModelDelete.html": { "href": "api/PnP.Core.Model.IDataModelDelete.html", @@ -767,17 +767,17 @@ "api/PnP.Core.Model.IDataModelGet-1.html": { "href": "api/PnP.Core.Model.IDataModelGet-1.html", "title": "Interface IDataModelGet | PnP Core SDK", - "keywords": "Interface IDataModelGet Defines the read interface for Domain Model objects that can be read. Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IDataModelGet Type Parameters TModel Methods GetAsync(Expression>[]) Retrieves a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration Task GetAsync(params Expression>[] expressions) Parameters Expression < Func >[] expressions The properties to select Returns Task The Domain Model object GetBatchAsync(Batch, Expression>[]) Batches the retrieval of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration Task> GetBatchAsync(Batch batch, params Expression>[] expressions) Parameters Batch batch Batch add this request to Expression < Func >[] expressions The properties to select Returns Task < IBatchSingleResult > The Domain Model object Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[])" + "keywords": "Interface IDataModelGet Defines the read interface for Domain Model objects that can be read. Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IDataModelGet Type Parameters TModel Methods GetAsync(Expression>[]) Retrieves a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration Task GetAsync(params Expression>[] expressions) Parameters Expression < Func >[] expressions The properties to select Returns Task The Domain Model object GetBatchAsync(Batch, Expression>[]) Batches the retrieval of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration Task> GetBatchAsync(Batch batch, params Expression>[] expressions) Parameters Batch batch Batch add this request to Expression < Func >[] expressions The properties to select Returns Task < IBatchSingleResult > The Domain Model object Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[])" }, "api/PnP.Core.Model.IDataModelLoad-1.html": { "href": "api/PnP.Core.Model.IDataModelLoad-1.html", "title": "Interface IDataModelLoad | PnP Core SDK", - "keywords": "Interface IDataModelLoad Defines the read interface for Domain Model objects that can be loaded. Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IDataModelLoad Type Parameters TModel Methods LoadAsync(Expression>[]) Loads a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration Task LoadAsync(params Expression>[] expressions) Parameters Expression < Func >[] expressions The properties to select Returns Task The Domain Model object LoadBatchAsync(Batch, Expression>[]) Batches the load of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration Task LoadBatchAsync(Batch batch, params Expression>[] expressions) Parameters Batch batch Batch add this request to Expression < Func >[] expressions The properties to select Returns Task < IBatchResult > The Domain Model object Extension Methods DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[])" + "keywords": "Interface IDataModelLoad Defines the read interface for Domain Model objects that can be loaded. Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IDataModelLoad Type Parameters TModel Methods LoadAsync(Expression>[]) Loads a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration Task LoadAsync(params Expression>[] expressions) Parameters Expression < Func >[] expressions The properties to select Returns Task The Domain Model object LoadBatchAsync(Batch, Expression>[]) Batches the load of a Domain Model object from the remote data source, eventually selecting custom properties or using a default set of properties Declaration Task LoadBatchAsync(Batch batch, params Expression>[] expressions) Parameters Batch batch Batch add this request to Expression < Func >[] expressions The properties to select Returns Task < IBatchResult > The Domain Model object Extension Methods DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[])" }, "api/PnP.Core.Model.IDataModelMappingHandler.html": { "href": "api/PnP.Core.Model.IDataModelMappingHandler.html", "title": "Interface IDataModelMappingHandler | PnP Core SDK", - "keywords": "Interface IDataModelMappingHandler Interface to the define the basic behavior of Domain Model object that can be mapped from a JSON response coming out of a REST request Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IDataModelMappingHandler Properties MappingHandler Handler that will fire when a property mapping does cannot be done automatically Declaration Func MappingHandler { get; set; } Property Value Func < FromJson , Object > PostMappingHandler Handler that will fire after the full json to model operation was done Declaration Action PostMappingHandler { get; set; } Property Value Action < String >" + "keywords": "Interface IDataModelMappingHandler Interface to the define the basic behavior of Domain Model object that can be mapped from a JSON response coming out of a REST request Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IDataModelMappingHandler Properties MappingHandler Handler that will fire when a property mapping does cannot be done automatically Declaration Func MappingHandler { get; set; } Property Value Func < FromJson , System.Object > PostMappingHandler Handler that will fire after the full json to model operation was done Declaration Action PostMappingHandler { get; set; } Property Value Action < String >" }, "api/PnP.Core.Model.IDataModelParent.html": { "href": "api/PnP.Core.Model.IDataModelParent.html", @@ -802,7 +802,7 @@ "api/PnP.Core.Model.IDataModelWithKey.html": { "href": "api/PnP.Core.Model.IDataModelWithKey.html", "title": "Interface IDataModelWithKey | PnP Core SDK", - "keywords": "Interface IDataModelWithKey Defines the basic behavior for a Domain Model object with an identifying key Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IDataModelWithKey Properties Key Readonly property to get the untyped key of the object Declaration object Key { get; set; } Property Value Object" + "keywords": "Interface IDataModelWithKey Defines the basic behavior for a Domain Model object with an identifying key Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IDataModelWithKey Properties Key Readonly property to get the untyped key of the object Declaration object Key { get; set; } Property Value System.Object" }, "api/PnP.Core.Model.IEnumerableBatchResult.html": { "href": "api/PnP.Core.Model.IEnumerableBatchResult.html", @@ -817,12 +817,12 @@ "api/PnP.Core.Model.IExpandoDataModel.html": { "href": "api/PnP.Core.Model.IExpandoDataModel.html", "title": "Interface IExpandoDataModel | PnP Core SDK", - "keywords": "Interface IExpandoDataModel Public interface to define an object extensible through a dictionary of properties Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IExpandoDataModel Properties Count Gets the count of properties of the current expando type object Declaration int Count { get; } Property Value Int32 Item[String] Gets or sets dynamic properties Declaration object this[string key] { get; set; } Parameters String key The key of the property to get or set Property Value Object The value of the property Values The dictionary of properties Declaration TransientDictionary Values { get; } Property Value TransientDictionary Methods AsDynamic() Transforms the current model instance into a dynamic type Declaration dynamic AsDynamic() Returns Object Dynamic version of current model instance" + "keywords": "Interface IExpandoDataModel Public interface to define an object extensible through a dictionary of properties Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IExpandoDataModel Properties Count Gets the count of properties of the current expando type object Declaration int Count { get; } Property Value Int32 Item[String] Gets or sets dynamic properties Declaration object this[string key] { get; set; } Parameters String key The key of the property to get or set Property Value System.Object The value of the property Values The dictionary of properties Declaration TransientDictionary Values { get; } Property Value TransientDictionary Methods AsDynamic() Transforms the current model instance into a dynamic type Declaration dynamic AsDynamic() Returns System.Object Dynamic version of current model instance" }, "api/PnP.Core.Model.IManageableCollection.html": { "href": "api/PnP.Core.Model.IManageableCollection.html", "title": "Interface IManageableCollection | PnP Core SDK", - "keywords": "Interface IManageableCollection Defines the behavior of a collection that can be managed with untyped prototype methods Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IManageableCollection Methods Add(Object) Method to add a new item to the collection Declaration void Add(object item) Parameters Object item The untyped item to add AddOrUpdate(Object, Predicate) Method to add a new untyped item or update an already existing one based on a selection predicate Declaration void AddOrUpdate(object newItem, Predicate selector) Parameters Object newItem The untyped item to add Predicate < Object > selector The selection predicate for the already existing item, if any CreateNew() Method to create a new item of the collection, ready to be added to the same collection Declaration object CreateNew() Returns Object The new item, ready to be added to the current collection CreateNewAndAdd() Method to create a new typed item of the collection and immediately add it the collection Declaration object CreateNewAndAdd() Returns Object The new item, added to the collection Remove(Object) Method to remove an untyped item from the collection Declaration bool Remove(object item) Parameters Object item The untyped item to remove Returns Boolean True if the removal is successful Replace(Int32, Object) Replaces an item in the collection with a new one Declaration void Replace(int itemIndex, object newItem) Parameters Int32 itemIndex The index of the item to replace within the collection Object newItem New item to replace the old one with" + "keywords": "Interface IManageableCollection Defines the behavior of a collection that can be managed with untyped prototype methods Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public interface IManageableCollection Methods Add(Object) Method to add a new item to the collection Declaration void Add(object item) Parameters System.Object item The untyped item to add AddOrUpdate(Object, Predicate) Method to add a new untyped item or update an already existing one based on a selection predicate Declaration void AddOrUpdate(object newItem, Predicate selector) Parameters System.Object newItem The untyped item to add Predicate < System.Object > selector The selection predicate for the already existing item, if any CreateNew() Method to create a new item of the collection, ready to be added to the same collection Declaration object CreateNew() Returns System.Object The new item, ready to be added to the current collection CreateNewAndAdd() Method to create a new typed item of the collection and immediately add it the collection Declaration object CreateNewAndAdd() Returns System.Object The new item, added to the collection Remove(Object) Method to remove an untyped item from the collection Declaration bool Remove(object item) Parameters System.Object item The untyped item to remove Returns Boolean True if the removal is successful Replace(Int32, Object) Replaces an item in the collection with a new one Declaration void Replace(int itemIndex, object newItem) Parameters Int32 itemIndex The index of the item to replace within the collection System.Object newItem New item to replace the old one with" }, "api/PnP.Core.Model.IManageableCollection-1.html": { "href": "api/PnP.Core.Model.IManageableCollection-1.html", @@ -862,12 +862,12 @@ "api/PnP.Core.Model.Me.ChatMemberOptions.html": { "href": "api/PnP.Core.Model.Me.ChatMemberOptions.html", "title": "Class ChatMemberOptions | PnP Core SDK", - "keywords": "Class ChatMemberOptions Options for a member participating in a chat Inheritance Object ChatMemberOptions Namespace : PnP.Core.Model.Me Assembly : PnP.Core.dll Syntax public class ChatMemberOptions : object Properties Roles Member roles Declaration public List Roles { get; set; } Property Value List < String > UserId User id of the member Declaration public string UserId { get; set; } Property Value String" + "keywords": "Class ChatMemberOptions Options for a member participating in a chat Inheritance System.Object ChatMemberOptions Namespace : PnP.Core.Model.Me Assembly : PnP.Core.dll Syntax public class ChatMemberOptions : object Properties Roles Member roles Declaration public List Roles { get; set; } Property Value List < String > UserId User id of the member Declaration public string UserId { get; set; } Property Value String" }, "api/PnP.Core.Model.Me.ChatOptions.html": { "href": "api/PnP.Core.Model.Me.ChatOptions.html", "title": "Class ChatOptions | PnP Core SDK", - "keywords": "Class ChatOptions Options for a chat Inheritance Object ChatOptions Namespace : PnP.Core.Model.Me Assembly : PnP.Core.dll Syntax public class ChatOptions : object Properties ChatType Type of chat Declaration public ChatType ChatType { get; set; } Property Value ChatType Members Members in the chat Declaration public List Members { get; set; } Property Value List < ChatMemberOptions > Topic Chat topic Declaration public string Topic { get; set; } Property Value String" + "keywords": "Class ChatOptions Options for a chat Inheritance System.Object ChatOptions Namespace : PnP.Core.Model.Me Assembly : PnP.Core.dll Syntax public class ChatOptions : object Properties ChatType Type of chat Declaration public ChatType ChatType { get; set; } Property Value ChatType Members Members in the chat Declaration public List Members { get; set; } Property Value List < ChatMemberOptions > Topic Chat topic Declaration public string Topic { get; set; } Property Value String" }, "api/PnP.Core.Model.Me.ChatType.html": { "href": "api/PnP.Core.Model.Me.ChatType.html", @@ -967,12 +967,12 @@ "api/PnP.Core.Model.RequestModuleExtensions.html": { "href": "api/PnP.Core.Model.RequestModuleExtensions.html", "title": "Class RequestModuleExtensions | PnP Core SDK", - "keywords": "Class RequestModuleExtensions Set of extension methods used to bring request module support Inheritance Object RequestModuleExtensions Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public static class RequestModuleExtensions : object Methods WithHeaders(ISupportModules, Dictionary, Action>) Executes this request with additional request headers Declaration public static TModel WithHeaders(this ISupportModules dataModel, Dictionary headers, Action> responseHeaders = null) Parameters ISupportModules dataModel Model instance to operate on Dictionary < String , String > headers Collection of headers to add to add to the request Action < Dictionary < String , String >> responseHeaders Delegate that can be invoked to pass along the response headers Returns TModel The passed model instance Type Parameters TModel Model type" + "keywords": "Class RequestModuleExtensions Set of extension methods used to bring request module support Inheritance System.Object RequestModuleExtensions Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public static class RequestModuleExtensions : object Methods WithHeaders(ISupportModules, Dictionary, Action>) Executes this request with additional request headers Declaration public static TModel WithHeaders(this ISupportModules dataModel, Dictionary headers, Action> responseHeaders = null) Parameters ISupportModules dataModel Model instance to operate on Dictionary < String , String > headers Collection of headers to add to add to the request Action < Dictionary < String , String >> responseHeaders Delegate that can be invoked to pass along the response headers Returns TModel The passed model instance Type Parameters TModel Model type" }, "api/PnP.Core.Model.Security.AnonymousLinkOptions.html": { "href": "api/PnP.Core.Model.Security.AnonymousLinkOptions.html", "title": "Class AnonymousLinkOptions | PnP Core SDK", - "keywords": "Class AnonymousLinkOptions Properties that can be set when creating a new Anonymous Link Inheritance Object AnonymousLinkOptions Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public class AnonymousLinkOptions : object Properties ExpirationDateTime Indicates the expiration datetime of the permission. Declaration public DateTime ExpirationDateTime { get; set; } Property Value DateTime Password The password of the sharing link that is set by the creator. Declaration public string Password { get; set; } Property Value String Type The type of sharing link to create. Declaration public ShareType Type { get; set; } Property Value ShareType" + "keywords": "Class AnonymousLinkOptions Properties that can be set when creating a new Anonymous Link Inheritance System.Object AnonymousLinkOptions Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public class AnonymousLinkOptions : object Properties ExpirationDateTime Indicates the expiration datetime of the permission. Declaration public DateTime ExpirationDateTime { get; set; } Property Value DateTime Password The password of the sharing link that is set by the creator. Declaration public string Password { get; set; } Property Value String Type The type of sharing link to create. Declaration public ShareType Type { get; set; } Property Value ShareType" }, "api/PnP.Core.Model.Security.GroupVisibility.html": { "href": "api/PnP.Core.Model.Security.GroupVisibility.html", @@ -1037,17 +1037,17 @@ "api/PnP.Core.Model.Security.InviteOptions.html": { "href": "api/PnP.Core.Model.Security.InviteOptions.html", "title": "Class InviteOptions | PnP Core SDK", - "keywords": "Class InviteOptions Options that can be set when inviting users to an item Inheritance Object InviteOptionsBase InviteOptions Inherited Members InviteOptionsBase.CreateDriveRecipient(String) Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public class InviteOptions : InviteOptionsBase Properties ExpirationDateTime Specify the DateTime after which the permission expires. Note: Available on OneDrive for Business, SharePoint, and premium personal OneDrive accounts. Declaration public DateTime ExpirationDateTime { get; set; } Property Value DateTime Message A plain text formatted message that is included in the sharing invitation. Maximum length 2000 characters. Declaration public string Message { get; set; } Property Value String Recipients A collection of recipients who will receive access and the sharing invitation. Declaration public List Recipients { get; set; } Property Value List < IDriveRecipient > RequireSignIn Specifies where the recipient of the invitation is required to sign-in to view the shared item Declaration public bool RequireSignIn { get; set; } Property Value Boolean Roles Specify the roles that are be granted to the recipients of the sharing invitation. Declaration public List Roles { get; set; } Property Value List < PermissionRole > SendInvitation Specifies if an email or post is generated (false) or if the permission is just created (true). Declaration public bool SendInvitation { get; set; } Property Value Boolean" + "keywords": "Class InviteOptions Options that can be set when inviting users to an item Inheritance System.Object InviteOptionsBase InviteOptions Inherited Members InviteOptionsBase.CreateDriveRecipient(String) Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public class InviteOptions : InviteOptionsBase Properties ExpirationDateTime Specify the DateTime after which the permission expires. Note: Available on OneDrive for Business, SharePoint, and premium personal OneDrive accounts. Declaration public DateTime ExpirationDateTime { get; set; } Property Value DateTime Message A plain text formatted message that is included in the sharing invitation. Maximum length 2000 characters. Declaration public string Message { get; set; } Property Value String Recipients A collection of recipients who will receive access and the sharing invitation. Declaration public List Recipients { get; set; } Property Value List < IDriveRecipient > RequireSignIn Specifies where the recipient of the invitation is required to sign-in to view the shared item Declaration public bool RequireSignIn { get; set; } Property Value Boolean Roles Specify the roles that are be granted to the recipients of the sharing invitation. Declaration public List Roles { get; set; } Property Value List < PermissionRole > SendInvitation Specifies if an email or post is generated (false) or if the permission is just created (true). Declaration public bool SendInvitation { get; set; } Property Value Boolean" }, "api/PnP.Core.Model.Security.InviteOptionsBase.html": { "href": "api/PnP.Core.Model.Security.InviteOptionsBase.html", "title": "Class InviteOptionsBase | PnP Core SDK", - "keywords": "Class InviteOptionsBase Base class for InviteOptions classes Inheritance Object InviteOptionsBase InviteOptions UserLinkOptions Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public abstract class InviteOptionsBase : object Methods CreateDriveRecipient(String) Creates a new IDriveRecipient for the passed email address Declaration public static IDriveRecipient CreateDriveRecipient(string email) Parameters String email Email of the user to create an IDriveRecipient for Returns IDriveRecipient An IDriveRecipient instance" + "keywords": "Class InviteOptionsBase Base class for InviteOptions classes Inheritance System.Object InviteOptionsBase InviteOptions UserLinkOptions Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public abstract class InviteOptionsBase : object Methods CreateDriveRecipient(String) Creates a new IDriveRecipient for the passed email address Declaration public static IDriveRecipient CreateDriveRecipient(string email) Parameters String email Email of the user to create an IDriveRecipient for Returns IDriveRecipient An IDriveRecipient instance" }, "api/PnP.Core.Model.Security.IRoleAssignment.html": { "href": "api/PnP.Core.Model.Security.IRoleAssignment.html", "title": "Interface IRoleAssignment | PnP Core SDK", - "keywords": "Interface IRoleAssignment Defines a single role definition, including a name, description, and set of rights. Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public interface IRoleAssignment : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object PrincipalId Gets or sets a value that specifies the base permissions for the role definition. Declaration int PrincipalId { get; set; } Property Value Int32 RoleDefinitions Role definitions for this assignment Declaration IRoleDefinitionCollection RoleDefinitions { get; } Property Value IRoleDefinitionCollection Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IRoleAssignment Defines a single role definition, including a name, description, and set of rights. Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public interface IRoleAssignment : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object PrincipalId Gets or sets a value that specifies the base permissions for the role definition. Declaration int PrincipalId { get; set; } Property Value Int32 RoleDefinitions Role definitions for this assignment Declaration IRoleDefinitionCollection RoleDefinitions { get; } Property Value IRoleDefinitionCollection Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.Security.IRoleAssignmentCollection.html": { "href": "api/PnP.Core.Model.Security.IRoleAssignmentCollection.html", @@ -1057,7 +1057,7 @@ "api/PnP.Core.Model.Security.IRoleDefinition.html": { "href": "api/PnP.Core.Model.Security.IRoleDefinition.html", "title": "Interface IRoleDefinition | PnP Core SDK", - "keywords": "Interface IRoleDefinition Defines a single role definition, including a name, description, and set of rights. Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public interface IRoleDefinition : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object BasePermissions Gets or sets a value that specifies the base permissions for the role definition. Declaration IBasePermissions BasePermissions { get; set; } Property Value IBasePermissions Description Gets or sets a value that specifies the description of the role definition. Declaration string Description { get; set; } Property Value String Hidden Gets a value that specifies whether the role definition is displayed. Declaration bool Hidden { get; set; } Property Value Boolean Id Gets a value that specifies the Id of the role definition. Declaration int Id { get; } Property Value Int32 Name Gets or sets a value that specifies the role definition name. Declaration string Name { get; set; } Property Value String Order Gets or sets a value that specifies the order position of the object in the site collection Permission Levels page. Declaration int Order { get; set; } Property Value Int32 RoleTypeKind Gets a value that specifies the type of the role definition. Declaration RoleType RoleTypeKind { get; set; } Property Value RoleType Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IRoleDefinition Defines a single role definition, including a name, description, and set of rights. Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public interface IRoleDefinition : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object BasePermissions Gets or sets a value that specifies the base permissions for the role definition. Declaration IBasePermissions BasePermissions { get; set; } Property Value IBasePermissions Description Gets or sets a value that specifies the description of the role definition. Declaration string Description { get; set; } Property Value String Hidden Gets a value that specifies whether the role definition is displayed. Declaration bool Hidden { get; set; } Property Value Boolean Id Gets a value that specifies the Id of the role definition. Declaration int Id { get; } Property Value Int32 Name Gets or sets a value that specifies the role definition name. Declaration string Name { get; set; } Property Value String Order Gets or sets a value that specifies the order position of the object in the site collection Permission Levels page. Declaration int Order { get; set; } Property Value Int32 RoleTypeKind Gets a value that specifies the type of the role definition. Declaration RoleType RoleTypeKind { get; set; } Property Value RoleType Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.Security.IRoleDefinitionCollection.html": { "href": "api/PnP.Core.Model.Security.IRoleDefinitionCollection.html", @@ -1067,7 +1067,7 @@ "api/PnP.Core.Model.Security.ISharePointGroup.html": { "href": "api/PnP.Core.Model.Security.ISharePointGroup.html", "title": "Interface ISharePointGroup | PnP Core SDK", - "keywords": "Interface ISharePointGroup Public interface to define a SharePoint Group Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() ISharePointPrincipal.Id ISharePointPrincipal.IsHiddenInUI ISharePointPrincipal.PrincipalType ISharePointPrincipal.LoginName ISharePointPrincipal.Title Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public interface ISharePointGroup : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, ISharePointPrincipal, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object AllowMembersEditMembership Allow members to edit the group members Declaration bool AllowMembersEditMembership { get; set; } Property Value Boolean AllowRequestToJoinLeave Allow requests to join or leave the group Declaration bool AllowRequestToJoinLeave { get; set; } Property Value Boolean AutoAcceptRequestToJoinLeave Automatically accept requests to join or leave the group Declaration bool AutoAcceptRequestToJoinLeave { get; set; } Property Value Boolean CanCurrentUserEditMembership Can the current user edit the group members Declaration bool CanCurrentUserEditMembership { get; set; } Property Value Boolean CanCurrentUserManageGroup Can the current user manage the group Declaration bool CanCurrentUserManageGroup { get; set; } Property Value Boolean CanCurrentUserViewMembership Can the current user view the group membership Declaration bool CanCurrentUserViewMembership { get; set; } Property Value Boolean Description Group description. Note that HTML tags will be stripped and that the max length of the description will be limited to 511 characters Declaration string Description { get; set; } Property Value String OnlyAllowMembersViewMembership Only members can see other group members Declaration bool OnlyAllowMembersViewMembership { get; set; } Property Value Boolean OwnerTitle Group owner title Declaration string OwnerTitle { get; } Property Value String RequestToJoinLeaveEmailSetting Email configuration for the group join or leave operations Declaration string RequestToJoinLeaveEmailSetting { get; set; } Property Value String Users Members of this group Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ISharePointUserCollection Users { get; } Property Value ISharePointUserCollection Methods AddRoleDefinitions(String[]) Adds role definitions for this group Declaration bool AddRoleDefinitions(params string[] names) Parameters String [] names Returns Boolean AddRoleDefinitionsAsync(String[]) Adds role definitions for this group Declaration Task AddRoleDefinitionsAsync(params string[] names) Parameters String [] names Returns Task < Boolean > AddUser(String) Adds a user to this group. Specify the full username, e.g. \"i:0#.f|membership|user@domain.com" Declaration void AddUser(string loginName) Parameters String loginName AddUserAsync(String) Adds a user to this group. Specify the full username, e.g. \"i:0#.f|membership|user@domain.com" Declaration Task AddUserAsync(string loginName) Parameters String loginName Returns Task AddUserBatch(Batch, String) Adds a user to this group. Specify the full username, e.g. \"i:0#.f|membership|user@domain.com" Declaration void AddUserBatch(Batch batch, string loginName) Parameters Batch batch String loginName AddUserBatch(String) Adds a user to this group. Specify the full username, e.g. \"i:0#.f|membership|user@domain.com" Declaration void AddUserBatch(string loginName) Parameters String loginName AddUserBatchAsync(Batch, String) Adds a user to this group. Specify the full username, e.g. \"i:0#.f|membership|user@domain.com" Declaration Task AddUserBatchAsync(Batch batch, string loginName) Parameters Batch batch String loginName Returns Task AddUserBatchAsync(String) Adds a user to this group. Specify the full username, e.g. \"i:0#.f|membership|user@domain.com" Declaration Task AddUserBatchAsync(string loginName) Parameters String loginName Returns Task GetRoleDefinitions() Retrieves the role definitions for this group Declaration IRoleDefinitionCollection GetRoleDefinitions() Returns IRoleDefinitionCollection GetRoleDefinitionsAsync() Retrieves the role definitions for this group Declaration Task GetRoleDefinitionsAsync() Returns Task < IRoleDefinitionCollection > RemoveRoleDefinitions(String[]) Removes role definitions for this group Declaration bool RemoveRoleDefinitions(params string[] names) Parameters String [] names Returns Boolean RemoveRoleDefinitionsAsync(String[]) Removes role definitions for this group Declaration Task RemoveRoleDefinitionsAsync(params string[] names) Parameters String [] names Returns Task < Boolean > RemoveUser(Int32) Removes a user given its id from a group. Declaration void RemoveUser(int userId) Parameters Int32 userId RemoveUserAsync(Int32) Removes a user given its id from a group. Declaration Task RemoveUserAsync(int userId) Parameters Int32 userId Returns Task RemoveUserBatch(Batch, Int32) Removes a user given its id from a group. Declaration void RemoveUserBatch(Batch batch, int userId) Parameters Batch batch Int32 userId RemoveUserBatch(Int32) Removes a user given its id from a group. Declaration void RemoveUserBatch(int userId) Parameters Int32 userId RemoveUserBatchAsync(Batch, Int32) Removes a user given its id from a group. Declaration Task RemoveUserBatchAsync(Batch batch, int userId) Parameters Batch batch Int32 userId Returns Task RemoveUserBatchAsync(Int32) Removes a user given its id from a group. Declaration Task RemoveUserBatchAsync(int userId) Parameters Int32 userId Returns Task SetUserAsOwner(Int32) Sets a user as owner of the group. Id of the user to set as owner Declaration void SetUserAsOwner(int userId) Parameters Int32 userId SetUserAsOwnerAsync(Int32) Sets a user as owner of the group. Id of the user to set as owner Declaration Task SetUserAsOwnerAsync(int userId) Parameters Int32 userId Returns Task SetUserAsOwnerBatch(Batch, Int32) Sets a user as owner of the group. Batch on which to execute the request Id of the user to set as owner Declaration void SetUserAsOwnerBatch(Batch batch, int userId) Parameters Batch batch Int32 userId SetUserAsOwnerBatch(Int32) Sets a user as owner of the group. Id of the user to set as owner Declaration void SetUserAsOwnerBatch(int userId) Parameters Int32 userId SetUserAsOwnerBatchAsync(Batch, Int32) Sets a user as owner of the group. Batch on which to execute the request Id of the user to set as owner Declaration Task SetUserAsOwnerBatchAsync(Batch batch, int userId) Parameters Batch batch Int32 userId Returns Task SetUserAsOwnerBatchAsync(Int32) Sets a user as owner of the group. Id of the user to set as owner Declaration Task SetUserAsOwnerBatchAsync(int userId) Parameters Int32 userId Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface ISharePointGroup Public interface to define a SharePoint Group Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() ISharePointPrincipal.Id ISharePointPrincipal.IsHiddenInUI ISharePointPrincipal.PrincipalType ISharePointPrincipal.LoginName ISharePointPrincipal.Title Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public interface ISharePointGroup : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, ISharePointPrincipal, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object AllowMembersEditMembership Allow members to edit the group members Declaration bool AllowMembersEditMembership { get; set; } Property Value Boolean AllowRequestToJoinLeave Allow requests to join or leave the group Declaration bool AllowRequestToJoinLeave { get; set; } Property Value Boolean AutoAcceptRequestToJoinLeave Automatically accept requests to join or leave the group Declaration bool AutoAcceptRequestToJoinLeave { get; set; } Property Value Boolean CanCurrentUserEditMembership Can the current user edit the group members Declaration bool CanCurrentUserEditMembership { get; set; } Property Value Boolean CanCurrentUserManageGroup Can the current user manage the group Declaration bool CanCurrentUserManageGroup { get; set; } Property Value Boolean CanCurrentUserViewMembership Can the current user view the group membership Declaration bool CanCurrentUserViewMembership { get; set; } Property Value Boolean Description Group description. Note that HTML tags will be stripped and that the max length of the description will be limited to 511 characters Declaration string Description { get; set; } Property Value String OnlyAllowMembersViewMembership Only members can see other group members Declaration bool OnlyAllowMembersViewMembership { get; set; } Property Value Boolean OwnerTitle Group owner title Declaration string OwnerTitle { get; } Property Value String RequestToJoinLeaveEmailSetting Email configuration for the group join or leave operations Declaration string RequestToJoinLeaveEmailSetting { get; set; } Property Value String Users Members of this group Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ISharePointUserCollection Users { get; } Property Value ISharePointUserCollection Methods AddRoleDefinitions(String[]) Adds role definitions for this group Declaration bool AddRoleDefinitions(params string[] names) Parameters String [] names Returns Boolean AddRoleDefinitionsAsync(String[]) Adds role definitions for this group Declaration Task AddRoleDefinitionsAsync(params string[] names) Parameters String [] names Returns Task < Boolean > AddUser(String) Adds a user to this group. Specify the full username, e.g. \"i:0#.f|membership|user@domain.com" Declaration void AddUser(string loginName) Parameters String loginName AddUserAsync(String) Adds a user to this group. Specify the full username, e.g. \"i:0#.f|membership|user@domain.com" Declaration Task AddUserAsync(string loginName) Parameters String loginName Returns Task AddUserBatch(Batch, String) Adds a user to this group. Specify the full username, e.g. \"i:0#.f|membership|user@domain.com" Declaration void AddUserBatch(Batch batch, string loginName) Parameters Batch batch String loginName AddUserBatch(String) Adds a user to this group. Specify the full username, e.g. \"i:0#.f|membership|user@domain.com" Declaration void AddUserBatch(string loginName) Parameters String loginName AddUserBatchAsync(Batch, String) Adds a user to this group. Specify the full username, e.g. \"i:0#.f|membership|user@domain.com" Declaration Task AddUserBatchAsync(Batch batch, string loginName) Parameters Batch batch String loginName Returns Task AddUserBatchAsync(String) Adds a user to this group. Specify the full username, e.g. \"i:0#.f|membership|user@domain.com" Declaration Task AddUserBatchAsync(string loginName) Parameters String loginName Returns Task GetRoleDefinitions() Retrieves the role definitions for this group Declaration IRoleDefinitionCollection GetRoleDefinitions() Returns IRoleDefinitionCollection GetRoleDefinitionsAsync() Retrieves the role definitions for this group Declaration Task GetRoleDefinitionsAsync() Returns Task < IRoleDefinitionCollection > RemoveRoleDefinitions(String[]) Removes role definitions for this group Declaration bool RemoveRoleDefinitions(params string[] names) Parameters String [] names Returns Boolean RemoveRoleDefinitionsAsync(String[]) Removes role definitions for this group Declaration Task RemoveRoleDefinitionsAsync(params string[] names) Parameters String [] names Returns Task < Boolean > RemoveUser(Int32) Removes a user given its id from a group. Declaration void RemoveUser(int userId) Parameters Int32 userId RemoveUserAsync(Int32) Removes a user given its id from a group. Declaration Task RemoveUserAsync(int userId) Parameters Int32 userId Returns Task RemoveUserBatch(Batch, Int32) Removes a user given its id from a group. Declaration void RemoveUserBatch(Batch batch, int userId) Parameters Batch batch Int32 userId RemoveUserBatch(Int32) Removes a user given its id from a group. Declaration void RemoveUserBatch(int userId) Parameters Int32 userId RemoveUserBatchAsync(Batch, Int32) Removes a user given its id from a group. Declaration Task RemoveUserBatchAsync(Batch batch, int userId) Parameters Batch batch Int32 userId Returns Task RemoveUserBatchAsync(Int32) Removes a user given its id from a group. Declaration Task RemoveUserBatchAsync(int userId) Parameters Int32 userId Returns Task SetUserAsOwner(Int32) Sets a user as owner of the group. Id of the user to set as owner Declaration void SetUserAsOwner(int userId) Parameters Int32 userId SetUserAsOwnerAsync(Int32) Sets a user as owner of the group. Id of the user to set as owner Declaration Task SetUserAsOwnerAsync(int userId) Parameters Int32 userId Returns Task SetUserAsOwnerBatch(Batch, Int32) Sets a user as owner of the group. Batch on which to execute the request Id of the user to set as owner Declaration void SetUserAsOwnerBatch(Batch batch, int userId) Parameters Batch batch Int32 userId SetUserAsOwnerBatch(Int32) Sets a user as owner of the group. Id of the user to set as owner Declaration void SetUserAsOwnerBatch(int userId) Parameters Int32 userId SetUserAsOwnerBatchAsync(Batch, Int32) Sets a user as owner of the group. Batch on which to execute the request Id of the user to set as owner Declaration Task SetUserAsOwnerBatchAsync(Batch batch, int userId) Parameters Batch batch Int32 userId Returns Task SetUserAsOwnerBatchAsync(Int32) Sets a user as owner of the group. Id of the user to set as owner Declaration Task SetUserAsOwnerBatchAsync(int userId) Parameters Int32 userId Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.Security.ISharePointGroupCollection.html": { "href": "api/PnP.Core.Model.Security.ISharePointGroupCollection.html", @@ -1097,7 +1097,7 @@ "api/PnP.Core.Model.Security.ISharePointUser.html": { "href": "api/PnP.Core.Model.Security.ISharePointUser.html", "title": "Interface ISharePointUser | PnP Core SDK", - "keywords": "Interface ISharePointUser Public interface to define a SharePoint User Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() ISharePointPrincipal.Id ISharePointPrincipal.IsHiddenInUI ISharePointPrincipal.PrincipalType ISharePointPrincipal.LoginName ISharePointPrincipal.Title Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public interface ISharePointUser : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelDelete, ISharePointPrincipal, IQueryableDataModel Properties AadObjectId Id of the underlying graph object (if any) Declaration string AadObjectId { get; set; } Property Value String All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object Department Department of the user Declaration string Department { get; set; } Property Value String Expiration A date/time string for which the format conforms to the ISO8601 time format YYYY-MM-DDTHH:MM:SSZ and which represents the time and date of expiry for the user. A null value indicates no expiry. Declaration string Expiration { get; } Property Value String IsEmailAuthenticationGuestUser Indicates whether the user is a guest user authenticated via an e-mail address Declaration bool IsEmailAuthenticationGuestUser { get; } Property Value Boolean IsShareByEmailGuestUser Indicates whether the user is a guest user shared by e-mail Declaration bool IsShareByEmailGuestUser { get; } Property Value Boolean IsSiteAdmin Indicates whether the user is a site collection administrator Declaration bool IsSiteAdmin { get; } Property Value Boolean Mail E-mail address of the user. SP REST property name: Email Declaration string Mail { get; set; } Property Value String UserPrincipalName User principle name (UPN) of the user Declaration string UserPrincipalName { get; set; } Property Value String Methods AddRoleDefinitions(String[]) Adds role definitions for this user Declaration bool AddRoleDefinitions(params string[] names) Parameters String [] names Returns Boolean AddRoleDefinitionsAsync(String[]) Adds role definitions for this user Declaration Task AddRoleDefinitionsAsync(params string[] names) Parameters String [] names Returns Task < Boolean > AsGraphUser() Returns this SharePoint user as a Graph user Declaration IGraphUser AsGraphUser() Returns IGraphUser AsGraphUserAsync() Returns this SharePoint user as a Graph user Declaration Task AsGraphUserAsync() Returns Task < IGraphUser > GetRoleDefinitions() Retrieves the role definitions for this user Declaration IRoleDefinitionCollection GetRoleDefinitions() Returns IRoleDefinitionCollection GetRoleDefinitionsAsync() Retrieves the role definitions for this user Declaration Task GetRoleDefinitionsAsync() Returns Task < IRoleDefinitionCollection > RemoveRoleDefinitions(String[]) Removes role definitions for this user Declaration bool RemoveRoleDefinitions(params string[] names) Parameters String [] names Returns Boolean RemoveRoleDefinitionsAsync(String[]) Removes role definitions for this user Declaration Task RemoveRoleDefinitionsAsync(params string[] names) Parameters String [] names Returns Task < Boolean > Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface ISharePointUser Public interface to define a SharePoint User Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() ISharePointPrincipal.Id ISharePointPrincipal.IsHiddenInUI ISharePointPrincipal.PrincipalType ISharePointPrincipal.LoginName ISharePointPrincipal.Title Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public interface ISharePointUser : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelDelete, ISharePointPrincipal, IQueryableDataModel Properties AadObjectId Id of the underlying graph object (if any) Declaration string AadObjectId { get; set; } Property Value String All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object Department Department of the user Declaration string Department { get; set; } Property Value String Expiration A date/time string for which the format conforms to the ISO8601 time format YYYY-MM-DDTHH:MM:SSZ and which represents the time and date of expiry for the user. A null value indicates no expiry. Declaration string Expiration { get; } Property Value String IsEmailAuthenticationGuestUser Indicates whether the user is a guest user authenticated via an e-mail address Declaration bool IsEmailAuthenticationGuestUser { get; } Property Value Boolean IsShareByEmailGuestUser Indicates whether the user is a guest user shared by e-mail Declaration bool IsShareByEmailGuestUser { get; } Property Value Boolean IsSiteAdmin Indicates whether the user is a site collection administrator Declaration bool IsSiteAdmin { get; } Property Value Boolean Mail E-mail address of the user. SP REST property name: Email Declaration string Mail { get; set; } Property Value String UserPrincipalName User principle name (UPN) of the user Declaration string UserPrincipalName { get; set; } Property Value String Methods AddRoleDefinitions(String[]) Adds role definitions for this user Declaration bool AddRoleDefinitions(params string[] names) Parameters String [] names Returns Boolean AddRoleDefinitionsAsync(String[]) Adds role definitions for this user Declaration Task AddRoleDefinitionsAsync(params string[] names) Parameters String [] names Returns Task < Boolean > AsGraphUser() Returns this SharePoint user as a Graph user Declaration IGraphUser AsGraphUser() Returns IGraphUser AsGraphUserAsync() Returns this SharePoint user as a Graph user Declaration Task AsGraphUserAsync() Returns Task < IGraphUser > GetRoleDefinitions() Retrieves the role definitions for this user Declaration IRoleDefinitionCollection GetRoleDefinitions() Returns IRoleDefinitionCollection GetRoleDefinitionsAsync() Retrieves the role definitions for this user Declaration Task GetRoleDefinitionsAsync() Returns Task < IRoleDefinitionCollection > RemoveRoleDefinitions(String[]) Removes role definitions for this user Declaration bool RemoveRoleDefinitions(params string[] names) Parameters String [] names Returns Boolean RemoveRoleDefinitionsAsync(String[]) Removes role definitions for this user Declaration Task RemoveRoleDefinitionsAsync(params string[] names) Parameters String [] names Returns Task < Boolean > Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.Security.ISharePointUserCollection.html": { "href": "api/PnP.Core.Model.Security.ISharePointUserCollection.html", @@ -1117,12 +1117,12 @@ "api/PnP.Core.Model.Security.MailOptions.html": { "href": "api/PnP.Core.Model.Security.MailOptions.html", "title": "Class MailOptions | PnP Core SDK", - "keywords": "Class MailOptions Options containing the message and whether to save the mail to the sent items of the user or not. Inheritance Object MailOptions Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public class MailOptions : object Properties Message The message to send. Required. Declaration public MessageOptions Message { get; set; } Property Value MessageOptions SaveToSentItems Indicates whether to save the message in Sent Items. Specify it only if the parameter is false; default is true. Optional. Declaration public bool SaveToSentItems { get; set; } Property Value Boolean" + "keywords": "Class MailOptions Options containing the message and whether to save the mail to the sent items of the user or not. Inheritance System.Object MailOptions Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public class MailOptions : object Properties Message The message to send. Required. Declaration public MessageOptions Message { get; set; } Property Value MessageOptions SaveToSentItems Indicates whether to save the message in Sent Items. Specify it only if the parameter is false; default is true. Optional. Declaration public bool SaveToSentItems { get; set; } Property Value Boolean" }, "api/PnP.Core.Model.Security.MessageAttachmentOptions.html": { "href": "api/PnP.Core.Model.Security.MessageAttachmentOptions.html", "title": "Class MessageAttachmentOptions | PnP Core SDK", - "keywords": "Class MessageAttachmentOptions Options for attachments for a message Inheritance Object MessageAttachmentOptions Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public class MessageAttachmentOptions : object Properties ContentBytes Bytes of the attachment Declaration public string ContentBytes { get; set; } Property Value String ContentType Content-Type of the attachment Declaration public string ContentType { get; set; } Property Value String Name Name of the attachment Declaration public string Name { get; set; } Property Value String" + "keywords": "Class MessageAttachmentOptions Options for attachments for a message Inheritance System.Object MessageAttachmentOptions Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public class MessageAttachmentOptions : object Properties ContentBytes Bytes of the attachment Declaration public string ContentBytes { get; set; } Property Value String ContentType Content-Type of the attachment Declaration public string ContentType { get; set; } Property Value String Name Name of the attachment Declaration public string Name { get; set; } Property Value String" }, "api/PnP.Core.Model.Security.MessageBodyContentType.html": { "href": "api/PnP.Core.Model.Security.MessageBodyContentType.html", @@ -1137,12 +1137,12 @@ "api/PnP.Core.Model.Security.MessageOptions.html": { "href": "api/PnP.Core.Model.Security.MessageOptions.html", "title": "Class MessageOptions | PnP Core SDK", - "keywords": "Class MessageOptions The options for a message Inheritance Object MessageOptions Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public class MessageOptions : object Properties Attachments Attachments of the mail message Declaration public List Attachments { get; set; } Property Value List < MessageAttachmentOptions > BccRecipients The Bcc: recipients for the message. Declaration public List BccRecipients { get; set; } Property Value List < RecipientOptions > Body The body of the message. It can be in HTML or text format. Declaration public string Body { get; set; } Property Value String BodyContentType The type of the content. The possible values are text and html. Declaration public MessageBodyContentType BodyContentType { get; set; } Property Value MessageBodyContentType CcRecipients The Cc: recipients for the message. Declaration public List CcRecipients { get; set; } Property Value List < RecipientOptions > Importance The importance of the message. The possible values are: low, normal, and high. Declaration public MessageImportance Importance { get; set; } Property Value MessageImportance ReplyTo The email addresses to use when replying. Declaration public List ReplyTo { get; set; } Property Value List < RecipientOptions > Subject The subject of the message. Declaration public string Subject { get; set; } Property Value String ToRecipients The To: recipients for the message. Declaration public List ToRecipients { get; set; } Property Value List < RecipientOptions >" + "keywords": "Class MessageOptions The options for a message Inheritance System.Object MessageOptions Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public class MessageOptions : object Properties Attachments Attachments of the mail message Declaration public List Attachments { get; set; } Property Value List < MessageAttachmentOptions > BccRecipients The Bcc: recipients for the message. Declaration public List BccRecipients { get; set; } Property Value List < RecipientOptions > Body The body of the message. It can be in HTML or text format. Declaration public string Body { get; set; } Property Value String BodyContentType The type of the content. The possible values are text and html. Declaration public MessageBodyContentType BodyContentType { get; set; } Property Value MessageBodyContentType CcRecipients The Cc: recipients for the message. Declaration public List CcRecipients { get; set; } Property Value List < RecipientOptions > Importance The importance of the message. The possible values are: low, normal, and high. Declaration public MessageImportance Importance { get; set; } Property Value MessageImportance ReplyTo The email addresses to use when replying. Declaration public List ReplyTo { get; set; } Property Value List < RecipientOptions > Subject The subject of the message. Declaration public string Subject { get; set; } Property Value String ToRecipients The To: recipients for the message. Declaration public List ToRecipients { get; set; } Property Value List < RecipientOptions >" }, "api/PnP.Core.Model.Security.OrganizationalLinkOptions.html": { "href": "api/PnP.Core.Model.Security.OrganizationalLinkOptions.html", "title": "Class OrganizationalLinkOptions | PnP Core SDK", - "keywords": "Class OrganizationalLinkOptions Properties that can be set when creating a new Organizational Link Inheritance Object OrganizationalLinkOptions Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public class OrganizationalLinkOptions : object Properties Type The type of sharing link to create. Declaration public ShareType Type { get; set; } Property Value ShareType" + "keywords": "Class OrganizationalLinkOptions Properties that can be set when creating a new Organizational Link Inheritance System.Object OrganizationalLinkOptions Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public class OrganizationalLinkOptions : object Properties Type The type of sharing link to create. Declaration public ShareType Type { get; set; } Property Value ShareType" }, "api/PnP.Core.Model.Security.PermissionRole.html": { "href": "api/PnP.Core.Model.Security.PermissionRole.html", @@ -1157,7 +1157,7 @@ "api/PnP.Core.Model.Security.RecipientOptions.html": { "href": "api/PnP.Core.Model.Security.RecipientOptions.html", "title": "Class RecipientOptions | PnP Core SDK", - "keywords": "Class RecipientOptions Options for a recipient Inheritance Object RecipientOptions Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public class RecipientOptions : object Properties EmailAddress Mail address of the recipient Declaration public string EmailAddress { get; set; } Property Value String" + "keywords": "Class RecipientOptions Options for a recipient Inheritance System.Object RecipientOptions Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public class RecipientOptions : object Properties EmailAddress Mail address of the recipient Declaration public string EmailAddress { get; set; } Property Value String" }, "api/PnP.Core.Model.Security.ShareScope.html": { "href": "api/PnP.Core.Model.Security.ShareScope.html", @@ -1172,7 +1172,7 @@ "api/PnP.Core.Model.Security.UserLinkOptions.html": { "href": "api/PnP.Core.Model.Security.UserLinkOptions.html", "title": "Class UserLinkOptions | PnP Core SDK", - "keywords": "Class UserLinkOptions Properties that can be set when creating a new User Link Inheritance Object InviteOptionsBase UserLinkOptions Inherited Members InviteOptionsBase.CreateDriveRecipient(String) Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public class UserLinkOptions : InviteOptionsBase Properties Recipients A collection of recipients who will receive access to the sharing link. Declaration public List Recipients { get; set; } Property Value List < IDriveRecipient > Type The type of sharing link to create. Declaration public ShareType Type { get; set; } Property Value ShareType" + "keywords": "Class UserLinkOptions Properties that can be set when creating a new User Link Inheritance System.Object InviteOptionsBase UserLinkOptions Inherited Members InviteOptionsBase.CreateDriveRecipient(String) Namespace : PnP.Core.Model.Security Assembly : PnP.Core.dll Syntax public class UserLinkOptions : InviteOptionsBase Properties Recipients A collection of recipients who will receive access to the sharing link. Declaration public List Recipients { get; set; } Property Value List < IDriveRecipient > Type The type of sharing link to create. Declaration public ShareType Type { get; set; } Property Value ShareType" }, "api/PnP.Core.Model.SharePoint.AccessRequestOption.html": { "href": "api/PnP.Core.Model.SharePoint.AccessRequestOption.html", @@ -1182,52 +1182,52 @@ "api/PnP.Core.Model.SharePoint.ACEData.html": { "href": "api/PnP.Core.Model.SharePoint.ACEData.html", "title": "Class ACEData | PnP Core SDK", - "keywords": "Class ACEData Represents aceDate part of ACE properties Inheritance Object ACEData Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ACEData : object Properties CardSize Large or null for small Declaration public string CardSize { get; set; } Property Value String" + "keywords": "Class ACEData Represents aceDate part of ACE properties Inheritance System.Object ACEData Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ACEData : object Properties CardSize Large or null for small Declaration public string CardSize { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.ACEFactory.html": { "href": "api/PnP.Core.Model.SharePoint.ACEFactory.html", "title": "Class ACEFactory | PnP Core SDK", - "keywords": "Class ACEFactory Default ACE factory Inheritance Object ACEFactory AssignedTasksACEFactory CardDesignerACEFactory TeamsACEFactory Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ACEFactory : object Properties ACEId Not used by default factory Declaration public virtual string ACEId { get; } Property Value String Methods BuildACEFromWebPart(IPageWebPart) Returns AdaptiveCardExtension with custom properties deserialized to JsonElement Declaration public virtual AdaptiveCardExtension BuildACEFromWebPart(IPageWebPart control) Parameters IPageWebPart control Returns AdaptiveCardExtension" + "keywords": "Class ACEFactory Default ACE factory Inheritance System.Object ACEFactory AssignedTasksACEFactory CardDesignerACEFactory TeamsACEFactory Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ACEFactory : object Properties ACEId Not used by default factory Declaration public virtual string ACEId { get; } Property Value String Methods BuildACEFromWebPart(IPageWebPart) Returns AdaptiveCardExtension with custom properties deserialized to JsonElement Declaration public virtual AdaptiveCardExtension BuildACEFromWebPart(IPageWebPart control) Parameters IPageWebPart control Returns AdaptiveCardExtension" }, "api/PnP.Core.Model.SharePoint.ACEProperties.html": { "href": "api/PnP.Core.Model.SharePoint.ACEProperties.html", "title": "Class ACEProperties | PnP Core SDK", - "keywords": "Class ACEProperties Represents common properties of ACEs Inheritance Object ACEProperties CardDesignerProps TeamsACEProperties Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ACEProperties : object Properties AceData Shared Adaptive Card properties Declaration public ACEData AceData { get; } Property Value ACEData Description ACE Description Declaration public string Description { get; } Property Value String IconProperty ACE Icon property - usually a link to icon Declaration public string IconProperty { get; } Property Value String Title ACE Title Declaration public string Title { get; } Property Value String" + "keywords": "Class ACEProperties Represents common properties of ACEs Inheritance System.Object ACEProperties CardDesignerProps TeamsACEProperties Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ACEProperties : object Properties AceData Shared Adaptive Card properties Declaration public ACEData AceData { get; } Property Value ACEData Description ACE Description Declaration public string Description { get; } Property Value String IconProperty ACE Icon property - usually a link to icon Declaration public string IconProperty { get; } Property Value String Title ACE Title Declaration public string Title { get; } Property Value String" }, "api/PnP.Core.Model.SharePoint.AdaptiveCardAction.html": { "href": "api/PnP.Core.Model.SharePoint.AdaptiveCardAction.html", "title": "Class AdaptiveCardAction | PnP Core SDK", - "keywords": "Class AdaptiveCardAction ACE card action Inheritance Object AdaptiveCardAction AdaptiveCardAction Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AdaptiveCardAction : object Properties Parameters Action parameters Declaration public object Parameters { get; set; } Property Value Object Type Supported values Action.OpenUrl, Action.Submit, Action.ShowCard, Action.Execute, ExternalLink,QuickView Declaration public string Type { get; set; } Property Value String" + "keywords": "Class AdaptiveCardAction ACE card action Inheritance System.Object AdaptiveCardAction AdaptiveCardAction Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AdaptiveCardAction : object Properties Parameters Action parameters Declaration public object Parameters { get; set; } Property Value System.Object Type Supported values Action.OpenUrl, Action.Submit, Action.ShowCard, Action.Execute, ExternalLink,QuickView Declaration public string Type { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.AdaptiveCardAction-1.html": { "href": "api/PnP.Core.Model.SharePoint.AdaptiveCardAction-1.html", "title": "Class AdaptiveCardAction | PnP Core SDK", - "keywords": "Class AdaptiveCardAction ACE card action Inheritance Object AdaptiveCardAction AdaptiveCardAction ExternalLinkAction QuickViewAction Inherited Members AdaptiveCardAction.Type Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AdaptiveCardAction : AdaptiveCardAction Type Parameters T Type ACE card action Properties Parameters ACE card action parameters Declaration public T Parameters { get; set; } Property Value T" + "keywords": "Class AdaptiveCardAction ACE card action Inheritance System.Object AdaptiveCardAction AdaptiveCardAction ExternalLinkAction QuickViewAction Inherited Members AdaptiveCardAction.Type Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AdaptiveCardAction : AdaptiveCardAction Type Parameters T Type ACE card action Properties Parameters ACE card action parameters Declaration public T Parameters { get; set; } Property Value T" }, "api/PnP.Core.Model.SharePoint.AdaptiveCardControl.html": { "href": "api/PnP.Core.Model.SharePoint.AdaptiveCardControl.html", "title": "Class AdaptiveCardControl | PnP Core SDK", - "keywords": "Class AdaptiveCardControl ACE card control Inheritance Object AdaptiveCardControl Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AdaptiveCardControl : object Properties Size Control size Declaration public string Size { get; set; } Property Value String Text Control text Declaration public string Text { get; set; } Property Value String Type Control type Declaration public string Type { get; set; } Property Value String Weight Control weight Declaration public string Weight { get; set; } Property Value String Wrap Wrap text in control Declaration public bool Wrap { get; set; } Property Value Boolean" + "keywords": "Class AdaptiveCardControl ACE card control Inheritance System.Object AdaptiveCardControl Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AdaptiveCardControl : object Properties Size Control size Declaration public string Size { get; set; } Property Value String Text Control text Declaration public string Text { get; set; } Property Value String Type Control type Declaration public string Type { get; set; } Property Value String Weight Control weight Declaration public string Weight { get; set; } Property Value String Wrap Wrap text in control Declaration public bool Wrap { get; set; } Property Value Boolean" }, "api/PnP.Core.Model.SharePoint.AdaptiveCardExtension.html": { "href": "api/PnP.Core.Model.SharePoint.AdaptiveCardExtension.html", "title": "Class AdaptiveCardExtension | PnP Core SDK", - "keywords": "Class AdaptiveCardExtension Abstract class representing ACE Inheritance Object AdaptiveCardExtension AdaptiveCardExtension AssignedTasksACE Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AdaptiveCardExtension : object Constructors AdaptiveCardExtension(CardSize) Default constructor Declaration public AdaptiveCardExtension(CardSize cardSize = default(CardSize)) Parameters CardSize cardSize Properties ACEType Type of this ACE Declaration public DefaultACE ACEType { get; } Property Value DefaultACE CardSize Size of the ACE Declaration public CardSize CardSize { get; set; } Property Value CardSize Description Gets or sets JsonProperty \"description\" Declaration public string Description { get; set; } Property Value String IconProperty Icon used by the ACE Declaration public string IconProperty { get; set; } Property Value String Id Gets or sets JsonProperty \"id\" Declaration public string Id { get; set; } Property Value String InstanceId Gets or sets JsonProperty \"instanceId\" Declaration public Guid InstanceId { get; } Property Value Guid JsonProperties Json properties of the ACE once added to a dashboard Declaration public JsonElement JsonProperties { get; } Property Value JsonElement Order Order of this ACE inside the dashboard Declaration public int Order { get; } Property Value Int32 Properties Typed properties of the ACE Declaration public virtual object Properties { get; set; } Property Value Object Title Gets or sets JsonProperty \"title\" Declaration public string Title { get; set; } Property Value String" + "keywords": "Class AdaptiveCardExtension Abstract class representing ACE Inheritance System.Object AdaptiveCardExtension AdaptiveCardExtension AssignedTasksACE Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AdaptiveCardExtension : object Constructors AdaptiveCardExtension(CardSize) Default constructor Declaration public AdaptiveCardExtension(CardSize cardSize = default(CardSize)) Parameters CardSize cardSize Properties ACEType Type of this ACE Declaration public DefaultACE ACEType { get; } Property Value DefaultACE CardSize Size of the ACE Declaration public CardSize CardSize { get; set; } Property Value CardSize Description Gets or sets JsonProperty \"description\" Declaration public string Description { get; set; } Property Value String IconProperty Icon used by the ACE Declaration public string IconProperty { get; set; } Property Value String Id Gets or sets JsonProperty \"id\" Declaration public string Id { get; set; } Property Value String InstanceId Gets or sets JsonProperty \"instanceId\" Declaration public Guid InstanceId { get; } Property Value Guid JsonProperties Json properties of the ACE once added to a dashboard Declaration public JsonElement JsonProperties { get; } Property Value JsonElement Order Order of this ACE inside the dashboard Declaration public int Order { get; } Property Value Int32 Properties Typed properties of the ACE Declaration public virtual object Properties { get; set; } Property Value System.Object Title Gets or sets JsonProperty \"title\" Declaration public string Title { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.AdaptiveCardExtension-1.html": { "href": "api/PnP.Core.Model.SharePoint.AdaptiveCardExtension-1.html", "title": "Class AdaptiveCardExtension | PnP Core SDK", - "keywords": "Class AdaptiveCardExtension Defines an ACE Inheritance Object AdaptiveCardExtension AdaptiveCardExtension CardDesignerACE GenericAdaptiveCardExtension TeamsACE Inherited Members AdaptiveCardExtension.Id AdaptiveCardExtension.InstanceId AdaptiveCardExtension.Title AdaptiveCardExtension.Description AdaptiveCardExtension.JsonProperties AdaptiveCardExtension.IconProperty AdaptiveCardExtension.CardSize AdaptiveCardExtension.Order AdaptiveCardExtension.ACEType Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AdaptiveCardExtension : AdaptiveCardExtension Type Parameters T Type of the ACE Constructors AdaptiveCardExtension(CardSize) Default constructor Declaration public AdaptiveCardExtension(CardSize cardSize = default(CardSize)) Parameters CardSize cardSize Properties Properties Properties of the ACE Declaration public T Properties { get; set; } Property Value T" + "keywords": "Class AdaptiveCardExtension Defines an ACE Inheritance System.Object AdaptiveCardExtension AdaptiveCardExtension CardDesignerACE GenericAdaptiveCardExtension TeamsACE Inherited Members AdaptiveCardExtension.Id AdaptiveCardExtension.InstanceId AdaptiveCardExtension.Title AdaptiveCardExtension.Description AdaptiveCardExtension.JsonProperties AdaptiveCardExtension.IconProperty AdaptiveCardExtension.CardSize AdaptiveCardExtension.Order AdaptiveCardExtension.ACEType Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AdaptiveCardExtension : AdaptiveCardExtension Type Parameters T Type of the ACE Constructors AdaptiveCardExtension(CardSize) Default constructor Declaration public AdaptiveCardExtension(CardSize cardSize = default(CardSize)) Parameters CardSize cardSize Properties Properties Properties of the ACE Declaration public T Properties { get; set; } Property Value T" }, "api/PnP.Core.Model.SharePoint.AdaptiveCardTemplate.html": { "href": "api/PnP.Core.Model.SharePoint.AdaptiveCardTemplate.html", "title": "Class AdaptiveCardTemplate | PnP Core SDK", - "keywords": "Class AdaptiveCardTemplate ACE template Inheritance Object AdaptiveCardTemplate Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AdaptiveCardTemplate : object Properties Actions ACE actions Declaration public List Actions { get; set; } Property Value PnP.Core.Model.SharePoint.List < AdaptiveCardAction > Body ACE body Declaration public List Body { get; set; } Property Value PnP.Core.Model.SharePoint.List < AdaptiveCardControl > Type ACE template type Declaration public string Type { get; set; } Property Value String" + "keywords": "Class AdaptiveCardTemplate ACE template Inheritance System.Object AdaptiveCardTemplate Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AdaptiveCardTemplate : object Properties Actions ACE actions Declaration public List Actions { get; set; } Property Value PnP.Core.Model.SharePoint.List < AdaptiveCardAction > Body ACE body Declaration public List Body { get; set; } Property Value PnP.Core.Model.SharePoint.List < AdaptiveCardControl > Type ACE template type Declaration public string Type { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.AddContentTypeFromHubOptions.html": { "href": "api/PnP.Core.Model.SharePoint.AddContentTypeFromHubOptions.html", "title": "Class AddContentTypeFromHubOptions | PnP Core SDK", - "keywords": "Class AddContentTypeFromHubOptions Defines the options that control the adding of content types from the content type hub Inheritance Object AddContentTypeFromHubOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AddContentTypeFromHubOptions : object Properties LongRunningOperationOptions Defines the wait behavior for when the adding happens async Declaration public LongRunningOperationOptions LongRunningOperationOptions { get; set; } Property Value LongRunningOperationOptions WaitForCompletion Wait for the, possibly async, add operation to complete Declaration public bool WaitForCompletion { get; set; } Property Value Boolean" + "keywords": "Class AddContentTypeFromHubOptions Defines the options that control the adding of content types from the content type hub Inheritance System.Object AddContentTypeFromHubOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AddContentTypeFromHubOptions : object Properties LongRunningOperationOptions Defines the wait behavior for when the adding happens async Declaration public LongRunningOperationOptions LongRunningOperationOptions { get; set; } Property Value LongRunningOperationOptions WaitForCompletion Wait for the, possibly async, add operation to complete Declaration public bool WaitForCompletion { get; set; } Property Value Boolean" }, "api/PnP.Core.Model.SharePoint.AddFieldOptionsFlags.html": { "href": "api/PnP.Core.Model.SharePoint.AddFieldOptionsFlags.html", @@ -1237,7 +1237,7 @@ "api/PnP.Core.Model.SharePoint.AddUserCustomActionOptions.html": { "href": "api/PnP.Core.Model.SharePoint.AddUserCustomActionOptions.html", "title": "Class AddUserCustomActionOptions | PnP Core SDK", - "keywords": "Class AddUserCustomActionOptions Options to specify when adding User Custom Action Inheritance Object AddUserCustomActionOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AddUserCustomActionOptions : object Properties ClientSideComponentId Gets or sets the unique identifier of the associated client side component. Declaration public Guid? ClientSideComponentId { get; set; } Property Value Nullable < Guid > ClientSideComponentProperties Gets or sets the JSON formatted properties of the associated client side component. Declaration public string ClientSideComponentProperties { get; set; } Property Value String CommandUIExtension Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action. Declaration public string CommandUIExtension { get; set; } Property Value String Description Gets or sets the description of the custom action. Declaration public string Description { get; set; } Property Value String Group Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page. Declaration public string Group { get; set; } Property Value String HostProperties This property is only used when an application customizer is created and preallocated placeholders are specified. It is optional. If non-empty, the string must contain a JSON object with one or two properties for the height amount needed to be preallocated. Declaration public string HostProperties { get; set; } Property Value String ImageUrl Gets or sets the URL of the image associated with the custom action. Declaration public string ImageUrl { get; set; } Property Value String Location Gets or sets the location of the custom action. Declaration public string Location { get; set; } Property Value String Name Gets or sets the name of the custom action. Declaration public string Name { get; set; } Property Value String RegistrationId Gets or sets the value that specifies the identifier of the object associated with the custom action. Declaration public string RegistrationId { get; set; } Property Value String RegistrationType Gets or sets the value that specifies the type of object associated with the custom action. Declaration public UserCustomActionRegistrationType? RegistrationType { get; set; } Property Value Nullable < UserCustomActionRegistrationType > Rights Gets or sets the Rights for this action. Declaration public IBasePermissions Rights { get; set; } Property Value IBasePermissions ScriptBlock Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed. Declaration public string ScriptBlock { get; set; } Property Value String ScriptSrc Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page. Declaration public string ScriptSrc { get; set; } Property Value String Sequence Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page. Declaration public int? Sequence { get; set; } Property Value Nullable < Int32 > Title Gets or sets the display title of the custom action. Declaration public string Title { get; set; } Property Value String Url Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action. Declaration public string Url { get; set; } Property Value String" + "keywords": "Class AddUserCustomActionOptions Options to specify when adding User Custom Action Inheritance System.Object AddUserCustomActionOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AddUserCustomActionOptions : object Properties ClientSideComponentId Gets or sets the unique identifier of the associated client side component. Declaration public Guid? ClientSideComponentId { get; set; } Property Value Nullable < Guid > ClientSideComponentProperties Gets or sets the JSON formatted properties of the associated client side component. Declaration public string ClientSideComponentProperties { get; set; } Property Value String CommandUIExtension Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action. Declaration public string CommandUIExtension { get; set; } Property Value String Description Gets or sets the description of the custom action. Declaration public string Description { get; set; } Property Value String Group Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page. Declaration public string Group { get; set; } Property Value String HostProperties This property is only used when an application customizer is created and preallocated placeholders are specified. It is optional. If non-empty, the string must contain a JSON object with one or two properties for the height amount needed to be preallocated. Declaration public string HostProperties { get; set; } Property Value String ImageUrl Gets or sets the URL of the image associated with the custom action. Declaration public string ImageUrl { get; set; } Property Value String Location Gets or sets the location of the custom action. Declaration public string Location { get; set; } Property Value String Name Gets or sets the name of the custom action. Declaration public string Name { get; set; } Property Value String RegistrationId Gets or sets the value that specifies the identifier of the object associated with the custom action. Declaration public string RegistrationId { get; set; } Property Value String RegistrationType Gets or sets the value that specifies the type of object associated with the custom action. Declaration public UserCustomActionRegistrationType? RegistrationType { get; set; } Property Value Nullable < UserCustomActionRegistrationType > Rights Gets or sets the Rights for this action. Declaration public IBasePermissions Rights { get; set; } Property Value IBasePermissions ScriptBlock Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed. Declaration public string ScriptBlock { get; set; } Property Value String ScriptSrc Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page. Declaration public string ScriptSrc { get; set; } Property Value String Sequence Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page. Declaration public int? Sequence { get; set; } Property Value Nullable < Int32 > Title Gets or sets the display title of the custom action. Declaration public string Title { get; set; } Property Value String Url Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action. Declaration public string Url { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.AnalyticsAggregationInterval.html": { "href": "api/PnP.Core.Model.SharePoint.AnalyticsAggregationInterval.html", @@ -1252,22 +1252,22 @@ "api/PnP.Core.Model.SharePoint.AnalyticsOptions.html": { "href": "api/PnP.Core.Model.SharePoint.AnalyticsOptions.html", "title": "Class AnalyticsOptions | PnP Core SDK", - "keywords": "Class AnalyticsOptions Defines what analytics must be retrieved Inheritance Object AnalyticsOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AnalyticsOptions : object Properties CustomAggregationInterval Aggregation interval for analytics retrieval using Custom as interval. Defaults to Day Declaration public AnalyticsAggregationInterval CustomAggregationInterval { get; set; } Property Value AnalyticsAggregationInterval CustomEndDate End date (UTC) for analytics retrieval using Custom as interval Declaration public DateTime CustomEndDate { get; set; } Property Value DateTime CustomStartDate Start date (UTC) for analytics retrieval using Custom as interval Declaration public DateTime CustomStartDate { get; set; } Property Value DateTime Interval Defines the analytics interval, defaults to all time Declaration public AnalyticsInterval Interval { get; set; } Property Value AnalyticsInterval" + "keywords": "Class AnalyticsOptions Defines what analytics must be retrieved Inheritance System.Object AnalyticsOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AnalyticsOptions : object Properties CustomAggregationInterval Aggregation interval for analytics retrieval using Custom as interval. Defaults to Day Declaration public AnalyticsAggregationInterval CustomAggregationInterval { get; set; } Property Value AnalyticsAggregationInterval CustomEndDate End date (UTC) for analytics retrieval using Custom as interval Declaration public DateTime CustomEndDate { get; set; } Property Value DateTime CustomStartDate Start date (UTC) for analytics retrieval using Custom as interval Declaration public DateTime CustomStartDate { get; set; } Property Value DateTime Interval Defines the analytics interval, defaults to all time Declaration public AnalyticsInterval Interval { get; set; } Property Value AnalyticsInterval" }, "api/PnP.Core.Model.SharePoint.AssignedTasksACE.html": { "href": "api/PnP.Core.Model.SharePoint.AssignedTasksACE.html", "title": "Class AssignedTasksACE | PnP Core SDK", - "keywords": "Class AssignedTasksACE Assigned tasks ACE Inheritance Object AdaptiveCardExtension AssignedTasksACE Inherited Members AdaptiveCardExtension.Id AdaptiveCardExtension.InstanceId AdaptiveCardExtension.Title AdaptiveCardExtension.Description AdaptiveCardExtension.Properties AdaptiveCardExtension.JsonProperties AdaptiveCardExtension.IconProperty AdaptiveCardExtension.CardSize AdaptiveCardExtension.Order AdaptiveCardExtension.ACEType Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AssignedTasksACE : AdaptiveCardExtension Constructors AssignedTasksACE(CardSize) Default constructor Declaration public AssignedTasksACE(CardSize cardSize = default(CardSize)) Parameters CardSize cardSize" + "keywords": "Class AssignedTasksACE Assigned tasks ACE Inheritance System.Object AdaptiveCardExtension AssignedTasksACE Inherited Members AdaptiveCardExtension.Id AdaptiveCardExtension.InstanceId AdaptiveCardExtension.Title AdaptiveCardExtension.Description AdaptiveCardExtension.Properties AdaptiveCardExtension.JsonProperties AdaptiveCardExtension.IconProperty AdaptiveCardExtension.CardSize AdaptiveCardExtension.Order AdaptiveCardExtension.ACEType Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AssignedTasksACE : AdaptiveCardExtension Constructors AssignedTasksACE(CardSize) Default constructor Declaration public AssignedTasksACE(CardSize cardSize = default(CardSize)) Parameters CardSize cardSize" }, "api/PnP.Core.Model.SharePoint.AssignedTasksACEFactory.html": { "href": "api/PnP.Core.Model.SharePoint.AssignedTasksACEFactory.html", "title": "Class AssignedTasksACEFactory | PnP Core SDK", - "keywords": "Class AssignedTasksACEFactory Creates new instance of Assigened Tasks ACE based on provided WebPart Inheritance Object ACEFactory AssignedTasksACEFactory Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AssignedTasksACEFactory : ACEFactory Properties ACEId Id of Assigened Tasks AdaptiveCardExtension Declaration public override string ACEId { get; } Property Value String Overrides ACEFactory.ACEId Methods BuildACEFromWebPart(IPageWebPart) Returns Assigened Tasks ACE Declaration public override AdaptiveCardExtension BuildACEFromWebPart(IPageWebPart control) Parameters IPageWebPart control WebPart used to store ACE configuration Returns AdaptiveCardExtension Overrides ACEFactory.BuildACEFromWebPart(IPageWebPart)" + "keywords": "Class AssignedTasksACEFactory Creates new instance of Assigened Tasks ACE based on provided WebPart Inheritance System.Object ACEFactory AssignedTasksACEFactory Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class AssignedTasksACEFactory : ACEFactory Properties ACEId Id of Assigened Tasks AdaptiveCardExtension Declaration public override string ACEId { get; } Property Value String Overrides ACEFactory.ACEId Methods BuildACEFromWebPart(IPageWebPart) Returns Assigened Tasks ACE Declaration public override AdaptiveCardExtension BuildACEFromWebPart(IPageWebPart control) Parameters IPageWebPart control WebPart used to store ACE configuration Returns AdaptiveCardExtension Overrides ACEFactory.BuildACEFromWebPart(IPageWebPart)" }, "api/PnP.Core.Model.SharePoint.ButtonAction.html": { "href": "api/PnP.Core.Model.SharePoint.ButtonAction.html", "title": "Class ButtonAction | PnP Core SDK", - "keywords": "Class ButtonAction ACE card button action Inheritance Object ButtonAction Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ButtonAction : object Properties Action Action to execute Declaration public AdaptiveCardAction Action { get; set; } Property Value AdaptiveCardAction IsVisible Is the button visible Declaration public bool? IsVisible { get; set; } Property Value Nullable < Boolean > Style Supported values: positive or default Declaration public string Style { get; set; } Property Value String Title Button title Declaration public string Title { get; set; } Property Value String" + "keywords": "Class ButtonAction ACE card button action Inheritance System.Object ButtonAction Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ButtonAction : object Properties Action Action to execute Declaration public AdaptiveCardAction Action { get; set; } Property Value AdaptiveCardAction IsVisible Is the button visible Declaration public bool? IsVisible { get; set; } Property Value Nullable < Boolean > Style Supported values: positive or default Declaration public string Style { get; set; } Property Value String Title Button title Declaration public string Title { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.CalendarType.html": { "href": "api/PnP.Core.Model.SharePoint.CalendarType.html", @@ -1277,7 +1277,7 @@ "api/PnP.Core.Model.SharePoint.CamlQueryOptions.html": { "href": "api/PnP.Core.Model.SharePoint.CamlQueryOptions.html", "title": "Class CamlQueryOptions | PnP Core SDK", - "keywords": "Class CamlQueryOptions Options for making a CAML query to SharePoint Online Inheritance Object CamlQueryOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class CamlQueryOptions : object Properties AllowIncrementalResults Can the query return incremental results Declaration public bool? AllowIncrementalResults { get; set; } Property Value Nullable < Boolean > DatesInUtc Return dates in UTC format Declaration public bool? DatesInUtc { get; set; } Property Value Nullable < Boolean > FolderServerRelativeUrl Specifies the server relative URL of a list folder from which results will be returned Declaration public string FolderServerRelativeUrl { get; set; } Property Value String PagingInfo Value that specifies information, as name-value pairs, required to get the next page of data for a list view Declaration public string PagingInfo { get; set; } Property Value String ViewXml Caml query to execute Declaration public string ViewXml { get; set; } Property Value String" + "keywords": "Class CamlQueryOptions Options for making a CAML query to SharePoint Online Inheritance System.Object CamlQueryOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class CamlQueryOptions : object Properties AllowIncrementalResults Can the query return incremental results Declaration public bool? AllowIncrementalResults { get; set; } Property Value Nullable < Boolean > DatesInUtc Return dates in UTC format Declaration public bool? DatesInUtc { get; set; } Property Value Nullable < Boolean > FolderServerRelativeUrl Specifies the server relative URL of a list folder from which results will be returned Declaration public string FolderServerRelativeUrl { get; set; } Property Value String PagingInfo Value that specifies information, as name-value pairs, required to get the next page of data for a list view Declaration public string PagingInfo { get; set; } Property Value String ViewXml Caml query to execute Declaration public string ViewXml { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.CanvasSectionTemplate.html": { "href": "api/PnP.Core.Model.SharePoint.CanvasSectionTemplate.html", @@ -1287,17 +1287,17 @@ "api/PnP.Core.Model.SharePoint.CardDesignerACE.html": { "href": "api/PnP.Core.Model.SharePoint.CardDesignerACE.html", "title": "Class CardDesignerACE | PnP Core SDK", - "keywords": "Class CardDesignerACE Represents the card designer ACE Inheritance Object AdaptiveCardExtension AdaptiveCardExtension < CardDesignerProps > CardDesignerACE Inherited Members AdaptiveCardExtension.Properties AdaptiveCardExtension.Id AdaptiveCardExtension.InstanceId AdaptiveCardExtension.Title AdaptiveCardExtension.Description AdaptiveCardExtension.JsonProperties AdaptiveCardExtension.IconProperty AdaptiveCardExtension.CardSize AdaptiveCardExtension.Order AdaptiveCardExtension.ACEType Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class CardDesignerACE : AdaptiveCardExtension Constructors CardDesignerACE(CardSize) Default constructor Declaration public CardDesignerACE(CardSize cardSize = default(CardSize)) Parameters CardSize cardSize" + "keywords": "Class CardDesignerACE Represents the card designer ACE Inheritance System.Object AdaptiveCardExtension AdaptiveCardExtension < CardDesignerProps > CardDesignerACE Inherited Members AdaptiveCardExtension.Properties AdaptiveCardExtension.Id AdaptiveCardExtension.InstanceId AdaptiveCardExtension.Title AdaptiveCardExtension.Description AdaptiveCardExtension.JsonProperties AdaptiveCardExtension.IconProperty AdaptiveCardExtension.CardSize AdaptiveCardExtension.Order AdaptiveCardExtension.ACEType Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class CardDesignerACE : AdaptiveCardExtension Constructors CardDesignerACE(CardSize) Default constructor Declaration public CardDesignerACE(CardSize cardSize = default(CardSize)) Parameters CardSize cardSize" }, "api/PnP.Core.Model.SharePoint.CardDesignerACEFactory.html": { "href": "api/PnP.Core.Model.SharePoint.CardDesignerACEFactory.html", "title": "Class CardDesignerACEFactory | PnP Core SDK", - "keywords": "Class CardDesignerACEFactory Creates new instance of CardDesigner ACE based on provided WebPart Inheritance Object ACEFactory CardDesignerACEFactory Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class CardDesignerACEFactory : ACEFactory Properties ACEId Id of CardDesigner AdaptiveCardExtension Declaration public override string ACEId { get; } Property Value String Overrides ACEFactory.ACEId Methods BuildACEFromWebPart(IPageWebPart) Returns CardDesigner Declaration public override AdaptiveCardExtension BuildACEFromWebPart(IPageWebPart control) Parameters IPageWebPart control WebPart used to store ACE configuration Returns AdaptiveCardExtension Overrides ACEFactory.BuildACEFromWebPart(IPageWebPart)" + "keywords": "Class CardDesignerACEFactory Creates new instance of CardDesigner ACE based on provided WebPart Inheritance System.Object ACEFactory CardDesignerACEFactory Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class CardDesignerACEFactory : ACEFactory Properties ACEId Id of CardDesigner AdaptiveCardExtension Declaration public override string ACEId { get; } Property Value String Overrides ACEFactory.ACEId Methods BuildACEFromWebPart(IPageWebPart) Returns CardDesigner Declaration public override AdaptiveCardExtension BuildACEFromWebPart(IPageWebPart control) Parameters IPageWebPart control WebPart used to store ACE configuration Returns AdaptiveCardExtension Overrides ACEFactory.BuildACEFromWebPart(IPageWebPart)" }, "api/PnP.Core.Model.SharePoint.CardDesignerProps.html": { "href": "api/PnP.Core.Model.SharePoint.CardDesignerProps.html", "title": "Class CardDesignerProps | PnP Core SDK", - "keywords": "Class CardDesignerProps Card designer ACE properties Inheritance Object ACEProperties CardDesignerProps Inherited Members ACEProperties.AceData ACEProperties.Title ACEProperties.Description ACEProperties.IconProperty Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class CardDesignerProps : ACEProperties Properties CardButtonActions Describes actions on card buttons clicked Declaration public List CardButtonActions { get; set; } Property Value PnP.Core.Model.SharePoint.List < ButtonAction > CardIconSourceType Icon source type of the card Declaration public int CardIconSourceType { get; set; } Property Value Int32 CardImageSourceType Image source type of the card Declaration public int CardImageSourceType { get; set; } Property Value Int32 CardSelectionAction Describes action on card clicked Declaration public AdaptiveCardAction CardSelectionAction { get; set; } Property Value AdaptiveCardAction CurrentQuickViewIndex Current card quick view index Declaration public int CurrentQuickViewIndex { get; set; } Property Value Int32 CustomImageSettings Card icon image settings Declaration public CustomImageSettings CustomImageSettings { get; set; } Property Value CustomImageSettings DataType Card data type Declaration public string DataType { get; set; } Property Value String GraphRequestUrl Microsoft Graph request url for the card Declaration public string GraphRequestUrl { get; set; } Property Value String NumberCardButtonActions The number of buttons that will be rendered by ACE Declaration public int NumberCardButtonActions { get; set; } Property Value Int32 PrimaryText Card primary text Declaration public string PrimaryText { get; set; } Property Value String QuickViewConfigured Returns true if ACE should use QuickView Declaration public bool QuickViewConfigured { get; set; } Property Value Boolean QuickViews Lists of supported QuickViews Declaration public List QuickViews { get; set; } Property Value PnP.Core.Model.SharePoint.List < QuickView > RequestUrl Request url for the card Declaration public string RequestUrl { get; set; } Property Value String SPRequestUrl SharePoint request url for the card Declaration public string SPRequestUrl { get; set; } Property Value String TemplateType Represents type of the Card primaryText, heading or image Declaration public string TemplateType { get; set; } Property Value String" + "keywords": "Class CardDesignerProps Card designer ACE properties Inheritance System.Object ACEProperties CardDesignerProps Inherited Members ACEProperties.AceData ACEProperties.Title ACEProperties.Description ACEProperties.IconProperty Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class CardDesignerProps : ACEProperties Properties CardButtonActions Describes actions on card buttons clicked Declaration public List CardButtonActions { get; set; } Property Value PnP.Core.Model.SharePoint.List < ButtonAction > CardIconSourceType Icon source type of the card Declaration public int CardIconSourceType { get; set; } Property Value Int32 CardImageSourceType Image source type of the card Declaration public int CardImageSourceType { get; set; } Property Value Int32 CardSelectionAction Describes action on card clicked Declaration public AdaptiveCardAction CardSelectionAction { get; set; } Property Value AdaptiveCardAction CurrentQuickViewIndex Current card quick view index Declaration public int CurrentQuickViewIndex { get; set; } Property Value Int32 CustomImageSettings Card icon image settings Declaration public CustomImageSettings CustomImageSettings { get; set; } Property Value CustomImageSettings DataType Card data type Declaration public string DataType { get; set; } Property Value String GraphRequestUrl Microsoft Graph request url for the card Declaration public string GraphRequestUrl { get; set; } Property Value String NumberCardButtonActions The number of buttons that will be rendered by ACE Declaration public int NumberCardButtonActions { get; set; } Property Value Int32 PrimaryText Card primary text Declaration public string PrimaryText { get; set; } Property Value String QuickViewConfigured Returns true if ACE should use QuickView Declaration public bool QuickViewConfigured { get; set; } Property Value Boolean QuickViews Lists of supported QuickViews Declaration public List QuickViews { get; set; } Property Value PnP.Core.Model.SharePoint.List < QuickView > RequestUrl Request url for the card Declaration public string RequestUrl { get; set; } Property Value String SPRequestUrl SharePoint request url for the card Declaration public string SPRequestUrl { get; set; } Property Value String TemplateType Represents type of the Card primaryText, heading or image Declaration public string TemplateType { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.CardSize.html": { "href": "api/PnP.Core.Model.SharePoint.CardSize.html", @@ -1312,12 +1312,12 @@ "api/PnP.Core.Model.SharePoint.ChangeQueryOptions.html": { "href": "api/PnP.Core.Model.SharePoint.ChangeQueryOptions.html", "title": "Class ChangeQueryOptions | PnP Core SDK", - "keywords": "Class ChangeQueryOptions Defines a query that is performed against the change log. Inheritance Object ChangeQueryOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ChangeQueryOptions : object Constructors ChangeQueryOptions() Initializes a new instance of the ChangeQueryOptions class. Declaration public ChangeQueryOptions() ChangeQueryOptions(Boolean, Boolean) Initializes a new instance of the ChangeQueryOptions class. Declaration public ChangeQueryOptions(bool allChangeObjectTypes, bool allChangeTypes) Parameters Boolean allChangeObjectTypes If true , get changes for all change object types. Boolean allChangeTypes If true , get all change types. Properties Activity Specifies whether activity is included in the query. Declaration public bool Activity { get; set; } Property Value Boolean Add Gets or sets a value that specifies whether add changes are included in the query. Declaration public bool Add { get; set; } Property Value Boolean Alert Gets or sets a value that specifies whether changes to alerts are included in the query. Declaration public bool Alert { get; set; } Property Value Boolean ChangeTokenEnd Gets or sets a value that specifies the end date and end time for changes that are returned through the query. Declaration public IChangeToken ChangeTokenEnd { get; set; } Property Value IChangeToken ChangeTokenStart Gets or sets a value that specifies the start date and start time for changes that are returned through the query. Changes after this change token are returned. Declaration public IChangeToken ChangeTokenStart { get; set; } Property Value IChangeToken ContentType Gets or sets a value that specifies whether changes to content types are included in the query. Declaration public bool ContentType { get; set; } Property Value Boolean DeleteObject Gets or sets a value that specifies whether delete changes are included in the query. Declaration public bool DeleteObject { get; set; } Property Value Boolean FetchLimit The maximum number of items to return (defaults to 1000). Declaration public long FetchLimit { get; set; } Property Value Int64 Field Gets or sets a value that specifies whether changes to site columns are included in the query. Declaration public bool Field { get; set; } Property Value Boolean File Gets or sets a value that specifies whether changes to files are included in the query. Declaration public bool File { get; set; } Property Value Boolean Folder Gets or sets value that specifies whether changes to folders are included in the query. Declaration public bool Folder { get; set; } Property Value Boolean Group Gets or sets a value that specifies whether changes to groups are included in the query. Declaration public bool Group { get; set; } Property Value Boolean GroupMembershipAdd Gets or sets a value that specifies whether adding users to groups is included in the query. Declaration public bool GroupMembershipAdd { get; set; } Property Value Boolean GroupMembershipDelete Gets or sets a value that specifies whether deleting users from the groups is included in the query. Declaration public bool GroupMembershipDelete { get; set; } Property Value Boolean IgnoreStartTokenNotFoundError Ignore errors when calling GetChanges if the caller's start ChangeToken is not found in the database (exact match) or if there are no changes in the database. Declaration public bool IgnoreStartTokenNotFoundError { get; set; } Property Value Boolean Item Gets or sets a value that specifies whether general changes to list items are included in the query. Declaration public bool Item { get; set; } Property Value Boolean LatestFirst Gets or sets a value that specifies whether to order the results by Modified By date, most recent first. Declaration public bool LatestFirst { get; set; } Property Value Boolean List Gets or sets a value that specifies whether changes to lists are included in the query. Declaration public bool List { get; set; } Property Value Boolean Move Gets or sets a value that specifies whether move changes are included in the query. Declaration public bool Move { get; set; } Property Value Boolean Navigation Gets or sets a value that specifies whether changes to the navigation structure of a site collection are included in the query. Declaration public bool Navigation { get; set; } Property Value Boolean RecursiveAll specifies whether we return all the change logs for folder scoped query. The flag will only work for Folder query. If true, all changes in the current folder and all sub folders will be returned. Otherwise, only changes in the current folder will be returned. Declaration public bool RecursiveAll { get; set; } Property Value Boolean Rename Gets or sets a value that specifies whether renaming changes are included in the query. Declaration public bool Rename { get; set; } Property Value Boolean RequireSecurityTrim Specifies whether we return log with security trimming. If true, we'll return the events with security trimming. Declaration public bool RequireSecurityTrim { get; set; } Property Value Boolean Restore Gets or sets a value that specifies whether restoring items from the recycle bin or from backups is included in the query. Declaration public bool Restore { get; set; } Property Value Boolean RoleAssignmentAdd Gets or sets a value that specifies whether adding role assignments is included in the query. Declaration public bool RoleAssignmentAdd { get; set; } Property Value Boolean RoleAssignmentDelete Gets or sets a value that specifies whether deleting role assignments is included in the query. Declaration public bool RoleAssignmentDelete { get; set; } Property Value Boolean RoleDefinitionAdd Gets or sets a value that specifies whether adding role definitions is included in the query. Declaration public bool RoleDefinitionAdd { get; set; } Property Value Boolean RoleDefinitionDelete Gets or sets a value that specifies whether deleting role definitions is included in the query. Declaration public bool RoleDefinitionDelete { get; set; } Property Value Boolean RoleDefinitionUpdate Gets or sets a value that specifies whether modifying role definitions is included in the query. Declaration public bool RoleDefinitionUpdate { get; set; } Property Value Boolean SecurityPolicy Gets or sets a value that specifies whether modifications to security policies are included in the query. Declaration public bool SecurityPolicy { get; set; } Property Value Boolean Site Gets or sets a value that specifies whether changes to site collections are included in the query. Declaration public bool Site { get; set; } Property Value Boolean SystemUpdate Gets or sets a value that specifies whether updates made using the item SystemUpdate method are included in the query. Declaration public bool SystemUpdate { get; set; } Property Value Boolean Update Gets or sets a value that specifies whether update changes are included in the query. Declaration public bool Update { get; set; } Property Value Boolean User Gets or sets a value that specifies whether changes to users are included in the query. Declaration public bool User { get; set; } Property Value Boolean View Gets or sets a value that specifies whether changes to views are included in the query. Declaration public bool View { get; set; } Property Value Boolean Web Gets or sets a value that specifies whether changes to Web sites are included in the query. Declaration public bool Web { get; set; } Property Value Boolean" + "keywords": "Class ChangeQueryOptions Defines a query that is performed against the change log. Inheritance System.Object ChangeQueryOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ChangeQueryOptions : object Constructors ChangeQueryOptions() Initializes a new instance of the ChangeQueryOptions class. Declaration public ChangeQueryOptions() ChangeQueryOptions(Boolean, Boolean) Initializes a new instance of the ChangeQueryOptions class. Declaration public ChangeQueryOptions(bool allChangeObjectTypes, bool allChangeTypes) Parameters Boolean allChangeObjectTypes If true , get changes for all change object types. Boolean allChangeTypes If true , get all change types. Properties Activity Specifies whether activity is included in the query. Declaration public bool Activity { get; set; } Property Value Boolean Add Gets or sets a value that specifies whether add changes are included in the query. Declaration public bool Add { get; set; } Property Value Boolean Alert Gets or sets a value that specifies whether changes to alerts are included in the query. Declaration public bool Alert { get; set; } Property Value Boolean ChangeTokenEnd Gets or sets a value that specifies the end date and end time for changes that are returned through the query. Declaration public IChangeToken ChangeTokenEnd { get; set; } Property Value IChangeToken ChangeTokenStart Gets or sets a value that specifies the start date and start time for changes that are returned through the query. Changes after this change token are returned. Declaration public IChangeToken ChangeTokenStart { get; set; } Property Value IChangeToken ContentType Gets or sets a value that specifies whether changes to content types are included in the query. Declaration public bool ContentType { get; set; } Property Value Boolean DeleteObject Gets or sets a value that specifies whether delete changes are included in the query. Declaration public bool DeleteObject { get; set; } Property Value Boolean FetchLimit The maximum number of items to return (defaults to 1000). Declaration public long FetchLimit { get; set; } Property Value Int64 Field Gets or sets a value that specifies whether changes to site columns are included in the query. Declaration public bool Field { get; set; } Property Value Boolean File Gets or sets a value that specifies whether changes to files are included in the query. Declaration public bool File { get; set; } Property Value Boolean Folder Gets or sets value that specifies whether changes to folders are included in the query. Declaration public bool Folder { get; set; } Property Value Boolean Group Gets or sets a value that specifies whether changes to groups are included in the query. Declaration public bool Group { get; set; } Property Value Boolean GroupMembershipAdd Gets or sets a value that specifies whether adding users to groups is included in the query. Declaration public bool GroupMembershipAdd { get; set; } Property Value Boolean GroupMembershipDelete Gets or sets a value that specifies whether deleting users from the groups is included in the query. Declaration public bool GroupMembershipDelete { get; set; } Property Value Boolean IgnoreStartTokenNotFoundError Ignore errors when calling GetChanges if the caller's start ChangeToken is not found in the database (exact match) or if there are no changes in the database. Declaration public bool IgnoreStartTokenNotFoundError { get; set; } Property Value Boolean Item Gets or sets a value that specifies whether general changes to list items are included in the query. Declaration public bool Item { get; set; } Property Value Boolean LatestFirst Gets or sets a value that specifies whether to order the results by Modified By date, most recent first. Declaration public bool LatestFirst { get; set; } Property Value Boolean List Gets or sets a value that specifies whether changes to lists are included in the query. Declaration public bool List { get; set; } Property Value Boolean Move Gets or sets a value that specifies whether move changes are included in the query. Declaration public bool Move { get; set; } Property Value Boolean Navigation Gets or sets a value that specifies whether changes to the navigation structure of a site collection are included in the query. Declaration public bool Navigation { get; set; } Property Value Boolean RecursiveAll specifies whether we return all the change logs for folder scoped query. The flag will only work for Folder query. If true, all changes in the current folder and all sub folders will be returned. Otherwise, only changes in the current folder will be returned. Declaration public bool RecursiveAll { get; set; } Property Value Boolean Rename Gets or sets a value that specifies whether renaming changes are included in the query. Declaration public bool Rename { get; set; } Property Value Boolean RequireSecurityTrim Specifies whether we return log with security trimming. If true, we'll return the events with security trimming. Declaration public bool RequireSecurityTrim { get; set; } Property Value Boolean Restore Gets or sets a value that specifies whether restoring items from the recycle bin or from backups is included in the query. Declaration public bool Restore { get; set; } Property Value Boolean RoleAssignmentAdd Gets or sets a value that specifies whether adding role assignments is included in the query. Declaration public bool RoleAssignmentAdd { get; set; } Property Value Boolean RoleAssignmentDelete Gets or sets a value that specifies whether deleting role assignments is included in the query. Declaration public bool RoleAssignmentDelete { get; set; } Property Value Boolean RoleDefinitionAdd Gets or sets a value that specifies whether adding role definitions is included in the query. Declaration public bool RoleDefinitionAdd { get; set; } Property Value Boolean RoleDefinitionDelete Gets or sets a value that specifies whether deleting role definitions is included in the query. Declaration public bool RoleDefinitionDelete { get; set; } Property Value Boolean RoleDefinitionUpdate Gets or sets a value that specifies whether modifying role definitions is included in the query. Declaration public bool RoleDefinitionUpdate { get; set; } Property Value Boolean SecurityPolicy Gets or sets a value that specifies whether modifications to security policies are included in the query. Declaration public bool SecurityPolicy { get; set; } Property Value Boolean Site Gets or sets a value that specifies whether changes to site collections are included in the query. Declaration public bool Site { get; set; } Property Value Boolean SystemUpdate Gets or sets a value that specifies whether updates made using the item SystemUpdate method are included in the query. Declaration public bool SystemUpdate { get; set; } Property Value Boolean Update Gets or sets a value that specifies whether update changes are included in the query. Declaration public bool Update { get; set; } Property Value Boolean User Gets or sets a value that specifies whether changes to users are included in the query. Declaration public bool User { get; set; } Property Value Boolean View Gets or sets a value that specifies whether changes to views are included in the query. Declaration public bool View { get; set; } Property Value Boolean Web Gets or sets a value that specifies whether changes to Web sites are included in the query. Declaration public bool Web { get; set; } Property Value Boolean" }, "api/PnP.Core.Model.SharePoint.ChangeTokenOptions.html": { "href": "api/PnP.Core.Model.SharePoint.ChangeTokenOptions.html", "title": "Class ChangeTokenOptions | PnP Core SDK", - "keywords": "Class ChangeTokenOptions Represents a change token that is usable in ChangeQueryOptions . Inheritance Object ChangeTokenOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ChangeTokenOptions : object, IChangeToken Constructors ChangeTokenOptions() Initializes a new instance of the ChangeTokenOptions class. Declaration public ChangeTokenOptions() ChangeTokenOptions(String) Initializes a new instance of the ChangeTokenOptions class. Declaration public ChangeTokenOptions(string stringValue) Parameters String stringValue The string value. Properties StringValue Gets or sets a string value that contains the serialized representation of the change token generated by the protocol server. Declaration public string StringValue { get; set; } Property Value String Implements IChangeToken.StringValue Methods ToString() Converts to string. Declaration public override string ToString() Returns String A that represents this instance. See Also IChangeToken" + "keywords": "Class ChangeTokenOptions Represents a change token that is usable in ChangeQueryOptions . Inheritance System.Object ChangeTokenOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ChangeTokenOptions : object, IChangeToken Constructors ChangeTokenOptions() Initializes a new instance of the ChangeTokenOptions class. Declaration public ChangeTokenOptions() ChangeTokenOptions(String) Initializes a new instance of the ChangeTokenOptions class. Declaration public ChangeTokenOptions(string stringValue) Parameters String stringValue The string value. Properties StringValue Gets or sets a string value that contains the serialized representation of the change token generated by the protocol server. Declaration public string StringValue { get; set; } Property Value String Implements IChangeToken.StringValue Methods ToString() Converts to string. Declaration public override string ToString() Returns String A that represents this instance. See Also IChangeToken" }, "api/PnP.Core.Model.SharePoint.ChangeType.html": { "href": "api/PnP.Core.Model.SharePoint.ChangeType.html", @@ -1347,7 +1347,7 @@ "api/PnP.Core.Model.SharePoint.CommonFieldOptions.html": { "href": "api/PnP.Core.Model.SharePoint.CommonFieldOptions.html", "title": "Class CommonFieldOptions | PnP Core SDK", - "keywords": "Class CommonFieldOptions Available options for adding most of SharePoint fields (Excepted Lookup fields) Inheritance Object CommonFieldOptions FieldBooleanOptions FieldCalculatedOptions FieldChoiceMultiOptions FieldCurrencyOptions FieldDateTimeOptions FieldLookupOptions FieldMultilineTextOptions FieldNumberOptions FieldTaxonomyOptions FieldTextOptions FieldUrlOptions FieldUserOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public abstract class CommonFieldOptions : object Properties AddToDefaultView Add this field to the default view Declaration public bool AddToDefaultView { get; set; } Property Value Boolean CustomFormatter Allows you to set custom formatting JSON ( https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/column-formatting#supported-column-types ) on the field Declaration public string CustomFormatter { get; set; } Property Value String DefaultFormula Sets the default formula of the field Declaration public string DefaultFormula { get; set; } Property Value String Description Sets the description of the field Declaration public string Description { get; set; } Property Value String EnforceUniqueValues Sets whether the field enforces unique values Declaration public bool? EnforceUniqueValues { get; set; } Property Value Nullable < Boolean > Group Sets the group of the field Declaration public string Group { get; set; } Property Value String Hidden Sets whether the field is hidden Declaration public bool? Hidden { get; set; } Property Value Nullable < Boolean > Id Guid of the field Declaration public Guid? Id { get; set; } Property Value Nullable < Guid > Indexed Sets whether the field is indexed Declaration public bool? Indexed { get; set; } Property Value Nullable < Boolean > InternalName Set a specific internal name for the field Declaration public string InternalName { get; set; } Property Value String Options An AddFieldOptionsFlags flag that specifies the field options to be applied during add Declaration public AddFieldOptionsFlags Options { get; set; } Property Value AddFieldOptionsFlags Required Sets whether the field is required Declaration public bool? Required { get; set; } Property Value Nullable < Boolean > ShowInEditForm Show this field on the list's edit form Declaration public bool? ShowInEditForm { get; set; } Property Value Nullable < Boolean > ShowInNewForm Show this field on the list's new form Declaration public bool? ShowInNewForm { get; set; } Property Value Nullable < Boolean > ShowInViewForms Show this field on the list's view forms Declaration public bool? ShowInViewForms { get; set; } Property Value Nullable < Boolean > ValidationFormula Sets the validation formula of the field Declaration public string ValidationFormula { get; set; } Property Value String ValidationMessage Sets the validation message of the field Declaration public string ValidationMessage { get; set; } Property Value String" + "keywords": "Class CommonFieldOptions Available options for adding most of SharePoint fields (Excepted Lookup fields) Inheritance System.Object CommonFieldOptions FieldBooleanOptions FieldCalculatedOptions FieldChoiceMultiOptions FieldCurrencyOptions FieldDateTimeOptions FieldLookupOptions FieldMultilineTextOptions FieldNumberOptions FieldTaxonomyOptions FieldTextOptions FieldUrlOptions FieldUserOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public abstract class CommonFieldOptions : object Properties AddToDefaultView Add this field to the default view Declaration public bool AddToDefaultView { get; set; } Property Value Boolean CustomFormatter Allows you to set custom formatting JSON ( https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/column-formatting#supported-column-types ) on the field Declaration public string CustomFormatter { get; set; } Property Value String DefaultFormula Sets the default formula of the field Declaration public string DefaultFormula { get; set; } Property Value String Description Sets the description of the field Declaration public string Description { get; set; } Property Value String EnforceUniqueValues Sets whether the field enforces unique values Declaration public bool? EnforceUniqueValues { get; set; } Property Value Nullable < Boolean > Group Sets the group of the field Declaration public string Group { get; set; } Property Value String Hidden Sets whether the field is hidden Declaration public bool? Hidden { get; set; } Property Value Nullable < Boolean > Id Guid of the field Declaration public Guid? Id { get; set; } Property Value Nullable < Guid > Indexed Sets whether the field is indexed Declaration public bool? Indexed { get; set; } Property Value Nullable < Boolean > InternalName Set a specific internal name for the field Declaration public string InternalName { get; set; } Property Value String Options An AddFieldOptionsFlags flag that specifies the field options to be applied during add Declaration public AddFieldOptionsFlags Options { get; set; } Property Value AddFieldOptionsFlags Required Sets whether the field is required Declaration public bool? Required { get; set; } Property Value Nullable < Boolean > ShowInEditForm Show this field on the list's edit form Declaration public bool? ShowInEditForm { get; set; } Property Value Nullable < Boolean > ShowInNewForm Show this field on the list's new form Declaration public bool? ShowInNewForm { get; set; } Property Value Nullable < Boolean > ShowInViewForms Show this field on the list's view forms Declaration public bool? ShowInViewForms { get; set; } Property Value Nullable < Boolean > ValidationFormula Sets the validation formula of the field Declaration public string ValidationFormula { get; set; } Property Value String ValidationMessage Sets the validation message of the field Declaration public string ValidationMessage { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.ConvertToFormat.html": { "href": "api/PnP.Core.Model.SharePoint.ConvertToFormat.html", @@ -1357,17 +1357,17 @@ "api/PnP.Core.Model.SharePoint.ConvertToOptions.html": { "href": "api/PnP.Core.Model.SharePoint.ConvertToOptions.html", "title": "Class ConvertToOptions | PnP Core SDK", - "keywords": "Class ConvertToOptions Defines the options for converting a file to another format Inheritance Object ConvertToOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ConvertToOptions : object Fields JpgFormatHeight When Jpg is used then you also need to specify the jpg height. Defaults to 300 Declaration public int JpgFormatHeight Field Value Int32 JpgFormatWidth When Jpg is used then you also need to specify the jpg width. Defaults to 300 Declaration public int JpgFormatWidth Field Value Int32 StreamContent Return a streaming response or return all bytes at once. Defaults to false Declaration public bool StreamContent Field Value Boolean Properties Format The desired target format for the converted file. Defaults to PDF Declaration public ConvertToFormat Format { get; set; } Property Value ConvertToFormat" + "keywords": "Class ConvertToOptions Defines the options for converting a file to another format Inheritance System.Object ConvertToOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ConvertToOptions : object Fields JpgFormatHeight When Jpg is used then you also need to specify the jpg height. Defaults to 300 Declaration public int JpgFormatHeight Field Value Int32 JpgFormatWidth When Jpg is used then you also need to specify the jpg width. Defaults to 300 Declaration public int JpgFormatWidth Field Value Int32 StreamContent Return a streaming response or return all bytes at once. Defaults to false Declaration public bool StreamContent Field Value Boolean Properties Format The desired target format for the converted file. Defaults to PDF Declaration public ConvertToFormat Format { get; set; } Property Value ConvertToFormat" }, "api/PnP.Core.Model.SharePoint.CopyMigrationOptions.html": { "href": "api/PnP.Core.Model.SharePoint.CopyMigrationOptions.html", "title": "Class CopyMigrationOptions | PnP Core SDK", - "keywords": "Class CopyMigrationOptions Optional options that can be passed to the migration job Inheritance Object CopyMigrationOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class CopyMigrationOptions : object Properties AllowSchemaMismatch This allows the item to move even if the target has a mismatched schema definition from the source list. Declaration public bool AllowSchemaMismatch { get; set; } Property Value Boolean AllowSmallerVersionLimitOnDestination This allows the move to take place if the target file has older version. By default it’s disallowed to prevent data loss. Declaration public bool AllowSmallerVersionLimitOnDestination { get; set; } Property Value Boolean BypassSharedLock This indicates whether a file with a share lock can still be moved in a move job. If you want to move a file that is locked, you need to set this. Declaration public bool BypassSharedLock { get; set; } Property Value Boolean ClientEtags If set, and the source eTag doesn’t match the eTag specified, the copy and move won’t take place. If left NULL, no check will take place. Declaration public string[] ClientEtags { get; set; } Property Value String [] ExcludeChildren For this operation, only the root level folder of the URL is copied. The sub-folders or files within the folder will not be moved or copied. Declaration public bool ExcludeChildren { get; set; } Property Value Boolean IgnoreVersionHistory If not specified, the version history will be ignored and not moved to the destination. Declaration public bool IgnoreVersionHistory { get; set; } Property Value Boolean IsMoveMode By default, this is set to copy. For a move operation, set this parameter to true. Declaration public bool IsMoveMode { get; set; } Property Value Boolean MoveButKeepSource Once set, this move operation is similar to copy. The file will move to destination, but the source content will not be deleted. If set, this will make a copy with the version history and preserve the original metadata. No source item deletions occurs at the end. This is not like the normal copy, which only copies the most recent major version and doesn't maintain all the metadata. Declaration public bool MoveButKeepSource { get; set; } Property Value Boolean NameConflictBehavior If a name conflict occurs at the target site, the default reports a failure. Declaration public SPMigrationNameConflictBehavior NameConflictBehavior { get; set; } Property Value SPMigrationNameConflictBehavior" + "keywords": "Class CopyMigrationOptions Optional options that can be passed to the migration job Inheritance System.Object CopyMigrationOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class CopyMigrationOptions : object Properties AllowSchemaMismatch This allows the item to move even if the target has a mismatched schema definition from the source list. Declaration public bool AllowSchemaMismatch { get; set; } Property Value Boolean AllowSmallerVersionLimitOnDestination This allows the move to take place if the target file has older version. By default it’s disallowed to prevent data loss. Declaration public bool AllowSmallerVersionLimitOnDestination { get; set; } Property Value Boolean BypassSharedLock This indicates whether a file with a share lock can still be moved in a move job. If you want to move a file that is locked, you need to set this. Declaration public bool BypassSharedLock { get; set; } Property Value Boolean ClientEtags If set, and the source eTag doesn’t match the eTag specified, the copy and move won’t take place. If left NULL, no check will take place. Declaration public string[] ClientEtags { get; set; } Property Value String [] ExcludeChildren For this operation, only the root level folder of the URL is copied. The sub-folders or files within the folder will not be moved or copied. Declaration public bool ExcludeChildren { get; set; } Property Value Boolean IgnoreVersionHistory If not specified, the version history will be ignored and not moved to the destination. Declaration public bool IgnoreVersionHistory { get; set; } Property Value Boolean IsMoveMode By default, this is set to copy. For a move operation, set this parameter to true. Declaration public bool IsMoveMode { get; set; } Property Value Boolean MoveButKeepSource Once set, this move operation is similar to copy. The file will move to destination, but the source content will not be deleted. If set, this will make a copy with the version history and preserve the original metadata. No source item deletions occurs at the end. This is not like the normal copy, which only copies the most recent major version and doesn't maintain all the metadata. Declaration public bool MoveButKeepSource { get; set; } Property Value Boolean NameConflictBehavior If a name conflict occurs at the target site, the default reports a failure. Declaration public SPMigrationNameConflictBehavior NameConflictBehavior { get; set; } Property Value SPMigrationNameConflictBehavior" }, "api/PnP.Core.Model.SharePoint.CustomImageSettings.html": { "href": "api/PnP.Core.Model.SharePoint.CustomImageSettings.html", "title": "Class CustomImageSettings | PnP Core SDK", - "keywords": "Class CustomImageSettings Card icon image settings Inheritance Object CustomImageSettings Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class CustomImageSettings : object Properties AltText Image alternative text Declaration public string AltText { get; set; } Property Value String ImageUrl Image url Declaration public string ImageUrl { get; set; } Property Value String Type Image type Declaration public int Type { get; set; } Property Value Int32" + "keywords": "Class CustomImageSettings Card icon image settings Inheritance System.Object CustomImageSettings Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class CustomImageSettings : object Properties AltText Image alternative text Declaration public string AltText { get; set; } Property Value String ImageUrl Image url Declaration public string ImageUrl { get; set; } Property Value String Type Image type Declaration public int Type { get; set; } Property Value Int32" }, "api/PnP.Core.Model.SharePoint.CustomizedPageStatus.html": { "href": "api/PnP.Core.Model.SharePoint.CustomizedPageStatus.html", @@ -1377,7 +1377,7 @@ "api/PnP.Core.Model.SharePoint.CustomThumbnailOptions.html": { "href": "api/PnP.Core.Model.SharePoint.CustomThumbnailOptions.html", "title": "Class CustomThumbnailOptions | PnP Core SDK", - "keywords": "Class CustomThumbnailOptions Options to define a custom thumbnail to retrieve Inheritance Object CustomThumbnailOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class CustomThumbnailOptions : object Properties Cropped Generate a thumbnail that fits inside a Width x Height pixel box, maintaining aspect ratio, followed by resizing the image to fill the Width x Height box and cropping whatever spills outside the box. Declaration public bool Cropped { get; set; } Property Value Boolean Height Generate a thumbnail that fits inside a Width x Height pixel box, maintaining aspect ratio Declaration public int Height { get; set; } Property Value Int32 Width Generate a thumbnail that fits inside a Width x Height pixel box, maintaining aspect ratio Declaration public int Width { get; set; } Property Value Int32" + "keywords": "Class CustomThumbnailOptions Options to define a custom thumbnail to retrieve Inheritance System.Object CustomThumbnailOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class CustomThumbnailOptions : object Properties Cropped Generate a thumbnail that fits inside a Width x Height pixel box, maintaining aspect ratio, followed by resizing the image to fill the Width x Height box and cropping whatever spills outside the box. Declaration public bool Cropped { get; set; } Property Value Boolean Height Generate a thumbnail that fits inside a Width x Height pixel box, maintaining aspect ratio Declaration public int Height { get; set; } Property Value Int32 Width Generate a thumbnail that fits inside a Width x Height pixel box, maintaining aspect ratio Declaration public int Width { get; set; } Property Value Int32" }, "api/PnP.Core.Model.SharePoint.DateTimeFieldFormatType.html": { "href": "api/PnP.Core.Model.SharePoint.DateTimeFieldFormatType.html", @@ -1397,7 +1397,7 @@ "api/PnP.Core.Model.SharePoint.DefaultColumnValueOptions.html": { "href": "api/PnP.Core.Model.SharePoint.DefaultColumnValueOptions.html", "title": "Class DefaultColumnValueOptions | PnP Core SDK", - "keywords": "Class DefaultColumnValueOptions Holds default column value properties Inheritance Object DefaultColumnValueOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class DefaultColumnValueOptions : object Properties DefaultValue Default value for this field at the specified location Declaration public string DefaultValue { get; set; } Property Value String FieldInternalName Field internal name Declaration public string FieldInternalName { get; set; } Property Value String FolderRelativePath Folder relative path Declaration public string FolderRelativePath { get; set; } Property Value String" + "keywords": "Class DefaultColumnValueOptions Holds default column value properties Inheritance System.Object DefaultColumnValueOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class DefaultColumnValueOptions : object Properties DefaultValue Default value for this field at the specified location Declaration public string DefaultValue { get; set; } Property Value String FieldInternalName Field internal name Declaration public string FieldInternalName { get; set; } Property Value String FolderRelativePath Folder relative path Declaration public string FolderRelativePath { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.DefaultWebPart.html": { "href": "api/PnP.Core.Model.SharePoint.DefaultWebPart.html", @@ -1407,12 +1407,12 @@ "api/PnP.Core.Model.SharePoint.DocumentSetContentOptions.html": { "href": "api/PnP.Core.Model.SharePoint.DocumentSetContentOptions.html", "title": "Class DocumentSetContentOptions | PnP Core SDK", - "keywords": "Class DocumentSetContentOptions Options for default document set content Inheritance Object DocumentSetContentOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class DocumentSetContentOptions : object Properties ContentTypeId Content type of the file to add as default content Declaration public string ContentTypeId { get; set; } Property Value String File File to add as default content Declaration public IFile File { get; set; } Property Value IFile FileName File name of the file to be added as default content Declaration public string FileName { get; set; } Property Value String FolderName Folder name of the default content Declaration public string FolderName { get; set; } Property Value String" + "keywords": "Class DocumentSetContentOptions Options for default document set content Inheritance System.Object DocumentSetContentOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class DocumentSetContentOptions : object Properties ContentTypeId Content type of the file to add as default content Declaration public string ContentTypeId { get; set; } Property Value String File File to add as default content Declaration public IFile File { get; set; } Property Value IFile FileName File name of the file to be added as default content Declaration public string FileName { get; set; } Property Value String FolderName Folder name of the default content Declaration public string FolderName { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.DocumentSetOptions.html": { "href": "api/PnP.Core.Model.SharePoint.DocumentSetOptions.html", "title": "Class DocumentSetOptions | PnP Core SDK", - "keywords": "Class DocumentSetOptions Available options for a Document Set Inheritance Object DocumentSetOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class DocumentSetOptions : object Properties AllowedContentTypes List of the allowed content types in the document set Declaration public List AllowedContentTypes { get; set; } Property Value PnP.Core.Model.SharePoint.List < IContentType > DefaultContents Default contents of document set. Declaration public List DefaultContents { get; set; } Property Value PnP.Core.Model.SharePoint.List < DocumentSetContentOptions > KeepExistingContentTypes Defines if we keep the existing content types that are already allowed in the document set Declaration public bool KeepExistingContentTypes { get; set; } Property Value Boolean KeepExistingDefaultContent Defines if we keep the existing default contents or delete those (by not adding them to our body) Declaration public bool KeepExistingDefaultContent { get; set; } Property Value Boolean KeepExistingSharedColumns Defines if we keep the existing shared columns or delete those (by not adding them to our body) Declaration public bool KeepExistingSharedColumns { get; set; } Property Value Boolean KeepExistingWelcomePageColumns Defines if we keep the existing welcome page columns or delete those (by not adding them to our body) Declaration public bool KeepExistingWelcomePageColumns { get; set; } Property Value Boolean PropagateWelcomePageChanges Specifies whether to push welcome page changes to inherited content types. Declaration public bool? PropagateWelcomePageChanges { get; set; } Property Value Nullable < Boolean > SharedColumns Columns edited on the document set that synchronize to all documents in the set. These are read-only on the documents themselves. Declaration public List SharedColumns { get; set; } Property Value PnP.Core.Model.SharePoint.List < IField > ShouldPrefixNameToFile Indicates whether to add the name of the document set to each file name. Declaration public bool? ShouldPrefixNameToFile { get; set; } Property Value Nullable < Boolean > WelcomePageColumns Specifies columns to show on the welcome page for the document set. Declaration public List WelcomePageColumns { get; set; } Property Value PnP.Core.Model.SharePoint.List < IField > WelcomePageUrl Welcome page absolute URL. Declaration public string WelcomePageUrl { get; set; } Property Value String" + "keywords": "Class DocumentSetOptions Available options for a Document Set Inheritance System.Object DocumentSetOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class DocumentSetOptions : object Properties AllowedContentTypes List of the allowed content types in the document set Declaration public List AllowedContentTypes { get; set; } Property Value PnP.Core.Model.SharePoint.List < IContentType > DefaultContents Default contents of document set. Declaration public List DefaultContents { get; set; } Property Value PnP.Core.Model.SharePoint.List < DocumentSetContentOptions > KeepExistingContentTypes Defines if we keep the existing content types that are already allowed in the document set Declaration public bool KeepExistingContentTypes { get; set; } Property Value Boolean KeepExistingDefaultContent Defines if we keep the existing default contents or delete those (by not adding them to our body) Declaration public bool KeepExistingDefaultContent { get; set; } Property Value Boolean KeepExistingSharedColumns Defines if we keep the existing shared columns or delete those (by not adding them to our body) Declaration public bool KeepExistingSharedColumns { get; set; } Property Value Boolean KeepExistingWelcomePageColumns Defines if we keep the existing welcome page columns or delete those (by not adding them to our body) Declaration public bool KeepExistingWelcomePageColumns { get; set; } Property Value Boolean PropagateWelcomePageChanges Specifies whether to push welcome page changes to inherited content types. Declaration public bool? PropagateWelcomePageChanges { get; set; } Property Value Nullable < Boolean > SharedColumns Columns edited on the document set that synchronize to all documents in the set. These are read-only on the documents themselves. Declaration public List SharedColumns { get; set; } Property Value PnP.Core.Model.SharePoint.List < IField > ShouldPrefixNameToFile Indicates whether to add the name of the document set to each file name. Declaration public bool? ShouldPrefixNameToFile { get; set; } Property Value Nullable < Boolean > WelcomePageColumns Specifies columns to show on the welcome page for the document set. Declaration public List WelcomePageColumns { get; set; } Property Value PnP.Core.Model.SharePoint.List < IField > WelcomePageUrl Welcome page absolute URL. Declaration public string WelcomePageUrl { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.DraftVisibilityType.html": { "href": "api/PnP.Core.Model.SharePoint.DraftVisibilityType.html", @@ -1427,7 +1427,7 @@ "api/PnP.Core.Model.SharePoint.EventReceiverOptions.html": { "href": "api/PnP.Core.Model.SharePoint.EventReceiverOptions.html", "title": "Class EventReceiverOptions | PnP Core SDK", - "keywords": "Class EventReceiverOptions Options that will have to be filled in when creating a new Event Receiver Inheritance Object EventReceiverOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class EventReceiverOptions : object Properties EventType Type of event receiver to create. Declaration public EventReceiverType EventType { get; set; } Property Value EventReceiverType ReceiverAssembly Assembly holding the event receiver code Declaration public string ReceiverAssembly { get; set; } Property Value String ReceiverClass Class containing the event receiver code Declaration public string ReceiverClass { get; set; } Property Value String ReceiverName Name of the event receiver. Declaration public string ReceiverName { get; set; } Property Value String ReceiverUrl Url of the event receiver. Declaration public string ReceiverUrl { get; set; } Property Value String SequenceNumber Sequence number in which the event receiver will be executed. Declaration public int SequenceNumber { get; set; } Property Value Int32 Synchronization The synchronization state for the event receiver. Declaration public EventReceiverSynchronization Synchronization { get; set; } Property Value EventReceiverSynchronization" + "keywords": "Class EventReceiverOptions Options that will have to be filled in when creating a new Event Receiver Inheritance System.Object EventReceiverOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class EventReceiverOptions : object Properties EventType Type of event receiver to create. Declaration public EventReceiverType EventType { get; set; } Property Value EventReceiverType ReceiverAssembly Assembly holding the event receiver code Declaration public string ReceiverAssembly { get; set; } Property Value String ReceiverClass Class containing the event receiver code Declaration public string ReceiverClass { get; set; } Property Value String ReceiverName Name of the event receiver. Declaration public string ReceiverName { get; set; } Property Value String ReceiverUrl Url of the event receiver. Declaration public string ReceiverUrl { get; set; } Property Value String SequenceNumber Sequence number in which the event receiver will be executed. Declaration public int SequenceNumber { get; set; } Property Value Int32 Synchronization The synchronization state for the event receiver. Declaration public EventReceiverSynchronization Synchronization { get; set; } Property Value EventReceiverSynchronization" }, "api/PnP.Core.Model.SharePoint.EventReceiverSynchronization.html": { "href": "api/PnP.Core.Model.SharePoint.EventReceiverSynchronization.html", @@ -1442,42 +1442,42 @@ "api/PnP.Core.Model.SharePoint.ExternalLinkAction.html": { "href": "api/PnP.Core.Model.SharePoint.ExternalLinkAction.html", "title": "Class ExternalLinkAction | PnP Core SDK", - "keywords": "Class ExternalLinkAction External link ACE action Inheritance Object AdaptiveCardAction AdaptiveCardAction < ExternalLinkActionParameter > ExternalLinkAction Inherited Members AdaptiveCardAction.Parameters AdaptiveCardAction.Type Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ExternalLinkAction : AdaptiveCardAction Constructors ExternalLinkAction() Default constructor Declaration public ExternalLinkAction()" + "keywords": "Class ExternalLinkAction External link ACE action Inheritance System.Object AdaptiveCardAction AdaptiveCardAction < ExternalLinkActionParameter > ExternalLinkAction Inherited Members AdaptiveCardAction.Parameters AdaptiveCardAction.Type Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ExternalLinkAction : AdaptiveCardAction Constructors ExternalLinkAction() Default constructor Declaration public ExternalLinkAction()" }, "api/PnP.Core.Model.SharePoint.ExternalLinkActionParameter.html": { "href": "api/PnP.Core.Model.SharePoint.ExternalLinkActionParameter.html", "title": "Class ExternalLinkActionParameter | PnP Core SDK", - "keywords": "Class ExternalLinkActionParameter External link parameter Inheritance Object ExternalLinkActionParameter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ExternalLinkActionParameter : object Properties Target External link target Declaration public string Target { get; set; } Property Value String" + "keywords": "Class ExternalLinkActionParameter External link parameter Inheritance System.Object ExternalLinkActionParameter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ExternalLinkActionParameter : object Properties Target External link target Declaration public string Target { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.FieldBooleanOptions.html": { "href": "api/PnP.Core.Model.SharePoint.FieldBooleanOptions.html", "title": "Class FieldBooleanOptions | PnP Core SDK", - "keywords": "Class FieldBooleanOptions Options for a boolean field Inheritance Object CommonFieldOptions FieldBooleanOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldBooleanOptions : CommonFieldOptions" + "keywords": "Class FieldBooleanOptions Options for a boolean field Inheritance System.Object CommonFieldOptions FieldBooleanOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldBooleanOptions : CommonFieldOptions" }, "api/PnP.Core.Model.SharePoint.FieldCalculatedOptions.html": { "href": "api/PnP.Core.Model.SharePoint.FieldCalculatedOptions.html", "title": "Class FieldCalculatedOptions | PnP Core SDK", - "keywords": "Class FieldCalculatedOptions Available options for SharePoint Calculated fields Inheritance Object CommonFieldOptions FieldCalculatedOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldCalculatedOptions : CommonFieldOptions Properties CurrencyLocaleId Gets or sets a value that specifies the language code identifier (LCID) used to format the value of the field. Declaration public int? CurrencyLocaleId { get; set; } Property Value Nullable < Int32 > DateFormat Gets or sets the type of date and time format that is used in the field. Declaration public DateTimeFieldFormatType? DateFormat { get; set; } Property Value Nullable < DateTimeFieldFormatType > Formula Gets or sets a value that specifies the formula for the field. Declaration public string Formula { get; set; } Property Value String OutputType Gets or sets a value that specifies the output format for the field. Declaration public FieldType OutputType { get; set; } Property Value FieldType ShowAsPercentage Gets or sets whether the field must be shown as percentage. Declaration public bool? ShowAsPercentage { get; set; } Property Value Nullable < Boolean >" + "keywords": "Class FieldCalculatedOptions Available options for SharePoint Calculated fields Inheritance System.Object CommonFieldOptions FieldCalculatedOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldCalculatedOptions : CommonFieldOptions Properties CurrencyLocaleId Gets or sets a value that specifies the language code identifier (LCID) used to format the value of the field. Declaration public int? CurrencyLocaleId { get; set; } Property Value Nullable < Int32 > DateFormat Gets or sets the type of date and time format that is used in the field. Declaration public DateTimeFieldFormatType? DateFormat { get; set; } Property Value Nullable < DateTimeFieldFormatType > Formula Gets or sets a value that specifies the formula for the field. Declaration public string Formula { get; set; } Property Value String OutputType Gets or sets a value that specifies the output format for the field. Declaration public FieldType OutputType { get; set; } Property Value FieldType ShowAsPercentage Gets or sets whether the field must be shown as percentage. Declaration public bool? ShowAsPercentage { get; set; } Property Value Nullable < Boolean >" }, "api/PnP.Core.Model.SharePoint.FieldChoiceMultiOptions.html": { "href": "api/PnP.Core.Model.SharePoint.FieldChoiceMultiOptions.html", "title": "Class FieldChoiceMultiOptions | PnP Core SDK", - "keywords": "Class FieldChoiceMultiOptions Available options for SharePoint Multi Choice fields Inheritance Object CommonFieldOptions FieldChoiceMultiOptions FieldChoiceOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldChoiceMultiOptions : CommonFieldOptions Properties Choices Gets or sets a value that specifies values that are available for selection in the field. Declaration public string[] Choices { get; set; } Property Value String [] DefaultChoice Gets or sets the default choice value Declaration public string DefaultChoice { get; set; } Property Value String FillInChoice Gets or sets a value that specifies whether the field can accept values other than those specified in Choices. Declaration public bool? FillInChoice { get; set; } Property Value Nullable < Boolean >" + "keywords": "Class FieldChoiceMultiOptions Available options for SharePoint Multi Choice fields Inheritance System.Object CommonFieldOptions FieldChoiceMultiOptions FieldChoiceOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldChoiceMultiOptions : CommonFieldOptions Properties Choices Gets or sets a value that specifies values that are available for selection in the field. Declaration public string[] Choices { get; set; } Property Value String [] DefaultChoice Gets or sets the default choice value Declaration public string DefaultChoice { get; set; } Property Value String FillInChoice Gets or sets a value that specifies whether the field can accept values other than those specified in Choices. Declaration public bool? FillInChoice { get; set; } Property Value Nullable < Boolean >" }, "api/PnP.Core.Model.SharePoint.FieldChoiceOptions.html": { "href": "api/PnP.Core.Model.SharePoint.FieldChoiceOptions.html", "title": "Class FieldChoiceOptions | PnP Core SDK", - "keywords": "Class FieldChoiceOptions Available options for SharePoint Choice fields Inheritance Object CommonFieldOptions FieldChoiceMultiOptions FieldChoiceOptions Inherited Members FieldChoiceMultiOptions.FillInChoice FieldChoiceMultiOptions.DefaultChoice FieldChoiceMultiOptions.Choices CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldChoiceOptions : FieldChoiceMultiOptions Properties EditFormat Determines whether to display the choice field as option buttons (also known as “radio buttons”) or as a drop-down list. Declaration public ChoiceFormatType EditFormat { get; set; } Property Value ChoiceFormatType" + "keywords": "Class FieldChoiceOptions Available options for SharePoint Choice fields Inheritance System.Object CommonFieldOptions FieldChoiceMultiOptions FieldChoiceOptions Inherited Members FieldChoiceMultiOptions.FillInChoice FieldChoiceMultiOptions.DefaultChoice FieldChoiceMultiOptions.Choices CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldChoiceOptions : FieldChoiceMultiOptions Properties EditFormat Determines whether to display the choice field as option buttons (also known as “radio buttons”) or as a drop-down list. Declaration public ChoiceFormatType EditFormat { get; set; } Property Value ChoiceFormatType" }, "api/PnP.Core.Model.SharePoint.FieldCurrencyOptions.html": { "href": "api/PnP.Core.Model.SharePoint.FieldCurrencyOptions.html", "title": "Class FieldCurrencyOptions | PnP Core SDK", - "keywords": "Class FieldCurrencyOptions Available options for SharePoint Currency fields Inheritance Object CommonFieldOptions FieldCurrencyOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldCurrencyOptions : CommonFieldOptions Properties CurrencyLocaleId Gets or sets a value that specifies the language code identifier (LCID) used to format the value of the field. Declaration public int? CurrencyLocaleId { get; set; } Property Value Nullable < Int32 > Decimals How many decimals to show Declaration public int? Decimals { get; set; } Property Value Nullable < Int32 >" + "keywords": "Class FieldCurrencyOptions Available options for SharePoint Currency fields Inheritance System.Object CommonFieldOptions FieldCurrencyOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldCurrencyOptions : CommonFieldOptions Properties CurrencyLocaleId Gets or sets a value that specifies the language code identifier (LCID) used to format the value of the field. Declaration public int? CurrencyLocaleId { get; set; } Property Value Nullable < Int32 > Decimals How many decimals to show Declaration public int? Decimals { get; set; } Property Value Nullable < Int32 >" }, "api/PnP.Core.Model.SharePoint.FieldDateTimeOptions.html": { "href": "api/PnP.Core.Model.SharePoint.FieldDateTimeOptions.html", "title": "Class FieldDateTimeOptions | PnP Core SDK", - "keywords": "Class FieldDateTimeOptions Available options for SharePoint DateTime fields Inheritance Object CommonFieldOptions FieldDateTimeOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldDateTimeOptions : CommonFieldOptions Properties DateTimeCalendarType Gets or sets a value that specifies the calendar type of the field. Declaration public CalendarType DateTimeCalendarType { get; set; } Property Value CalendarType DisplayFormat Gets or sets the type of date and time format that is used in the field. Declaration public DateTimeFieldFormatType DisplayFormat { get; set; } Property Value DateTimeFieldFormatType FriendlyDisplayFormat Gets or sets the type of friendly display format that is used in the field. Declaration public DateTimeFieldFriendlyFormatType FriendlyDisplayFormat { get; set; } Property Value DateTimeFieldFriendlyFormatType" + "keywords": "Class FieldDateTimeOptions Available options for SharePoint DateTime fields Inheritance System.Object CommonFieldOptions FieldDateTimeOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldDateTimeOptions : CommonFieldOptions Properties DateTimeCalendarType Gets or sets a value that specifies the calendar type of the field. Declaration public CalendarType DateTimeCalendarType { get; set; } Property Value CalendarType DisplayFormat Gets or sets the type of date and time format that is used in the field. Declaration public DateTimeFieldFormatType DisplayFormat { get; set; } Property Value DateTimeFieldFormatType FriendlyDisplayFormat Gets or sets the type of friendly display format that is used in the field. Declaration public DateTimeFieldFriendlyFormatType FriendlyDisplayFormat { get; set; } Property Value DateTimeFieldFriendlyFormatType" }, "api/PnP.Core.Model.SharePoint.FieldIndexStatus.html": { "href": "api/PnP.Core.Model.SharePoint.FieldIndexStatus.html", @@ -1487,42 +1487,42 @@ "api/PnP.Core.Model.SharePoint.FieldLocationValue.html": { "href": "api/PnP.Core.Model.SharePoint.FieldLocationValue.html", "title": "Class FieldLocationValue | PnP Core SDK", - "keywords": "Class FieldLocationValue Represents a location field value Inheritance Object FieldValue FieldLocationValue Inherited Members FieldValue.Field Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public sealed class FieldLocationValue : FieldValue, IFieldLocationValue, IFieldValue Constructors FieldLocationValue() Default constructor Declaration public FieldLocationValue() Properties City City Declaration public string City { get; } Property Value String Implements IFieldLocationValue.City CountryOrRegion Country of region Declaration public string CountryOrRegion { get; } Property Value String Implements IFieldLocationValue.CountryOrRegion DisplayName Name identifiying this location Declaration public string DisplayName { get; } Property Value String Implements IFieldLocationValue.DisplayName Latitude Latitude of the location Declaration public double Latitude { get; } Property Value Double Implements IFieldLocationValue.Latitude LocationUri Uri identifying this location Declaration public string LocationUri { get; } Property Value String Implements IFieldLocationValue.LocationUri Longitude Longitude of the location Declaration public double Longitude { get; } Property Value Double Implements IFieldLocationValue.Longitude PostalCode Postal/zip code Declaration public string PostalCode { get; } Property Value String Implements IFieldLocationValue.PostalCode State State Declaration public string State { get; } Property Value String Implements IFieldLocationValue.State Street Streetname Declaration public string Street { get; } Property Value String Implements IFieldLocationValue.Street" + "keywords": "Class FieldLocationValue Represents a location field value Inheritance System.Object FieldValue FieldLocationValue Inherited Members FieldValue.Field Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public sealed class FieldLocationValue : FieldValue, IFieldLocationValue, IFieldValue Constructors FieldLocationValue() Default constructor Declaration public FieldLocationValue() Properties City City Declaration public string City { get; } Property Value String Implements IFieldLocationValue.City CountryOrRegion Country of region Declaration public string CountryOrRegion { get; } Property Value String Implements IFieldLocationValue.CountryOrRegion DisplayName Name identifiying this location Declaration public string DisplayName { get; } Property Value String Implements IFieldLocationValue.DisplayName Latitude Latitude of the location Declaration public double Latitude { get; } Property Value Double Implements IFieldLocationValue.Latitude LocationUri Uri identifying this location Declaration public string LocationUri { get; } Property Value String Implements IFieldLocationValue.LocationUri Longitude Longitude of the location Declaration public double Longitude { get; } Property Value Double Implements IFieldLocationValue.Longitude PostalCode Postal/zip code Declaration public string PostalCode { get; } Property Value String Implements IFieldLocationValue.PostalCode State State Declaration public string State { get; } Property Value String Implements IFieldLocationValue.State Street Streetname Declaration public string Street { get; } Property Value String Implements IFieldLocationValue.Street" }, "api/PnP.Core.Model.SharePoint.FieldLookupOptions.html": { "href": "api/PnP.Core.Model.SharePoint.FieldLookupOptions.html", "title": "Class FieldLookupOptions | PnP Core SDK", - "keywords": "Class FieldLookupOptions Available options for SharePoint lookup fields Inheritance Object CommonFieldOptions FieldLookupOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldLookupOptions : CommonFieldOptions Properties LookupFieldName Gets or sets a value that specifies the internal field name of the field used as the lookup values. Declaration public string LookupFieldName { get; set; } Property Value String LookupListId Gets or sets a value that specifies the list identifier of the list that contains the field to use as the lookup values. Declaration public Guid LookupListId { get; set; } Property Value Guid LookupWebId Gets or sets a value that specifies the GUID that identifies the site containing the list which contains the field used as the lookup values. Declaration public Guid LookupWebId { get; set; } Property Value Guid" + "keywords": "Class FieldLookupOptions Available options for SharePoint lookup fields Inheritance System.Object CommonFieldOptions FieldLookupOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldLookupOptions : CommonFieldOptions Properties LookupFieldName Gets or sets a value that specifies the internal field name of the field used as the lookup values. Declaration public string LookupFieldName { get; set; } Property Value String LookupListId Gets or sets a value that specifies the list identifier of the list that contains the field to use as the lookup values. Declaration public Guid LookupListId { get; set; } Property Value Guid LookupWebId Gets or sets a value that specifies the GUID that identifies the site containing the list which contains the field used as the lookup values. Declaration public Guid LookupWebId { get; set; } Property Value Guid" }, "api/PnP.Core.Model.SharePoint.FieldLookupValue.html": { "href": "api/PnP.Core.Model.SharePoint.FieldLookupValue.html", "title": "Class FieldLookupValue | PnP Core SDK", - "keywords": "Class FieldLookupValue Represents a lookup field value Inheritance Object FieldValue FieldLookupValue FieldUserValue Inherited Members FieldValue.Field Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldLookupValue : FieldValue, IFieldLookupValue, IFieldValue Constructors FieldLookupValue(Int32) Default constructor Declaration public FieldLookupValue(int lookupId) Parameters Int32 lookupId Id of the looked-up item Properties IsSecretFieldValue Is the value a secret value? Declaration public bool IsSecretFieldValue { get; } Property Value Boolean Implements IFieldLookupValue.IsSecretFieldValue LookupId Id of the looked-up item Declaration public int LookupId { get; set; } Property Value Int32 Implements IFieldLookupValue.LookupId LookupValue Value of the key property of the looked-up item Declaration public string LookupValue { get; } Property Value String Implements IFieldLookupValue.LookupValue" + "keywords": "Class FieldLookupValue Represents a lookup field value Inheritance System.Object FieldValue FieldLookupValue FieldUserValue Inherited Members FieldValue.Field Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldLookupValue : FieldValue, IFieldLookupValue, IFieldValue Constructors FieldLookupValue(Int32) Default constructor Declaration public FieldLookupValue(int lookupId) Parameters Int32 lookupId Id of the looked-up item Properties IsSecretFieldValue Is the value a secret value? Declaration public bool IsSecretFieldValue { get; } Property Value Boolean Implements IFieldLookupValue.IsSecretFieldValue LookupId Id of the looked-up item Declaration public int LookupId { get; set; } Property Value Int32 Implements IFieldLookupValue.LookupId LookupValue Value of the key property of the looked-up item Declaration public string LookupValue { get; } Property Value String Implements IFieldLookupValue.LookupValue" }, "api/PnP.Core.Model.SharePoint.FieldMultilineTextOptions.html": { "href": "api/PnP.Core.Model.SharePoint.FieldMultilineTextOptions.html", "title": "Class FieldMultilineTextOptions | PnP Core SDK", - "keywords": "Class FieldMultilineTextOptions Available options for SharePoint Multiline Text fields Inheritance Object CommonFieldOptions FieldMultilineTextOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldMultilineTextOptions : CommonFieldOptions Properties AllowHyperlink Gets or sets a value that specifies whether a hyperlink is allowed as a value of the field. Declaration public bool? AllowHyperlink { get; set; } Property Value Nullable < Boolean > AppendOnly Gets or sets a value that specifies whether all changes to the value of the field are displayed in list forms. Declaration public bool? AppendOnly { get; set; } Property Value Nullable < Boolean > NumberOfLines Gets or sets a value that specifies the number of lines of text to display for the field. Declaration public int? NumberOfLines { get; set; } Property Value Nullable < Int32 > RestrictedMode Gets or sets a value that specifies whether the field supports a subset of rich formatting. Declaration public bool? RestrictedMode { get; set; } Property Value Nullable < Boolean > RichText Gets or sets a value that specifies whether the field supports rich formatting. Declaration public bool? RichText { get; set; } Property Value Nullable < Boolean > UnlimitedLengthInDocumentLibrary Gets or sets a value that specifies whether the field supports unlimited length in document libraries. Declaration public bool? UnlimitedLengthInDocumentLibrary { get; set; } Property Value Nullable < Boolean >" + "keywords": "Class FieldMultilineTextOptions Available options for SharePoint Multiline Text fields Inheritance System.Object CommonFieldOptions FieldMultilineTextOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldMultilineTextOptions : CommonFieldOptions Properties AllowHyperlink Gets or sets a value that specifies whether a hyperlink is allowed as a value of the field. Declaration public bool? AllowHyperlink { get; set; } Property Value Nullable < Boolean > AppendOnly Gets or sets a value that specifies whether all changes to the value of the field are displayed in list forms. Declaration public bool? AppendOnly { get; set; } Property Value Nullable < Boolean > NumberOfLines Gets or sets a value that specifies the number of lines of text to display for the field. Declaration public int? NumberOfLines { get; set; } Property Value Nullable < Int32 > RestrictedMode Gets or sets a value that specifies whether the field supports a subset of rich formatting. Declaration public bool? RestrictedMode { get; set; } Property Value Nullable < Boolean > RichText Gets or sets a value that specifies whether the field supports rich formatting. Declaration public bool? RichText { get; set; } Property Value Nullable < Boolean > UnlimitedLengthInDocumentLibrary Gets or sets a value that specifies whether the field supports unlimited length in document libraries. Declaration public bool? UnlimitedLengthInDocumentLibrary { get; set; } Property Value Nullable < Boolean >" }, "api/PnP.Core.Model.SharePoint.FieldNumberOptions.html": { "href": "api/PnP.Core.Model.SharePoint.FieldNumberOptions.html", "title": "Class FieldNumberOptions | PnP Core SDK", - "keywords": "Class FieldNumberOptions Available options for SharePoint Number fields Inheritance Object CommonFieldOptions FieldNumberOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldNumberOptions : CommonFieldOptions Properties Decimals How many decimals to show Declaration public int? Decimals { get; set; } Property Value Nullable < Int32 > DefaultValue Default value set on the field Declaration public double? DefaultValue { get; set; } Property Value Nullable < Double > MaximumValue Gets or sets a value that specifies the maximum allowed value for the field. Declaration public double? MaximumValue { get; set; } Property Value Nullable < Double > MinimumValue Gets or sets a value that specifies the minimum allowed value for the field. Declaration public double? MinimumValue { get; set; } Property Value Nullable < Double > ShowAsPercentage Gets or sets whether the field must be shown as percentage. Declaration public bool? ShowAsPercentage { get; set; } Property Value Nullable < Boolean >" + "keywords": "Class FieldNumberOptions Available options for SharePoint Number fields Inheritance System.Object CommonFieldOptions FieldNumberOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldNumberOptions : CommonFieldOptions Properties Decimals How many decimals to show Declaration public int? Decimals { get; set; } Property Value Nullable < Int32 > DefaultValue Default value set on the field Declaration public double? DefaultValue { get; set; } Property Value Nullable < Double > MaximumValue Gets or sets a value that specifies the maximum allowed value for the field. Declaration public double? MaximumValue { get; set; } Property Value Nullable < Double > MinimumValue Gets or sets a value that specifies the minimum allowed value for the field. Declaration public double? MinimumValue { get; set; } Property Value Nullable < Double > ShowAsPercentage Gets or sets whether the field must be shown as percentage. Declaration public bool? ShowAsPercentage { get; set; } Property Value Nullable < Boolean >" }, "api/PnP.Core.Model.SharePoint.FieldTaxonomyOptions.html": { "href": "api/PnP.Core.Model.SharePoint.FieldTaxonomyOptions.html", "title": "Class FieldTaxonomyOptions | PnP Core SDK", - "keywords": "Class FieldTaxonomyOptions Options for configuring a Taxonomy field Inheritance Object CommonFieldOptions FieldTaxonomyOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldTaxonomyOptions : CommonFieldOptions Properties DefaultValue Default value set on single value taxonomy field Declaration public ITerm DefaultValue { get; set; } Property Value ITerm DefaultValues Default values set on a a multi value taxonomy field Declaration public Collections.Generic.List DefaultValues { get; set; } Property Value Collections.Generic.List < ITerm > OpenTermSet Defines whether the provisioned field allows for additions to the connected term set Declaration public bool OpenTermSet { get; set; } Property Value Boolean TermSetId TermSet id Declaration public Guid TermSetId { get; set; } Property Value Guid TermStoreId Term store id Declaration public Guid TermStoreId { get; set; } Property Value Guid" + "keywords": "Class FieldTaxonomyOptions Options for configuring a Taxonomy field Inheritance System.Object CommonFieldOptions FieldTaxonomyOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldTaxonomyOptions : CommonFieldOptions Properties DefaultValue Default value set on single value taxonomy field Declaration public ITerm DefaultValue { get; set; } Property Value ITerm DefaultValues Default values set on a a multi value taxonomy field Declaration public Collections.Generic.List DefaultValues { get; set; } Property Value Collections.Generic.List < ITerm > OpenTermSet Defines whether the provisioned field allows for additions to the connected term set Declaration public bool OpenTermSet { get; set; } Property Value Boolean TermSetId TermSet id Declaration public Guid TermSetId { get; set; } Property Value Guid TermStoreId Term store id Declaration public Guid TermStoreId { get; set; } Property Value Guid" }, "api/PnP.Core.Model.SharePoint.FieldTaxonomyValue.html": { "href": "api/PnP.Core.Model.SharePoint.FieldTaxonomyValue.html", "title": "Class FieldTaxonomyValue | PnP Core SDK", - "keywords": "Class FieldTaxonomyValue Represents a taxonomy field value Inheritance Object FieldValue FieldTaxonomyValue Inherited Members FieldValue.Field Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public sealed class FieldTaxonomyValue : FieldValue, IFieldTaxonomyValue, IFieldValue Constructors FieldTaxonomyValue(Guid, String) Default constructor Declaration public FieldTaxonomyValue(Guid termId, string label) Parameters Guid termId Taxonomy term id String label Taxonomy label FieldTaxonomyValue(Guid, String, Int32) Default constructor Declaration public FieldTaxonomyValue(Guid termId, string label, int wssId) Parameters Guid termId Taxonomy term id String label Taxonomy label Int32 wssId Optionally provide the wssId value Properties Label Taxonomy label Declaration public string Label { get; set; } Property Value String Implements IFieldTaxonomyValue.Label TermId Taxonomy term id Declaration public Guid TermId { get; set; } Property Value Guid Implements IFieldTaxonomyValue.TermId" + "keywords": "Class FieldTaxonomyValue Represents a taxonomy field value Inheritance System.Object FieldValue FieldTaxonomyValue Inherited Members FieldValue.Field Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public sealed class FieldTaxonomyValue : FieldValue, IFieldTaxonomyValue, IFieldValue Constructors FieldTaxonomyValue(Guid, String) Default constructor Declaration public FieldTaxonomyValue(Guid termId, string label) Parameters Guid termId Taxonomy term id String label Taxonomy label FieldTaxonomyValue(Guid, String, Int32) Default constructor Declaration public FieldTaxonomyValue(Guid termId, string label, int wssId) Parameters Guid termId Taxonomy term id String label Taxonomy label Int32 wssId Optionally provide the wssId value Properties Label Taxonomy label Declaration public string Label { get; set; } Property Value String Implements IFieldTaxonomyValue.Label TermId Taxonomy term id Declaration public Guid TermId { get; set; } Property Value Guid Implements IFieldTaxonomyValue.TermId" }, "api/PnP.Core.Model.SharePoint.FieldTextOptions.html": { "href": "api/PnP.Core.Model.SharePoint.FieldTextOptions.html", "title": "Class FieldTextOptions | PnP Core SDK", - "keywords": "Class FieldTextOptions Available options for SharePoint Text fields Inheritance Object CommonFieldOptions FieldTextOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldTextOptions : CommonFieldOptions Properties MaxLength Gets or sets the maximum length of the text field. Declaration public int? MaxLength { get; set; } Property Value Nullable < Int32 >" + "keywords": "Class FieldTextOptions Available options for SharePoint Text fields Inheritance System.Object CommonFieldOptions FieldTextOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldTextOptions : CommonFieldOptions Properties MaxLength Gets or sets the maximum length of the text field. Declaration public int? MaxLength { get; set; } Property Value Nullable < Int32 >" }, "api/PnP.Core.Model.SharePoint.FieldType.html": { "href": "api/PnP.Core.Model.SharePoint.FieldType.html", @@ -1532,17 +1532,17 @@ "api/PnP.Core.Model.SharePoint.FieldUrlOptions.html": { "href": "api/PnP.Core.Model.SharePoint.FieldUrlOptions.html", "title": "Class FieldUrlOptions | PnP Core SDK", - "keywords": "Class FieldUrlOptions Available options for SharePoint URL fields Inheritance Object CommonFieldOptions FieldUrlOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldUrlOptions : CommonFieldOptions Properties DisplayFormat Gets or sets a value that specifies the display format for the value in the field. Declaration public UrlFieldFormatType DisplayFormat { get; set; } Property Value UrlFieldFormatType" + "keywords": "Class FieldUrlOptions Available options for SharePoint URL fields Inheritance System.Object CommonFieldOptions FieldUrlOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldUrlOptions : CommonFieldOptions Properties DisplayFormat Gets or sets a value that specifies the display format for the value in the field. Declaration public UrlFieldFormatType DisplayFormat { get; set; } Property Value UrlFieldFormatType" }, "api/PnP.Core.Model.SharePoint.FieldUrlValue.html": { "href": "api/PnP.Core.Model.SharePoint.FieldUrlValue.html", "title": "Class FieldUrlValue | PnP Core SDK", - "keywords": "Class FieldUrlValue Base class for reading and writing of \"special\" field types like a lookup, user, url... Inheritance Object FieldValue FieldUrlValue Inherited Members FieldValue.Field Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public sealed class FieldUrlValue : FieldValue, IFieldUrlValue, IFieldValue Constructors FieldUrlValue(String) Default constructor Declaration public FieldUrlValue(string url) Parameters String url Url to set FieldUrlValue(String, String) Default constructor Declaration public FieldUrlValue(string url, string description) Parameters String url Url to set String description Url description to use Properties Description Description of the Url Declaration public string Description { get; set; } Property Value String Implements IFieldUrlValue.Description Url Url Declaration public string Url { get; set; } Property Value String Implements IFieldUrlValue.Url" + "keywords": "Class FieldUrlValue Base class for reading and writing of \"special\" field types like a lookup, user, url... Inheritance System.Object FieldValue FieldUrlValue Inherited Members FieldValue.Field Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public sealed class FieldUrlValue : FieldValue, IFieldUrlValue, IFieldValue Constructors FieldUrlValue(String) Default constructor Declaration public FieldUrlValue(string url) Parameters String url Url to set FieldUrlValue(String, String) Default constructor Declaration public FieldUrlValue(string url, string description) Parameters String url Url to set String description Url description to use Properties Description Description of the Url Declaration public string Description { get; set; } Property Value String Implements IFieldUrlValue.Description Url Url Declaration public string Url { get; set; } Property Value String Implements IFieldUrlValue.Url" }, "api/PnP.Core.Model.SharePoint.FieldUserOptions.html": { "href": "api/PnP.Core.Model.SharePoint.FieldUserOptions.html", "title": "Class FieldUserOptions | PnP Core SDK", - "keywords": "Class FieldUserOptions Available options for SharePoint user fields Inheritance Object CommonFieldOptions FieldUserOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldUserOptions : CommonFieldOptions Properties AllowDisplay Gets or sets a value that specifies whether to display the name of the user in a survey list. Declaration public bool? AllowDisplay { get; set; } Property Value Nullable < Boolean > Presence Gets or sets a value that specifies whether presence is enabled on the field. Declaration public bool? Presence { get; set; } Property Value Nullable < Boolean > SelectionGroup Gets or sets a value that specifies the identifier of the SharePoint group whose members can be selected as values of the field. Declaration public int? SelectionGroup { get; set; } Property Value Nullable < Int32 > SelectionMode Gets or sets a value that specifies whether users and groups or only users can be selected. Declaration public FieldUserSelectionMode SelectionMode { get; set; } Property Value FieldUserSelectionMode" + "keywords": "Class FieldUserOptions Available options for SharePoint user fields Inheritance System.Object CommonFieldOptions FieldUserOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldUserOptions : CommonFieldOptions Properties AllowDisplay Gets or sets a value that specifies whether to display the name of the user in a survey list. Declaration public bool? AllowDisplay { get; set; } Property Value Nullable < Boolean > Presence Gets or sets a value that specifies whether presence is enabled on the field. Declaration public bool? Presence { get; set; } Property Value Nullable < Boolean > SelectionGroup Gets or sets a value that specifies the identifier of the SharePoint group whose members can be selected as values of the field. Declaration public int? SelectionGroup { get; set; } Property Value Nullable < Int32 > SelectionMode Gets or sets a value that specifies whether users and groups or only users can be selected. Declaration public FieldUserSelectionMode SelectionMode { get; set; } Property Value FieldUserSelectionMode" }, "api/PnP.Core.Model.SharePoint.FieldUserSelectionMode.html": { "href": "api/PnP.Core.Model.SharePoint.FieldUserSelectionMode.html", @@ -1552,17 +1552,17 @@ "api/PnP.Core.Model.SharePoint.FieldUserValue.html": { "href": "api/PnP.Core.Model.SharePoint.FieldUserValue.html", "title": "Class FieldUserValue | PnP Core SDK", - "keywords": "Class FieldUserValue Represents a user field value Inheritance Object FieldValue FieldLookupValue FieldUserValue Inherited Members FieldLookupValue.LookupId FieldLookupValue.LookupValue FieldLookupValue.IsSecretFieldValue FieldValue.Field Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public sealed class FieldUserValue : FieldLookupValue, IFieldUserValue, IFieldLookupValue, IFieldValue Constructors FieldUserValue(ISharePointPrincipal) Default constructor Declaration public FieldUserValue(ISharePointPrincipal principal) Parameters ISharePointPrincipal principal Principal describing the user or group FieldUserValue(Int32) Default constructor Declaration public FieldUserValue(int userId) Parameters Int32 userId Id of the user Properties Email Email of the user Declaration public string Email { get; } Property Value String Implements IFieldUserValue.Email Picture Profile picture url for the user Declaration public string Picture { get; } Property Value String Implements IFieldUserValue.Picture Principal Principal describing the user or group Declaration public ISharePointPrincipal Principal { get; set; } Property Value ISharePointPrincipal Implements IFieldUserValue.Principal Sip SIP address of the user Declaration public string Sip { get; } Property Value String Implements IFieldUserValue.Sip Title Title/name of the user Declaration public string Title { get; } Property Value String Implements IFieldUserValue.Title" + "keywords": "Class FieldUserValue Represents a user field value Inheritance System.Object FieldValue FieldLookupValue FieldUserValue Inherited Members FieldLookupValue.LookupId FieldLookupValue.LookupValue FieldLookupValue.IsSecretFieldValue FieldValue.Field Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public sealed class FieldUserValue : FieldLookupValue, IFieldUserValue, IFieldLookupValue, IFieldValue Constructors FieldUserValue(ISharePointPrincipal) Default constructor Declaration public FieldUserValue(ISharePointPrincipal principal) Parameters ISharePointPrincipal principal Principal describing the user or group FieldUserValue(Int32) Default constructor Declaration public FieldUserValue(int userId) Parameters Int32 userId Id of the user Properties Email Email of the user Declaration public string Email { get; } Property Value String Implements IFieldUserValue.Email Picture Profile picture url for the user Declaration public string Picture { get; } Property Value String Implements IFieldUserValue.Picture Principal Principal describing the user or group Declaration public ISharePointPrincipal Principal { get; set; } Property Value ISharePointPrincipal Implements IFieldUserValue.Principal Sip SIP address of the user Declaration public string Sip { get; } Property Value String Implements IFieldUserValue.Sip Title Title/name of the user Declaration public string Title { get; } Property Value String Implements IFieldUserValue.Title" }, "api/PnP.Core.Model.SharePoint.FieldValue.html": { "href": "api/PnP.Core.Model.SharePoint.FieldValue.html", "title": "Class FieldValue | PnP Core SDK", - "keywords": "Class FieldValue Base class for all field value classes Inheritance Object FieldValue FieldLocationValue FieldLookupValue FieldTaxonomyValue FieldUrlValue Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public abstract class FieldValue : object, IFieldValue Constructors FieldValue() Default constructor Declaration public FieldValue() Properties Field Field linked to this field value Declaration public IField Field { get; set; } Property Value IField Implements IFieldValue.Field" + "keywords": "Class FieldValue Base class for all field value classes Inheritance System.Object FieldValue FieldLocationValue FieldLookupValue FieldTaxonomyValue FieldUrlValue Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public abstract class FieldValue : object, IFieldValue Constructors FieldValue() Default constructor Declaration public FieldValue() Properties Field Field linked to this field value Declaration public IField Field { get; set; } Property Value IField Implements IFieldValue.Field" }, "api/PnP.Core.Model.SharePoint.FieldValueCollection.html": { "href": "api/PnP.Core.Model.SharePoint.FieldValueCollection.html", "title": "Class FieldValueCollection | PnP Core SDK", - "keywords": "Class FieldValueCollection Collection of 'special' field values Inheritance Object FieldValueCollection Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public sealed class FieldValueCollection : object, IFieldValueCollection Constructors FieldValueCollection() Default constructor Declaration public FieldValueCollection() FieldValueCollection(IEnumerable) Default constructor taking in a collection of IFieldValue objects Declaration public FieldValueCollection(IEnumerable fieldValues) Parameters IEnumerable < IFieldValue > fieldValues Collection of IFieldValue objects Properties Values Values in the collection Declaration public ObservableCollection Values { get; } Property Value ObservableCollection < IFieldValue > Implements IFieldValueCollection.Values Methods RemoveLookupValue(Int32) Removes IFieldLookupValue from the collection if found Declaration public void RemoveLookupValue(int lookupId) Parameters Int32 lookupId Id of the IFieldLookupValue to remove Implements IFieldValueCollection.RemoveLookupValue(Int32) RemoveTaxonomyFieldValue(Guid) Removes IFieldTaxonomyValue from the collection if found Declaration public void RemoveTaxonomyFieldValue(Guid termId) Parameters Guid termId Id of the IFieldTaxonomyValue to remove Implements IFieldValueCollection.RemoveTaxonomyFieldValue(Guid)" + "keywords": "Class FieldValueCollection Collection of 'special' field values Inheritance System.Object FieldValueCollection Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public sealed class FieldValueCollection : object, IFieldValueCollection Constructors FieldValueCollection() Default constructor Declaration public FieldValueCollection() FieldValueCollection(IEnumerable) Default constructor taking in a collection of IFieldValue objects Declaration public FieldValueCollection(IEnumerable fieldValues) Parameters IEnumerable < IFieldValue > fieldValues Collection of IFieldValue objects Properties Values Values in the collection Declaration public ObservableCollection Values { get; } Property Value ObservableCollection < IFieldValue > Implements IFieldValueCollection.Values Methods RemoveLookupValue(Int32) Removes IFieldLookupValue from the collection if found Declaration public void RemoveLookupValue(int lookupId) Parameters Int32 lookupId Id of the IFieldLookupValue to remove Implements IFieldValueCollection.RemoveLookupValue(Int32) RemoveTaxonomyFieldValue(Guid) Removes IFieldTaxonomyValue from the collection if found Declaration public void RemoveTaxonomyFieldValue(Guid termId) Parameters Guid termId Id of the IFieldTaxonomyValue to remove Implements IFieldValueCollection.RemoveTaxonomyFieldValue(Guid)" }, "api/PnP.Core.Model.SharePoint.FileLevel.html": { "href": "api/PnP.Core.Model.SharePoint.FileLevel.html", @@ -1577,7 +1577,7 @@ "api/PnP.Core.Model.SharePoint.FollowData.html": { "href": "api/PnP.Core.Model.SharePoint.FollowData.html", "title": "Class FollowData | PnP Core SDK", - "keywords": "Class FollowData A metadata object following requests Inheritance Object FollowData FollowDocumentData FollowPersonData FollowSiteData FollowTagData Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public abstract class FollowData : object Properties ActorType Represents an actor type. Can be either a user, site, document or tag Declaration public abstract SocialActorType ActorType { get; } Property Value SocialActorType" + "keywords": "Class FollowData A metadata object following requests Inheritance System.Object FollowData FollowDocumentData FollowPersonData FollowSiteData FollowTagData Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public abstract class FollowData : object Properties ActorType Represents an actor type. Can be either a user, site, document or tag Declaration public abstract SocialActorType ActorType { get; } Property Value SocialActorType" }, "api/PnP.Core.Model.SharePoint.FooterLayoutType.html": { "href": "api/PnP.Core.Model.SharePoint.FooterLayoutType.html", @@ -1592,7 +1592,7 @@ "api/PnP.Core.Model.SharePoint.GenericAdaptiveCardExtension.html": { "href": "api/PnP.Core.Model.SharePoint.GenericAdaptiveCardExtension.html", "title": "Class GenericAdaptiveCardExtension | PnP Core SDK", - "keywords": "Class GenericAdaptiveCardExtension Representents a generic, non typed, ACE Inheritance Object AdaptiveCardExtension AdaptiveCardExtension < JsonElement > GenericAdaptiveCardExtension Inherited Members AdaptiveCardExtension.Properties AdaptiveCardExtension.Id AdaptiveCardExtension.InstanceId AdaptiveCardExtension.Title AdaptiveCardExtension.Description AdaptiveCardExtension.JsonProperties AdaptiveCardExtension.IconProperty AdaptiveCardExtension.CardSize AdaptiveCardExtension.Order AdaptiveCardExtension.ACEType Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class GenericAdaptiveCardExtension : AdaptiveCardExtension" + "keywords": "Class GenericAdaptiveCardExtension Representents a generic, non typed, ACE Inheritance System.Object AdaptiveCardExtension AdaptiveCardExtension < JsonElement > GenericAdaptiveCardExtension Inherited Members AdaptiveCardExtension.Properties AdaptiveCardExtension.Id AdaptiveCardExtension.InstanceId AdaptiveCardExtension.Title AdaptiveCardExtension.Description AdaptiveCardExtension.JsonProperties AdaptiveCardExtension.IconProperty AdaptiveCardExtension.CardSize AdaptiveCardExtension.Order AdaptiveCardExtension.ACEType Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class GenericAdaptiveCardExtension : AdaptiveCardExtension" }, "api/PnP.Core.Model.SharePoint.HeaderLayoutType.html": { "href": "api/PnP.Core.Model.SharePoint.HeaderLayoutType.html", @@ -1622,7 +1622,7 @@ "api/PnP.Core.Model.SharePoint.IAttachment.html": { "href": "api/PnP.Core.Model.SharePoint.IAttachment.html", "title": "Interface IAttachment | PnP Core SDK", - "keywords": "Interface IAttachment A list item attachment Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IAttachment : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object FileName Name of the attachment Declaration string FileName { get; set; } Property Value String FileNameAsPath Name of the attachment as path Declaration string FileNameAsPath { get; set; } Property Value String ServerRelativePath Server relative URL of the attachment as path Declaration string ServerRelativePath { get; set; } Property Value String ServerRelativeUrl Server relative URL of the attachment Declaration string ServerRelativeUrl { get; set; } Property Value String Methods GetContent(Boolean) Get the content of this attachment. Declaration Stream GetContent(bool streamContent = false) Parameters Boolean streamContent Already return the content before all bytes are read, needed for large file downloads Returns Stream Stream containing the binary content of the attachment GetContentAsync(Boolean) Get the content of this attachment. Declaration Task GetContentAsync(bool streamContent = false) Parameters Boolean streamContent Already return the content before all bytes are read, needed for large file downloads Returns Task < Stream > Stream containing the binary content of the attachment GetContentBytes() Get the content of the attachment. Declaration byte[] GetContentBytes() Returns Byte [] The binary content of the attachment GetContentBytesAsync() Get the content of this attachment. Declaration Task GetContentBytesAsync() Returns Task < Byte []> The binary content of the attachment Recycle() Recycle this list attachment Declaration void Recycle() RecycleAsync() Recycle this list attachment Declaration Task RecycleAsync() Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IAttachment A list item attachment Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IAttachment : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object FileName Name of the attachment Declaration string FileName { get; set; } Property Value String FileNameAsPath Name of the attachment as path Declaration string FileNameAsPath { get; set; } Property Value String ServerRelativePath Server relative URL of the attachment as path Declaration string ServerRelativePath { get; set; } Property Value String ServerRelativeUrl Server relative URL of the attachment Declaration string ServerRelativeUrl { get; set; } Property Value String Methods GetContent(Boolean) Get the content of this attachment. Declaration Stream GetContent(bool streamContent = false) Parameters Boolean streamContent Already return the content before all bytes are read, needed for large file downloads Returns Stream Stream containing the binary content of the attachment GetContentAsync(Boolean) Get the content of this attachment. Declaration Task GetContentAsync(bool streamContent = false) Parameters Boolean streamContent Already return the content before all bytes are read, needed for large file downloads Returns Task < Stream > Stream containing the binary content of the attachment GetContentBytes() Get the content of the attachment. Declaration byte[] GetContentBytes() Returns Byte [] The binary content of the attachment GetContentBytesAsync() Get the content of this attachment. Declaration Task GetContentBytesAsync() Returns Task < Byte []> The binary content of the attachment Recycle() Recycle this list attachment Declaration void Recycle() RecycleAsync() Recycle this list attachment Declaration Task RecycleAsync() Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IAttachmentCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IAttachmentCollection.html", @@ -1632,7 +1632,7 @@ "api/PnP.Core.Model.SharePoint.IBasePermissions.html": { "href": "api/PnP.Core.Model.SharePoint.IBasePermissions.html", "title": "Interface IBasePermissions | PnP Core SDK", - "keywords": "Interface IBasePermissions Defines the granted permission mask Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IBasePermissions : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object High Maximum granted permission mask Declaration long High { get; set; } Property Value Int64 Low Minimal granted permission mask Declaration long Low { get; set; } Property Value Int64 Methods Clear(PermissionKind) Clears the specified permission for the current instance. Declaration void Clear(PermissionKind permissionKind) Parameters PermissionKind permissionKind ClearAll() Clears all permissions for the current instance. Declaration void ClearAll() Has(PermissionKind) Is this requested PermissionKind include? Declaration bool Has(PermissionKind perm) Parameters PermissionKind perm PermissionKind permisson Returns Boolean True if included, false otherwise HasPermissions(UInt32, UInt32) Are the requested permission masks included? Declaration bool HasPermissions(uint high, uint low) Parameters UInt32 high High end mask UInt32 low Low end mask Returns Boolean True if included, false otherwise Set(PermissionKind) Sets the specified permission for the current instance. Declaration void Set(PermissionKind permissionKind) Parameters PermissionKind permissionKind Extension Methods RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IBasePermissions Defines the granted permission mask Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IBasePermissions : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object High Maximum granted permission mask Declaration long High { get; set; } Property Value Int64 Low Minimal granted permission mask Declaration long Low { get; set; } Property Value Int64 Methods Clear(PermissionKind) Clears the specified permission for the current instance. Declaration void Clear(PermissionKind permissionKind) Parameters PermissionKind permissionKind ClearAll() Clears all permissions for the current instance. Declaration void ClearAll() Has(PermissionKind) Is this requested PermissionKind include? Declaration bool Has(PermissionKind perm) Parameters PermissionKind perm PermissionKind permisson Returns Boolean True if included, false otherwise HasPermissions(UInt32, UInt32) Are the requested permission masks included? Declaration bool HasPermissions(uint high, uint low) Parameters UInt32 high High end mask UInt32 low Low end mask Returns Boolean True if included, false otherwise Set(PermissionKind) Sets the specified permission for the current instance. Declaration void Set(PermissionKind permissionKind) Parameters PermissionKind permissionKind Extension Methods RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IBrandingManager.html": { "href": "api/PnP.Core.Model.SharePoint.IBrandingManager.html", @@ -1657,7 +1657,7 @@ "api/PnP.Core.Model.SharePoint.IChange.html": { "href": "api/PnP.Core.Model.SharePoint.IChange.html", "title": "Interface IChange | PnP Core SDK", - "keywords": "Interface IChange Base interface for a description of a change to an object. Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IChange Properties ChangeToken Gets a value that specifies a change token that identifies the changed object. Declaration IChangeToken ChangeToken { get; } Property Value IChangeToken ChangeType Gets a value that specifies the type of the change that has been made to the object. Declaration ChangeType ChangeType { get; } Property Value ChangeType SiteId Gets a value that identifies the site that contains the changed object. Declaration Guid SiteId { get; } Property Value Guid Time Gets a value that specifies the time that the object was modified. Declaration DateTime Time { get; } Property Value DateTime Methods IsPropertyAvailable(Expression>) Checks if a property was loaded or not Declaration bool IsPropertyAvailable(Expression> expression) Parameters Expression < Func > expression An expression defining the property to check (e.g. p => p.Property) Returns Boolean Type Parameters TModel The entity derived from IChange that you're checking the property for" + "keywords": "Interface IChange Base interface for a description of a change to an object. Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IChange Properties ChangeToken Gets a value that specifies a change token that identifies the changed object. Declaration IChangeToken ChangeToken { get; } Property Value IChangeToken ChangeType Gets a value that specifies the type of the change that has been made to the object. Declaration ChangeType ChangeType { get; } Property Value ChangeType SiteId Gets a value that identifies the site that contains the changed object. Declaration Guid SiteId { get; } Property Value Guid Time Gets a value that specifies the time that the object was modified. Declaration DateTime Time { get; } Property Value DateTime Methods IsPropertyAvailable(Expression>) Checks if a property was loaded or not Declaration bool IsPropertyAvailable(Expression> expression) Parameters Expression < Func > expression An expression defining the property to check (e.g. p => p.Property) Returns Boolean Type Parameters TModel The entity derived from IChange that you're checking the property for" }, "api/PnP.Core.Model.SharePoint.IChangeAlert.html": { "href": "api/PnP.Core.Model.SharePoint.IChangeAlert.html", @@ -1732,7 +1732,7 @@ "api/PnP.Core.Model.SharePoint.IComment.html": { "href": "api/PnP.Core.Model.SharePoint.IComment.html", "title": "Interface IComment | PnP Core SDK", - "keywords": "Interface IComment Public interface to define a comment. Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IComment : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object Author Comment author. Declaration ISharePointSharingPrincipal Author { get; } Property Value ISharePointSharingPrincipal CreatedDate Comment creation date. Declaration DateTime CreatedDate { get; } Property Value DateTime Id Comment id. Declaration string Id { get; } Property Value String IsLikedByUser Flag that indicates whether the user in the current context liked the comment. Declaration bool IsLikedByUser { get; } Property Value Boolean IsReply Comment is a reply to another comment. Declaration bool IsReply { get; } Property Value Boolean ItemId Comment item id. Declaration int ItemId { get; } Property Value Int32 LikeCount Number of likes for the comment. Declaration int LikeCount { get; } Property Value Int32 LikedBy List of users who have liked the comment. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ICommentLikeUserEntityCollection LikedBy { get; } Property Value ICommentLikeUserEntityCollection ListId Comment list id. Declaration Guid ListId { get; } Property Value Guid Mentions List of users who are at mentioned in this comment. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ICommentLikeUserEntityCollection Mentions { get; } Property Value ICommentLikeUserEntityCollection ParentId Comment parent ID (0 if not a reply). Declaration string ParentId { get; } Property Value String RelativeCreatedDate Gets a string that represents the relative value of the comment's creation date. Declaration string RelativeCreatedDate { get; } Property Value String Replies Replies to the comment. Declaration ICommentCollection Replies { get; } Property Value ICommentCollection ReplyCount Number of replies to the comment. Declaration int ReplyCount { get; } Property Value Int32 Text Comment text. Declaration string Text { get; set; } Property Value String Methods Like() Likes the comment for the user in the current context. Declaration void Like() LikeAsync() Likes the comment for the user in the current context. Declaration Task LikeAsync() Returns Task Unlike() Unlikes the comment for the user in the current context. Declaration void Unlike() UnlikeAsync() Unlikes the comment for the user in the current context. Declaration Task UnlikeAsync() Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IComment Public interface to define a comment. Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IComment : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object Author Comment author. Declaration ISharePointSharingPrincipal Author { get; } Property Value ISharePointSharingPrincipal CreatedDate Comment creation date. Declaration DateTime CreatedDate { get; } Property Value DateTime Id Comment id. Declaration string Id { get; } Property Value String IsLikedByUser Flag that indicates whether the user in the current context liked the comment. Declaration bool IsLikedByUser { get; } Property Value Boolean IsReply Comment is a reply to another comment. Declaration bool IsReply { get; } Property Value Boolean ItemId Comment item id. Declaration int ItemId { get; } Property Value Int32 LikeCount Number of likes for the comment. Declaration int LikeCount { get; } Property Value Int32 LikedBy List of users who have liked the comment. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ICommentLikeUserEntityCollection LikedBy { get; } Property Value ICommentLikeUserEntityCollection ListId Comment list id. Declaration Guid ListId { get; } Property Value Guid Mentions List of users who are at mentioned in this comment. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ICommentLikeUserEntityCollection Mentions { get; } Property Value ICommentLikeUserEntityCollection ParentId Comment parent ID (0 if not a reply). Declaration string ParentId { get; } Property Value String RelativeCreatedDate Gets a string that represents the relative value of the comment's creation date. Declaration string RelativeCreatedDate { get; } Property Value String Replies Replies to the comment. Declaration ICommentCollection Replies { get; } Property Value ICommentCollection ReplyCount Number of replies to the comment. Declaration int ReplyCount { get; } Property Value Int32 Text Comment text. Declaration string Text { get; set; } Property Value String Methods Like() Likes the comment for the user in the current context. Declaration void Like() LikeAsync() Likes the comment for the user in the current context. Declaration Task LikeAsync() Returns Task Unlike() Unlikes the comment for the user in the current context. Declaration void Unlike() UnlikeAsync() Unlikes the comment for the user in the current context. Declaration Task UnlikeAsync() Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.ICommentCollection.html": { "href": "api/PnP.Core.Model.SharePoint.ICommentCollection.html", @@ -1762,7 +1762,7 @@ "api/PnP.Core.Model.SharePoint.IContentType.html": { "href": "api/PnP.Core.Model.SharePoint.IContentType.html", "title": "Interface IContentType | PnP Core SDK", - "keywords": "Interface IContentType Public interface to define a Content Type object of SharePoint Online Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IContentType : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object ClientFormCustomFormatter Gets or Sets the Client Form Custom Formatter of the Content Type Declaration string ClientFormCustomFormatter { get; set; } Property Value String Description Gets or Sets the description of the Content Type Declaration string Description { get; set; } Property Value String DisplayFormTemplateName Gets or Sets the Display Form template name of the Content Type Declaration string DisplayFormTemplateName { get; set; } Property Value String DisplayFormUrl Gets or Sets the Display Form URL of the Content Type Declaration string DisplayFormUrl { get; set; } Property Value String DocumentTemplate Gets or Sets the Document Template of the Content Type Declaration string DocumentTemplate { get; set; } Property Value String DocumentTemplateUrl Gets or Sets the DocumentTemplate URL of the Content Type Declaration string DocumentTemplateUrl { get; set; } Property Value String EditFormTemplateName Gets or Sets the Edit Form template name of the Content Type Declaration string EditFormTemplateName { get; set; } Property Value String EditFormUrl Gets or Sets the Edit Form URL of the Content Type Declaration string EditFormUrl { get; set; } Property Value String FieldLinks Gets the collection of field links of the Content Type. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFieldLinkCollection FieldLinks { get; } Property Value IFieldLinkCollection Fields Gets the collection of fields of the Content Type. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFieldCollection Fields { get; } Property Value IFieldCollection Group Gets or Sets the group of the Content Type Declaration string Group { get; set; } Property Value String Hidden Gets or Sets that specifies whether the Content Type is hidden Declaration bool Hidden { get; set; } Property Value Boolean Id The unique ID of the Content Type as object Declaration string Id { get; } Property Value String JSLink Gets or Sets the JS Link of the Content Type Declaration string JSLink { get; set; } Property Value String MobileDisplayFormUrl Gets or Sets the Mobile Display Form URL of the Content Type Declaration string MobileDisplayFormUrl { get; set; } Property Value String MobileEditFormUrl Gets or Sets the Mobile Edit Form URL of the Content Type Declaration string MobileEditFormUrl { get; set; } Property Value String MobileNewFormUrl Gets or Sets the Mobile New Form URL of the Content Type Declaration string MobileNewFormUrl { get; set; } Property Value String Name Gets or Sets the name of the Content Type Declaration string Name { get; set; } Property Value String NewFormTemplateName Gets or Sets the New Form template's name of the Content Type Declaration string NewFormTemplateName { get; set; } Property Value String NewFormUrl Gets or Sets the New Form URL of the Content Type Declaration string NewFormUrl { get; set; } Property Value String ReadOnly Gets or Sets whether the Content Type is read only Declaration bool ReadOnly { get; set; } Property Value Boolean SchemaXml Gets or Sets the Schema XML of the Content Type Declaration string SchemaXml { get; set; } Property Value String SchemaXmlWithResourceTokens Gets or Sets the Schema XML with resource tokens of the Content Type Declaration string SchemaXmlWithResourceTokens { get; set; } Property Value String Scope Gets or Sets the scope of the Content Type Declaration string Scope { get; set; } Property Value String Sealed Gets or Sets whether the Content Type is sealed Declaration bool Sealed { get; set; } Property Value Boolean StringId The unique ID of the Content Type as string Declaration string StringId { get; } Property Value String Methods AddField(IField) Adds a field to the content type Declaration void AddField(IField field) Parameters IField field IField to add to this content type AddFieldAsync(IField) Adds a field to the content type Declaration Task AddFieldAsync(IField field) Parameters IField field IField to add to this content type Returns Task AsDocumentSet() Returns the content type as a document set Declaration IDocumentSet AsDocumentSet() Returns IDocumentSet The content type as a document set AsDocumentSetAsync() Returns the content type as a document set Declaration Task AsDocumentSetAsync() Returns Task < IDocumentSet > The content type as a document set IsPublished() Checks if a content type is published from the hub to the sites in the SharePoint environment Declaration bool IsPublished() Returns Boolean IsPublishedAsync() Checks if a content type is published from the hub to the sites in the SharePoint environment Declaration Task IsPublishedAsync() Returns Task < Boolean > Publish() Publishes a content type from the hub to the sites in the SharePoint environment Declaration void Publish() PublishAsync() Publishes a content type from the hub to the sites in the SharePoint environment Declaration Task PublishAsync() Returns Task Unpublish() Unublishes a content type from the hub to the sites in the SharePoint environment Declaration void Unpublish() UnpublishAsync() Unpublishes a content type from the hub to the sites in the SharePoint environment Declaration Task UnpublishAsync() Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IContentType Public interface to define a Content Type object of SharePoint Online Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IContentType : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object ClientFormCustomFormatter Gets or Sets the Client Form Custom Formatter of the Content Type Declaration string ClientFormCustomFormatter { get; set; } Property Value String Description Gets or Sets the description of the Content Type Declaration string Description { get; set; } Property Value String DisplayFormTemplateName Gets or Sets the Display Form template name of the Content Type Declaration string DisplayFormTemplateName { get; set; } Property Value String DisplayFormUrl Gets or Sets the Display Form URL of the Content Type Declaration string DisplayFormUrl { get; set; } Property Value String DocumentTemplate Gets or Sets the Document Template of the Content Type Declaration string DocumentTemplate { get; set; } Property Value String DocumentTemplateUrl Gets or Sets the DocumentTemplate URL of the Content Type Declaration string DocumentTemplateUrl { get; set; } Property Value String EditFormTemplateName Gets or Sets the Edit Form template name of the Content Type Declaration string EditFormTemplateName { get; set; } Property Value String EditFormUrl Gets or Sets the Edit Form URL of the Content Type Declaration string EditFormUrl { get; set; } Property Value String FieldLinks Gets the collection of field links of the Content Type. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFieldLinkCollection FieldLinks { get; } Property Value IFieldLinkCollection Fields Gets the collection of fields of the Content Type. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFieldCollection Fields { get; } Property Value IFieldCollection Group Gets or Sets the group of the Content Type Declaration string Group { get; set; } Property Value String Hidden Gets or Sets that specifies whether the Content Type is hidden Declaration bool Hidden { get; set; } Property Value Boolean Id The unique ID of the Content Type as object Declaration string Id { get; } Property Value String JSLink Gets or Sets the JS Link of the Content Type Declaration string JSLink { get; set; } Property Value String MobileDisplayFormUrl Gets or Sets the Mobile Display Form URL of the Content Type Declaration string MobileDisplayFormUrl { get; set; } Property Value String MobileEditFormUrl Gets or Sets the Mobile Edit Form URL of the Content Type Declaration string MobileEditFormUrl { get; set; } Property Value String MobileNewFormUrl Gets or Sets the Mobile New Form URL of the Content Type Declaration string MobileNewFormUrl { get; set; } Property Value String Name Gets or Sets the name of the Content Type Declaration string Name { get; set; } Property Value String NewFormTemplateName Gets or Sets the New Form template's name of the Content Type Declaration string NewFormTemplateName { get; set; } Property Value String NewFormUrl Gets or Sets the New Form URL of the Content Type Declaration string NewFormUrl { get; set; } Property Value String ReadOnly Gets or Sets whether the Content Type is read only Declaration bool ReadOnly { get; set; } Property Value Boolean SchemaXml Gets or Sets the Schema XML of the Content Type Declaration string SchemaXml { get; set; } Property Value String SchemaXmlWithResourceTokens Gets or Sets the Schema XML with resource tokens of the Content Type Declaration string SchemaXmlWithResourceTokens { get; set; } Property Value String Scope Gets or Sets the scope of the Content Type Declaration string Scope { get; set; } Property Value String Sealed Gets or Sets whether the Content Type is sealed Declaration bool Sealed { get; set; } Property Value Boolean StringId The unique ID of the Content Type as string Declaration string StringId { get; } Property Value String Methods AddField(IField) Adds a field to the content type Declaration void AddField(IField field) Parameters IField field IField to add to this content type AddFieldAsync(IField) Adds a field to the content type Declaration Task AddFieldAsync(IField field) Parameters IField field IField to add to this content type Returns Task AsDocumentSet() Returns the content type as a document set Declaration IDocumentSet AsDocumentSet() Returns IDocumentSet The content type as a document set AsDocumentSetAsync() Returns the content type as a document set Declaration Task AsDocumentSetAsync() Returns Task < IDocumentSet > The content type as a document set IsPublished() Checks if a content type is published from the hub to the sites in the SharePoint environment Declaration bool IsPublished() Returns Boolean IsPublishedAsync() Checks if a content type is published from the hub to the sites in the SharePoint environment Declaration Task IsPublishedAsync() Returns Task < Boolean > Publish() Publishes a content type from the hub to the sites in the SharePoint environment Declaration void Publish() PublishAsync() Publishes a content type from the hub to the sites in the SharePoint environment Declaration Task PublishAsync() Returns Task Unpublish() Unublishes a content type from the hub to the sites in the SharePoint environment Declaration void Unpublish() UnpublishAsync() Unpublishes a content type from the hub to the sites in the SharePoint environment Declaration Task UnpublishAsync() Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IContentTypeCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IContentTypeCollection.html", @@ -1817,7 +1817,7 @@ "api/PnP.Core.Model.SharePoint.IEventReceiverDefinition.html": { "href": "api/PnP.Core.Model.SharePoint.IEventReceiverDefinition.html", "title": "Interface IEventReceiverDefinition | PnP Core SDK", - "keywords": "Interface IEventReceiverDefinition Base class that defines general properties of an event receiver for lists and webs Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IEventReceiverDefinition : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object EventType The types of events that can be handled by event receivers. Declaration EventReceiverType EventType { get; set; } Property Value EventReceiverType ReceiverAssembly The fully-qualified name of the assembly that contains the event receiver for the feature. Declaration string ReceiverAssembly { get; } Property Value String ReceiverClass The class name of the event receiver for the feature. Declaration string ReceiverClass { get; } Property Value String ReceiverId The identifier of the receiver for the event. Declaration Guid ReceiverId { get; } Property Value Guid ReceiverName The name of the receiver for the event. Declaration string ReceiverName { get; set; } Property Value String ReceiverUrl The URL of the receiver for the event. Declaration string ReceiverUrl { get; set; } Property Value String SequenceNumber The integer that represents the relative sequence of the event. Declaration int SequenceNumber { get; set; } Property Value Int32 Synchronization Enumeration that specifies the synchronization state for the event receiver. Declaration EventReceiverSynchronization Synchronization { get; set; } Property Value EventReceiverSynchronization Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IEventReceiverDefinition Base class that defines general properties of an event receiver for lists and webs Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IEventReceiverDefinition : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object EventType The types of events that can be handled by event receivers. Declaration EventReceiverType EventType { get; set; } Property Value EventReceiverType ReceiverAssembly The fully-qualified name of the assembly that contains the event receiver for the feature. Declaration string ReceiverAssembly { get; } Property Value String ReceiverClass The class name of the event receiver for the feature. Declaration string ReceiverClass { get; } Property Value String ReceiverId The identifier of the receiver for the event. Declaration Guid ReceiverId { get; } Property Value Guid ReceiverName The name of the receiver for the event. Declaration string ReceiverName { get; set; } Property Value String ReceiverUrl The URL of the receiver for the event. Declaration string ReceiverUrl { get; set; } Property Value String SequenceNumber The integer that represents the relative sequence of the event. Declaration int SequenceNumber { get; set; } Property Value Int32 Synchronization Enumeration that specifies the synchronization state for the event receiver. Declaration EventReceiverSynchronization Synchronization { get; set; } Property Value EventReceiverSynchronization Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IEventReceiverDefinitionCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IEventReceiverDefinitionCollection.html", @@ -1827,7 +1827,7 @@ "api/PnP.Core.Model.SharePoint.IFeature.html": { "href": "api/PnP.Core.Model.SharePoint.IFeature.html", "title": "Interface IFeature | PnP Core SDK", - "keywords": "Interface IFeature Represents a Feature in SharePoint Online Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IFeature : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object DefinitionId The ID of the Feature Declaration Guid DefinitionId { get; } Property Value Guid DisplayName The name of the feature Declaration string DisplayName { get; } Property Value String Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IFeature Represents a Feature in SharePoint Online Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IFeature : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object DefinitionId The ID of the Feature Declaration Guid DefinitionId { get; } Property Value Guid DisplayName The name of the feature Declaration string DisplayName { get; } Property Value String Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IFeatureCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IFeatureCollection.html", @@ -1837,7 +1837,7 @@ "api/PnP.Core.Model.SharePoint.IField.html": { "href": "api/PnP.Core.Model.SharePoint.IField.html", "title": "Interface IField | PnP Core SDK", - "keywords": "Interface IField Public interface to define a Field object of SharePoint Online Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IField : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object AllowDisplay Gets or sets whether to allow display if the user name Declaration bool AllowDisplay { get; set; } Property Value Boolean AllowHyperlink Gets or sets a value that specifies whether a hyperlink is allowed as a value of the field. Declaration bool AllowHyperlink { get; set; } Property Value Boolean AllowMultipleValues Gets or sets whether the lookup fields allows multiple values Declaration bool AllowMultipleValues { get; set; } Property Value Boolean AnchorId Gets or sets the GUID of the anchor Term object for a TaxonomyField Declaration Guid AnchorId { get; set; } Property Value Guid AppendOnly Gets or sets a value that specifies whether all changes to the value of the field are displayed in list forms. Declaration bool AppendOnly { get; set; } Property Value Boolean AutoIndexed Gets or sets a Boolean value that specifies whether the field is auto-indexed Declaration bool AutoIndexed { get; set; } Property Value Boolean CanBeDeleted Specifies whether or not the field can be deleted Declaration bool CanBeDeleted { get; } Property Value Boolean Choices Gets or sets the choices of choice field Declaration string[] Choices { get; set; } Property Value String [] ClientSideComponentId Gets or Sets the client side component Id associated with the field Declaration Guid ClientSideComponentId { get; set; } Property Value Guid ClientSideComponentProperties Gets or Sets the properties of the client side component associated with the field Declaration string ClientSideComponentProperties { get; set; } Property Value String ClientValidationFormula Gets or Sets the validation formula Declaration string ClientValidationFormula { get; set; } Property Value String ClientValidationMessage Gets or Sets the client validation message of the field Declaration string ClientValidationMessage { get; set; } Property Value String CreateValuesInEditForm Gets or sets a Boolean value that specifies whether the new Term objects can be added to the TermSet while typing in the TaxonomyField editor control. Declaration bool CreateValuesInEditForm { get; set; } Property Value Boolean CurrencyLocaleId Gets or Sets the Locale Id of the currency Declaration int CurrencyLocaleId { get; set; } Property Value Int32 CustomFormatter Gets or Sets custom formatter of the field Declaration string CustomFormatter { get; set; } Property Value String DateFormat Gets or Sets the Date Format Valid for DateTime field, Calculated field Declaration DateTimeFieldFormatType DateFormat { get; set; } Property Value DateTimeFieldFormatType DateTimeCalendarType Gets or sets the type of calendar to use of a DateTime field Declaration CalendarType DateTimeCalendarType { get; set; } Property Value CalendarType DefaultFormula Gets or sets the default formula for a calculated field Declaration string DefaultFormula { get; set; } Property Value String DefaultValue Gets or Sets the default value of the field Declaration object DefaultValue { get; set; } Property Value Object DependentLookupInternalNames Gets the dependent lookup internal names of a lookup field Declaration string[] DependentLookupInternalNames { get; } Property Value String [] Description Gets or Sets the description of the field Declaration string Description { get; set; } Property Value String Direction Specifies the direction of the reading order for the field. A string that contains LTR if the reading order is left-to-right, RTL if it is right-to-left or none Declaration string Direction { get; set; } Property Value String DisplayFormat Gets or Sets the display format of the field CAUTION: Is an integer value since according to field type, the display format enum may change Declaration int DisplayFormat { get; set; } Property Value Int32 EditFormat Determines whether to display the choice field as radio buttons or as a drop-down list Declaration ChoiceFormatType EditFormat { get; set; } Property Value ChoiceFormatType EnableLookup Gets or sets whether the lookup should be enabled for computed field Declaration bool EnableLookup { get; set; } Property Value Boolean EnforceUniqueValues Gets or Sets whether the field enforces unique values Declaration bool EnforceUniqueValues { get; set; } Property Value Boolean EntityPropertyName Gets the name of the entity property for the list item entity that uses this field Declaration string EntityPropertyName { get; } Property Value String FieldTypeKind Gets or Sets the field type kind of the field https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee540543%28v%3doffice.15%29 Declaration FieldType FieldTypeKind { get; } Property Value FieldType FillInChoice Gets or sets whether choice field can be filled in by user Declaration bool FillInChoice { get; set; } Property Value Boolean Filterable Returns whether the field can be filtered Declaration bool Filterable { get; } Property Value Boolean Formula Specifies the formula that is used for calculation in the field Declaration string Formula { get; set; } Property Value String FriendlyDisplayFormat Gets or sets the friendly format type of a DateTime field Declaration DateTimeFieldFriendlyFormatType FriendlyDisplayFormat { get; set; } Property Value DateTimeFieldFriendlyFormatType FromBaseType Gets a Boolean value that indicates whether the field derives from a base field type. Declaration bool FromBaseType { get; } Property Value Boolean Group Gets or Sets the group of the field Declaration string Group { get; set; } Property Value String Hidden Specifies whether the field is displayed in the list Declaration bool Hidden { get; set; } Property Value Boolean Id Provides the id of the field Declaration Guid Id { get; } Property Value Guid Indexed Gets or Sets whether the field is indexed Declaration bool Indexed { get; set; } Property Value Boolean IndexStatus Describes whether a field is indexed, and whether the data in the index is complete Declaration FieldIndexStatus IndexStatus { get; } Property Value FieldIndexStatus InternalName Specifies the internal name of the field Declaration string InternalName { get; } Property Value String IsAnchorValid Gets a Boolean value that specifies whether the Term object identified by the AnchorId property is valid. Declaration bool IsAnchorValid { get; } Property Value Boolean IsDependentLookup Check whether a lookup field is a dependent lookup field Declaration bool IsDependentLookup { get; } Property Value Boolean IsKeyword Gets or sets a Boolean value that indicates whether the TaxonomyField value points to the Enterprise Keywords TermSet object. Declaration bool IsKeyword { get; set; } Property Value Boolean IsPathRendered Gets or sets a Boolean value that specifies whether the default Label objects of all the parent Term objects of a Term in the TaxonomyField object will be rendered in addition to the default label of that Term. Declaration bool IsPathRendered { get; set; } Property Value Boolean IsRelationship Specifies whether this Lookup field is discoverable from the List being looked up to Declaration bool IsRelationship { get; set; } Property Value Boolean IsTermSetValid Gets a Boolean value that specifies whether the TermSet object identified by the TermSetId property exists and is available for tagging. Declaration bool IsTermSetValid { get; } Property Value Boolean JSLink Gets or sets the name of an external JS file containing any client rendering logic for fields of this type Declaration string JSLink { get; set; } Property Value String LookupField Specifies the name of the Field used as the lookup values Declaration string LookupField { get; set; } Property Value String LookupList Specifies the id (GUID) of the List that contains the Field to use as the lookup values Declaration string LookupList { get; set; } Property Value String LookupWebId Specifies the id of the Site that contains the List which contains the Field used as the lookup values Declaration Guid LookupWebId { get; set; } Property Value Guid Mappings Gets the mappings of a choice field Declaration string Mappings { get; } Property Value String MaximumValue Gets or sets the maximum value of a number field Declaration double MaximumValue { get; set; } Property Value Double MaxLength Specifies the maximum number of characters that can be typed in the field Declaration int MaxLength { get; set; } Property Value Int32 MinimumValue Gets or sets the minimum value of a number field Declaration double MinimumValue { get; set; } Property Value Double NumberOfLines Gets or sets a value that specifies the number of lines of text to display for the field. Declaration int NumberOfLines { get; set; } Property Value Int32 Open Gets or sets a Boolean value that specifies whether the new Term objects can be added to the TermSet while typing in the TaxonomyField editor control. Declaration bool Open { get; set; } Property Value Boolean OutputType Gets or sets the type of a calculated field output Declaration FieldType OutputType { get; set; } Property Value FieldType Presence Gets or sets whether to display the presence indicator of the user Declaration bool Presence { get; set; } Property Value Boolean PrimaryFieldId Specifies the GUID of the primary lookup field if this is a dependent lookup field. Otherwise, it is empty string Declaration string PrimaryFieldId { get; set; } Property Value String ReadOnlyField Specifies whether values in the field can be modified Declaration bool ReadOnlyField { get; set; } Property Value Boolean RelationshipDeleteBehavior Specifies the Delete Behavior of the Lookup Field Declaration RelationshipDeleteBehaviorType RelationshipDeleteBehavior { get; set; } Property Value RelationshipDeleteBehaviorType Required Gets or Sets whether the field is required Declaration bool Required { get; set; } Property Value Boolean RestrictedMode Gets or sets a value that specifies whether the field supports a subset of rich formatting. Declaration bool RestrictedMode { get; set; } Property Value Boolean RichText Gets or sets a value that specifies whether the field supports rich formatting. Declaration bool RichText { get; set; } Property Value Boolean SchemaXml Specifies the schema that defines the field Declaration string SchemaXml { get; set; } Property Value String Scope Specifies the ServerRelativeUrl of the of the web site folder in which the field belongs to Declaration string Scope { get; } Property Value String Sealed Specifies whether the field can be changed or deleted Declaration bool Sealed { get; set; } Property Value Boolean SelectionGroup Gets or sets the Id of the group to which the users to select belong to Declaration int SelectionGroup { get; set; } Property Value Int32 SelectionMode Gets or sets the selection mode of the user field Declaration FieldUserSelectionMode SelectionMode { get; set; } Property Value FieldUserSelectionMode ShowAsPercentage Gets or Sets whether the field should be shown as percentage Valid for Number field, Calculated field Declaration bool ShowAsPercentage { get; set; } Property Value Boolean ShowInFiltersPane Represents status to determine whether filters pane will show the field Declaration ShowInFiltersPaneStatus ShowInFiltersPane { get; set; } Property Value ShowInFiltersPaneStatus Sortable Returns whether the field can be sorted Declaration bool Sortable { get; } Property Value Boolean SspId Gets or sets the GUID that identifies the TermStore object, which contains the Enterprise Keywords for the site that the current TaxonomyField belongs to. Declaration Guid SspId { get; set; } Property Value Guid StaticName Specifies the static name of the field Declaration string StaticName { get; } Property Value String TargetTemplate Gets or sets the Web-relative URL of the target page that is used to construct the hyperlink on each Term object when the TaxonomyField object is rendered. Declaration string TargetTemplate { get; set; } Property Value String TermSetId Gets or sets the GUID of the TermSet object that contains the Term objects used by the current TaxonomyField object. Declaration Guid TermSetId { get; set; } Property Value Guid TextField Gets or sets the GUID that identifies the hidden text field in an item. Declaration Guid TextField { get; set; } Property Value Guid Title Gets or Sets the title of the field Declaration string Title { get; set; } Property Value String TypeAsString Specifies the FieldTypeKind of the field as a string value Declaration string TypeAsString { get; } Property Value String TypeDisplayName Specifies the display name for FieldTypeKind of the field Declaration string TypeDisplayName { get; } Property Value String TypeShortDescription Specifies the description of the FieldTypeKind of the field Declaration string TypeShortDescription { get; } Property Value String UnlimitedLengthInDocumentLibrary Gets or sets a value that specifies whether the field supports unlimited length in document libraries. Declaration bool UnlimitedLengthInDocumentLibrary { get; set; } Property Value Boolean UserCreated Gets or sets a Boolean value that specifies whether the TaxonomyField object is linked to a customized TermSet object. Declaration bool UserCreated { get; set; } Property Value Boolean ValidationFormula Specifies the formula referred by the field and gets evaluated when a list item is added or updated in the list Declaration string ValidationFormula { get; set; } Property Value String ValidationMessage Specifies the message to display if validation formula fails for the field when a list item is added or updated in the list Declaration string ValidationMessage { get; set; } Property Value String Methods NewFieldLookupValue(Int32) Creates a new IFieldLookupValue object Declaration IFieldLookupValue NewFieldLookupValue(int lookupId) Parameters Int32 lookupId Id of the lookup value Returns IFieldLookupValue Configured IFieldLookupValue object NewFieldTaxonomyValue(Guid, String, Int32) Creates a new IFieldTaxonomyValue object Declaration IFieldTaxonomyValue NewFieldTaxonomyValue(Guid termId, string label, int wssId = null) Parameters Guid termId Name of the term to set String label Label of the term to set Int32 wssId Optionally provide the wssId value Returns IFieldTaxonomyValue Configured IFieldTaxonomyValue object NewFieldUrlValue(String, String) Creates a new IFieldUrlValue object Declaration IFieldUrlValue NewFieldUrlValue(string url, string description = null) Parameters String url Url value String description Optional description value Returns IFieldUrlValue Configured IFieldUrlValue object NewFieldUserValue(ISharePointPrincipal) Creates a new IFieldUserValue object Declaration IFieldUserValue NewFieldUserValue(ISharePointPrincipal principal) Parameters ISharePointPrincipal principal ISharePointUser or ISharePointGroup Returns IFieldUserValue Configured IFieldUserValue object NewFieldUserValue(Int32) Creates a new IFieldUserValue object Declaration IFieldUserValue NewFieldUserValue(int userId) Parameters Int32 userId Id of the user Returns IFieldUserValue Configured IFieldUserValue object NewFieldValueCollection() Creates a new collection to hold IFieldValue objects Declaration IFieldValueCollection NewFieldValueCollection() Returns IFieldValueCollection NewFieldValueCollection(IEnumerable>) Creates a new collection to hold IFieldTaxonomyValue objects Declaration IFieldValueCollection NewFieldValueCollection(IEnumerable> fieldValues) Parameters IEnumerable < KeyValuePair < Guid , String >> fieldValues Collection of field values to add Returns IFieldValueCollection NewFieldValueCollection(IEnumerable) Creates a new collection to hold IFieldValue objects Declaration IFieldValueCollection NewFieldValueCollection(IEnumerable fieldValues) Parameters IEnumerable < IFieldValue > fieldValues Collection of field values to add Returns IFieldValueCollection SetShowInDisplayForm(Boolean) Configure the visibility of the field in a Display form Declaration void SetShowInDisplayForm(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise SetShowInDisplayFormAsync(Boolean) Configure the visibility of the field in a Display form Declaration Task SetShowInDisplayFormAsync(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise Returns Task SetShowInEditForm(Boolean) Configure the visibility of the field in a Edit form Declaration void SetShowInEditForm(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise SetShowInEditFormAsync(Boolean) Configure the visibility of the field in a Edit form Declaration Task SetShowInEditFormAsync(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise Returns Task SetShowInNewForm(Boolean) Configure the visibility of the field in a New form Declaration void SetShowInNewForm(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise SetShowInNewFormAsync(Boolean) Configure the visibility of the field in a New form Declaration Task SetShowInNewFormAsync(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise Returns Task UpdateAndPushChanges() Updates the field and pushes changes down to lists consuming this field Declaration void UpdateAndPushChanges() UpdateAndPushChangesAsync() Updates the field and pushes changes down to lists consuming this field Declaration Task UpdateAndPushChangesAsync() Returns Task UpdateAndPushChangesBatch() Updates the field and pushes changes down to lists consuming this field Declaration void UpdateAndPushChangesBatch() UpdateAndPushChangesBatch(Batch) Updates the field and pushes changes down to lists consuming this field Declaration void UpdateAndPushChangesBatch(Batch batch) Parameters Batch batch Batch to add this request to UpdateAndPushChangesBatchAsync() Updates the field and pushes changes down to lists consuming this field Declaration Task UpdateAndPushChangesBatchAsync() Returns Task UpdateAndPushChangesBatchAsync(Batch) Updates the field and pushes changes down to lists consuming this field Declaration Task UpdateAndPushChangesBatchAsync(Batch batch) Parameters Batch batch Batch to add this request to Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IField Public interface to define a Field object of SharePoint Online Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IField : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object AllowDisplay Gets or sets whether to allow display if the user name Declaration bool AllowDisplay { get; set; } Property Value Boolean AllowHyperlink Gets or sets a value that specifies whether a hyperlink is allowed as a value of the field. Declaration bool AllowHyperlink { get; set; } Property Value Boolean AllowMultipleValues Gets or sets whether the lookup fields allows multiple values Declaration bool AllowMultipleValues { get; set; } Property Value Boolean AnchorId Gets or sets the GUID of the anchor Term object for a TaxonomyField Declaration Guid AnchorId { get; set; } Property Value Guid AppendOnly Gets or sets a value that specifies whether all changes to the value of the field are displayed in list forms. Declaration bool AppendOnly { get; set; } Property Value Boolean AutoIndexed Gets or sets a Boolean value that specifies whether the field is auto-indexed Declaration bool AutoIndexed { get; set; } Property Value Boolean CanBeDeleted Specifies whether or not the field can be deleted Declaration bool CanBeDeleted { get; } Property Value Boolean Choices Gets or sets the choices of choice field Declaration string[] Choices { get; set; } Property Value String [] ClientSideComponentId Gets or Sets the client side component Id associated with the field Declaration Guid ClientSideComponentId { get; set; } Property Value Guid ClientSideComponentProperties Gets or Sets the properties of the client side component associated with the field Declaration string ClientSideComponentProperties { get; set; } Property Value String ClientValidationFormula Gets or Sets the validation formula Declaration string ClientValidationFormula { get; set; } Property Value String ClientValidationMessage Gets or Sets the client validation message of the field Declaration string ClientValidationMessage { get; set; } Property Value String CreateValuesInEditForm Gets or sets a Boolean value that specifies whether the new Term objects can be added to the TermSet while typing in the TaxonomyField editor control. Declaration bool CreateValuesInEditForm { get; set; } Property Value Boolean CurrencyLocaleId Gets or Sets the Locale Id of the currency Declaration int CurrencyLocaleId { get; set; } Property Value Int32 CustomFormatter Gets or Sets custom formatter of the field Declaration string CustomFormatter { get; set; } Property Value String DateFormat Gets or Sets the Date Format Valid for DateTime field, Calculated field Declaration DateTimeFieldFormatType DateFormat { get; set; } Property Value DateTimeFieldFormatType DateTimeCalendarType Gets or sets the type of calendar to use of a DateTime field Declaration CalendarType DateTimeCalendarType { get; set; } Property Value CalendarType DefaultFormula Gets or sets the default formula for a calculated field Declaration string DefaultFormula { get; set; } Property Value String DefaultValue Gets or Sets the default value of the field Declaration object DefaultValue { get; set; } Property Value System.Object DependentLookupInternalNames Gets the dependent lookup internal names of a lookup field Declaration string[] DependentLookupInternalNames { get; } Property Value String [] Description Gets or Sets the description of the field Declaration string Description { get; set; } Property Value String Direction Specifies the direction of the reading order for the field. A string that contains LTR if the reading order is left-to-right, RTL if it is right-to-left or none Declaration string Direction { get; set; } Property Value String DisplayFormat Gets or Sets the display format of the field CAUTION: Is an integer value since according to field type, the display format enum may change Declaration int DisplayFormat { get; set; } Property Value Int32 EditFormat Determines whether to display the choice field as radio buttons or as a drop-down list Declaration ChoiceFormatType EditFormat { get; set; } Property Value ChoiceFormatType EnableLookup Gets or sets whether the lookup should be enabled for computed field Declaration bool EnableLookup { get; set; } Property Value Boolean EnforceUniqueValues Gets or Sets whether the field enforces unique values Declaration bool EnforceUniqueValues { get; set; } Property Value Boolean EntityPropertyName Gets the name of the entity property for the list item entity that uses this field Declaration string EntityPropertyName { get; } Property Value String FieldTypeKind Gets or Sets the field type kind of the field https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee540543%28v%3doffice.15%29 Declaration FieldType FieldTypeKind { get; } Property Value FieldType FillInChoice Gets or sets whether choice field can be filled in by user Declaration bool FillInChoice { get; set; } Property Value Boolean Filterable Returns whether the field can be filtered Declaration bool Filterable { get; } Property Value Boolean Formula Specifies the formula that is used for calculation in the field Declaration string Formula { get; set; } Property Value String FriendlyDisplayFormat Gets or sets the friendly format type of a DateTime field Declaration DateTimeFieldFriendlyFormatType FriendlyDisplayFormat { get; set; } Property Value DateTimeFieldFriendlyFormatType FromBaseType Gets a Boolean value that indicates whether the field derives from a base field type. Declaration bool FromBaseType { get; } Property Value Boolean Group Gets or Sets the group of the field Declaration string Group { get; set; } Property Value String Hidden Specifies whether the field is displayed in the list Declaration bool Hidden { get; set; } Property Value Boolean Id Provides the id of the field Declaration Guid Id { get; } Property Value Guid Indexed Gets or Sets whether the field is indexed Declaration bool Indexed { get; set; } Property Value Boolean IndexStatus Describes whether a field is indexed, and whether the data in the index is complete Declaration FieldIndexStatus IndexStatus { get; } Property Value FieldIndexStatus InternalName Specifies the internal name of the field Declaration string InternalName { get; } Property Value String IsAnchorValid Gets a Boolean value that specifies whether the Term object identified by the AnchorId property is valid. Declaration bool IsAnchorValid { get; } Property Value Boolean IsDependentLookup Check whether a lookup field is a dependent lookup field Declaration bool IsDependentLookup { get; } Property Value Boolean IsKeyword Gets or sets a Boolean value that indicates whether the TaxonomyField value points to the Enterprise Keywords TermSet object. Declaration bool IsKeyword { get; set; } Property Value Boolean IsPathRendered Gets or sets a Boolean value that specifies whether the default Label objects of all the parent Term objects of a Term in the TaxonomyField object will be rendered in addition to the default label of that Term. Declaration bool IsPathRendered { get; set; } Property Value Boolean IsRelationship Specifies whether this Lookup field is discoverable from the List being looked up to Declaration bool IsRelationship { get; set; } Property Value Boolean IsTermSetValid Gets a Boolean value that specifies whether the TermSet object identified by the TermSetId property exists and is available for tagging. Declaration bool IsTermSetValid { get; } Property Value Boolean JSLink Gets or sets the name of an external JS file containing any client rendering logic for fields of this type Declaration string JSLink { get; set; } Property Value String LookupField Specifies the name of the Field used as the lookup values Declaration string LookupField { get; set; } Property Value String LookupList Specifies the id (GUID) of the List that contains the Field to use as the lookup values Declaration string LookupList { get; set; } Property Value String LookupWebId Specifies the id of the Site that contains the List which contains the Field used as the lookup values Declaration Guid LookupWebId { get; set; } Property Value Guid Mappings Gets the mappings of a choice field Declaration string Mappings { get; } Property Value String MaximumValue Gets or sets the maximum value of a number field Declaration double MaximumValue { get; set; } Property Value Double MaxLength Specifies the maximum number of characters that can be typed in the field Declaration int MaxLength { get; set; } Property Value Int32 MinimumValue Gets or sets the minimum value of a number field Declaration double MinimumValue { get; set; } Property Value Double NumberOfLines Gets or sets a value that specifies the number of lines of text to display for the field. Declaration int NumberOfLines { get; set; } Property Value Int32 Open Gets or sets a Boolean value that specifies whether the new Term objects can be added to the TermSet while typing in the TaxonomyField editor control. Declaration bool Open { get; set; } Property Value Boolean OutputType Gets or sets the type of a calculated field output Declaration FieldType OutputType { get; set; } Property Value FieldType Presence Gets or sets whether to display the presence indicator of the user Declaration bool Presence { get; set; } Property Value Boolean PrimaryFieldId Specifies the GUID of the primary lookup field if this is a dependent lookup field. Otherwise, it is empty string Declaration string PrimaryFieldId { get; set; } Property Value String ReadOnlyField Specifies whether values in the field can be modified Declaration bool ReadOnlyField { get; set; } Property Value Boolean RelationshipDeleteBehavior Specifies the Delete Behavior of the Lookup Field Declaration RelationshipDeleteBehaviorType RelationshipDeleteBehavior { get; set; } Property Value RelationshipDeleteBehaviorType Required Gets or Sets whether the field is required Declaration bool Required { get; set; } Property Value Boolean RestrictedMode Gets or sets a value that specifies whether the field supports a subset of rich formatting. Declaration bool RestrictedMode { get; set; } Property Value Boolean RichText Gets or sets a value that specifies whether the field supports rich formatting. Declaration bool RichText { get; set; } Property Value Boolean SchemaXml Specifies the schema that defines the field Declaration string SchemaXml { get; set; } Property Value String Scope Specifies the ServerRelativeUrl of the of the web site folder in which the field belongs to Declaration string Scope { get; } Property Value String Sealed Specifies whether the field can be changed or deleted Declaration bool Sealed { get; set; } Property Value Boolean SelectionGroup Gets or sets the Id of the group to which the users to select belong to Declaration int SelectionGroup { get; set; } Property Value Int32 SelectionMode Gets or sets the selection mode of the user field Declaration FieldUserSelectionMode SelectionMode { get; set; } Property Value FieldUserSelectionMode ShowAsPercentage Gets or Sets whether the field should be shown as percentage Valid for Number field, Calculated field Declaration bool ShowAsPercentage { get; set; } Property Value Boolean ShowInFiltersPane Represents status to determine whether filters pane will show the field Declaration ShowInFiltersPaneStatus ShowInFiltersPane { get; set; } Property Value ShowInFiltersPaneStatus Sortable Returns whether the field can be sorted Declaration bool Sortable { get; } Property Value Boolean SspId Gets or sets the GUID that identifies the TermStore object, which contains the Enterprise Keywords for the site that the current TaxonomyField belongs to. Declaration Guid SspId { get; set; } Property Value Guid StaticName Specifies the static name of the field Declaration string StaticName { get; } Property Value String TargetTemplate Gets or sets the Web-relative URL of the target page that is used to construct the hyperlink on each Term object when the TaxonomyField object is rendered. Declaration string TargetTemplate { get; set; } Property Value String TermSetId Gets or sets the GUID of the TermSet object that contains the Term objects used by the current TaxonomyField object. Declaration Guid TermSetId { get; set; } Property Value Guid TextField Gets or sets the GUID that identifies the hidden text field in an item. Declaration Guid TextField { get; set; } Property Value Guid Title Gets or Sets the title of the field Declaration string Title { get; set; } Property Value String TypeAsString Specifies the FieldTypeKind of the field as a string value Declaration string TypeAsString { get; } Property Value String TypeDisplayName Specifies the display name for FieldTypeKind of the field Declaration string TypeDisplayName { get; } Property Value String TypeShortDescription Specifies the description of the FieldTypeKind of the field Declaration string TypeShortDescription { get; } Property Value String UnlimitedLengthInDocumentLibrary Gets or sets a value that specifies whether the field supports unlimited length in document libraries. Declaration bool UnlimitedLengthInDocumentLibrary { get; set; } Property Value Boolean UserCreated Gets or sets a Boolean value that specifies whether the TaxonomyField object is linked to a customized TermSet object. Declaration bool UserCreated { get; set; } Property Value Boolean ValidationFormula Specifies the formula referred by the field and gets evaluated when a list item is added or updated in the list Declaration string ValidationFormula { get; set; } Property Value String ValidationMessage Specifies the message to display if validation formula fails for the field when a list item is added or updated in the list Declaration string ValidationMessage { get; set; } Property Value String Methods NewFieldLookupValue(Int32) Creates a new IFieldLookupValue object Declaration IFieldLookupValue NewFieldLookupValue(int lookupId) Parameters Int32 lookupId Id of the lookup value Returns IFieldLookupValue Configured IFieldLookupValue object NewFieldTaxonomyValue(Guid, String, Int32) Creates a new IFieldTaxonomyValue object Declaration IFieldTaxonomyValue NewFieldTaxonomyValue(Guid termId, string label, int wssId = null) Parameters Guid termId Name of the term to set String label Label of the term to set Int32 wssId Optionally provide the wssId value Returns IFieldTaxonomyValue Configured IFieldTaxonomyValue object NewFieldUrlValue(String, String) Creates a new IFieldUrlValue object Declaration IFieldUrlValue NewFieldUrlValue(string url, string description = null) Parameters String url Url value String description Optional description value Returns IFieldUrlValue Configured IFieldUrlValue object NewFieldUserValue(ISharePointPrincipal) Creates a new IFieldUserValue object Declaration IFieldUserValue NewFieldUserValue(ISharePointPrincipal principal) Parameters ISharePointPrincipal principal ISharePointUser or ISharePointGroup Returns IFieldUserValue Configured IFieldUserValue object NewFieldUserValue(Int32) Creates a new IFieldUserValue object Declaration IFieldUserValue NewFieldUserValue(int userId) Parameters Int32 userId Id of the user Returns IFieldUserValue Configured IFieldUserValue object NewFieldValueCollection() Creates a new collection to hold IFieldValue objects Declaration IFieldValueCollection NewFieldValueCollection() Returns IFieldValueCollection NewFieldValueCollection(IEnumerable>) Creates a new collection to hold IFieldTaxonomyValue objects Declaration IFieldValueCollection NewFieldValueCollection(IEnumerable> fieldValues) Parameters IEnumerable < KeyValuePair < Guid , String >> fieldValues Collection of field values to add Returns IFieldValueCollection NewFieldValueCollection(IEnumerable) Creates a new collection to hold IFieldValue objects Declaration IFieldValueCollection NewFieldValueCollection(IEnumerable fieldValues) Parameters IEnumerable < IFieldValue > fieldValues Collection of field values to add Returns IFieldValueCollection SetShowInDisplayForm(Boolean) Configure the visibility of the field in a Display form Declaration void SetShowInDisplayForm(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise SetShowInDisplayFormAsync(Boolean) Configure the visibility of the field in a Display form Declaration Task SetShowInDisplayFormAsync(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise Returns Task SetShowInEditForm(Boolean) Configure the visibility of the field in a Edit form Declaration void SetShowInEditForm(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise SetShowInEditFormAsync(Boolean) Configure the visibility of the field in a Edit form Declaration Task SetShowInEditFormAsync(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise Returns Task SetShowInNewForm(Boolean) Configure the visibility of the field in a New form Declaration void SetShowInNewForm(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise SetShowInNewFormAsync(Boolean) Configure the visibility of the field in a New form Declaration Task SetShowInNewFormAsync(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise Returns Task UpdateAndPushChanges() Updates the field and pushes changes down to lists consuming this field Declaration void UpdateAndPushChanges() UpdateAndPushChangesAsync() Updates the field and pushes changes down to lists consuming this field Declaration Task UpdateAndPushChangesAsync() Returns Task UpdateAndPushChangesBatch() Updates the field and pushes changes down to lists consuming this field Declaration void UpdateAndPushChangesBatch() UpdateAndPushChangesBatch(Batch) Updates the field and pushes changes down to lists consuming this field Declaration void UpdateAndPushChangesBatch(Batch batch) Parameters Batch batch Batch to add this request to UpdateAndPushChangesBatchAsync() Updates the field and pushes changes down to lists consuming this field Declaration Task UpdateAndPushChangesBatchAsync() Returns Task UpdateAndPushChangesBatchAsync(Batch) Updates the field and pushes changes down to lists consuming this field Declaration Task UpdateAndPushChangesBatchAsync(Batch batch) Parameters Batch batch Batch to add this request to Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IFieldCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IFieldCollection.html", @@ -1847,7 +1847,7 @@ "api/PnP.Core.Model.SharePoint.IFieldLink.html": { "href": "api/PnP.Core.Model.SharePoint.IFieldLink.html", "title": "Interface IFieldLink | PnP Core SDK", - "keywords": "Interface IFieldLink Public interface to define a FieldLink object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IFieldLink : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object DisplayName Gets or sets the display name of the field in the field link. Declaration string DisplayName { get; set; } Property Value String FieldInternalName Gets or sets the field internal name specified in the field link. Declaration string FieldInternalName { get; } Property Value String Hidden Gets or sets a Boolean value that specifies whether the field is displayed in forms that can be edited. Declaration bool Hidden { get; set; } Property Value Boolean Id Gets a value that specifies the GUID of the FieldLink. Declaration Guid Id { get; } Property Value Guid Name Gets a value that specifies the name of the FieldLink. Declaration string Name { get; } Property Value String ReadOnly Gets or sets whether the field is read-only. Declaration bool ReadOnly { get; set; } Property Value Boolean Required Gets or sets whether the field is required. Declaration bool Required { get; set; } Property Value Boolean ShowInDisplayForm Gets or sets whether the field should be shown in display form. Declaration bool ShowInDisplayForm { get; set; } Property Value Boolean Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IFieldLink Public interface to define a FieldLink object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IFieldLink : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object DisplayName Gets or sets the display name of the field in the field link. Declaration string DisplayName { get; set; } Property Value String FieldInternalName Gets or sets the field internal name specified in the field link. Declaration string FieldInternalName { get; } Property Value String Hidden Gets or sets a Boolean value that specifies whether the field is displayed in forms that can be edited. Declaration bool Hidden { get; set; } Property Value Boolean Id Gets a value that specifies the GUID of the FieldLink. Declaration Guid Id { get; } Property Value Guid Name Gets a value that specifies the name of the FieldLink. Declaration string Name { get; } Property Value String ReadOnly Gets or sets whether the field is read-only. Declaration bool ReadOnly { get; set; } Property Value Boolean Required Gets or sets whether the field is required. Declaration bool Required { get; set; } Property Value Boolean ShowInDisplayForm Gets or sets whether the field should be shown in display form. Declaration bool ShowInDisplayForm { get; set; } Property Value Boolean Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IFieldLinkCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IFieldLinkCollection.html", @@ -1897,7 +1897,7 @@ "api/PnP.Core.Model.SharePoint.IFile.html": { "href": "api/PnP.Core.Model.SharePoint.IFile.html", "title": "Interface IFile | PnP Core SDK", - "keywords": "Interface IFile Public interface to define a File object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IFile : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object Author Gets a value that specifies the user who added the file. Declaration ISharePointUser Author { get; } Property Value ISharePointUser CheckedOutByUser Gets a value that returns the user who has checked out the file. Declaration ISharePointUser CheckedOutByUser { get; } Property Value ISharePointUser CheckInComment Returns the comment that was specified when the document was checked into the document library Declaration string CheckInComment { get; } Property Value String CheckOutType Gets a value that specifies the type of check out associated with the file. Declaration CheckOutType CheckOutType { get; } Property Value CheckOutType ContentTag Returns internal version of content, used to validate document equality for read purposes. Declaration string ContentTag { get; } Property Value String CustomizedPageStatus Gets a value that specifies the customization status of the file. Declaration CustomizedPageStatus CustomizedPageStatus { get; } Property Value CustomizedPageStatus EffectiveInformationRightsManagementSettings Gets the Information Rights Management settings of the file. Declaration IEffectiveInformationRightsManagementSettings EffectiveInformationRightsManagementSettings { get; } Property Value IEffectiveInformationRightsManagementSettings ETag Gets a value that specifies the ETag value. Declaration string ETag { get; } Property Value String HasAlternateContentStreams Indicates whether this file has alternate streams with content. Declaration bool HasAlternateContentStreams { get; } Property Value Boolean InformationRightsManagementSettings Gets the Information Rights Management settings of the file. Declaration IInformationRightsManagementFileSettings InformationRightsManagementSettings { get; } Property Value IInformationRightsManagementFileSettings IrmEnabled Gets or sets whether Irm is enabled on the file. Declaration bool IrmEnabled { get; set; } Property Value Boolean Length Gets the file size of the file. Declaration long Length { get; } Property Value Int64 Level Level of the file (published or draft) Declaration PublishedStatus Level { get; } Property Value PublishedStatus LinkingUri Gets the linking URI of the file. Declaration string LinkingUri { get; } Property Value String LinkingUrl Gets the linking URL of the file. Declaration string LinkingUrl { get; } Property Value String ListId Gets the id of the list containing the file. Declaration Guid ListId { get; } Property Value Guid ListItemAllFields Gets a value that specifies the list item field values for the list item corresponding to the file. Declaration IListItem ListItemAllFields { get; } Property Value IListItem LockedByUser Gets a value that returns the user who has locked the file. Declaration ISharePointUser LockedByUser { get; } Property Value ISharePointUser MajorVersion Gets a value that specifies the major version of the file. Declaration int MajorVersion { get; } Property Value Int32 MinorVersion Gets a value that specifies the minor version of the file. Declaration int MinorVersion { get; } Property Value Int32 ModifiedBy Gets a value that returns the last user who has modified the file. Declaration ISharePointUser ModifiedBy { get; } Property Value ISharePointUser Name Gets the name of the file including the extension. Declaration string Name { get; } Property Value String PageRenderType Gets the list page render type of the file. Declaration ListPageRenderType PageRenderType { get; } Property Value ListPageRenderType Properties Gets the properties of the file. Declaration IPropertyValues Properties { get; } Property Value IPropertyValues ServerRedirectedUrl Gets the URL which opens the document in Office Web Apps. Declaration string ServerRedirectedUrl { get; } Property Value String ServerRelativeUrl Gets the relative URL of the file based on the URL for the server. Declaration string ServerRelativeUrl { get; } Property Value String SiteId Gets the Id of the Site collection in which the file is stored. Declaration Guid SiteId { get; } Property Value Guid TimeCreated Gets a value that specifies when the file was created. Declaration DateTime TimeCreated { get; } Property Value DateTime TimeLastModified Gets a value that specifies when the file was last modified. Declaration DateTime TimeLastModified { get; } Property Value DateTime Title Gets a value that specifies the display name of the file. Declaration string Title { get; } Property Value String UIVersion Gets a value that specifies the implementation-specific version identifier of the file. Declaration int UIVersion { get; } Property Value Int32 UIVersionLabel Gets a value that specifies the implementation-specific version identifier of the file. Declaration string UIVersionLabel { get; } Property Value String UniqueId Gets the unique Id of the file. Declaration Guid UniqueId { get; } Property Value Guid VersionEvents Gets a value that returns a collection of file version event objects that represent the version events of the file. Declaration IFileVersionEventCollection VersionEvents { get; } Property Value IFileVersionEventCollection Versions Gets a value that returns a collection of file version objects that represent the versions of the file. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFileVersionCollection Versions { get; } Property Value IFileVersionCollection VroomDriveID Get the Graph Drive ID of the drive to which the file belongs. Declaration string VroomDriveID { get; } Property Value String VroomItemID Get the Graph DriveItem ID of the file. Declaration string VroomItemID { get; } Property Value String WebId Gets the Id of the site in which the file is stored. Declaration Guid WebId { get; } Property Value Guid Methods Approve(String) Approves the file. The approval comment Declaration void Approve(string comment = null) Parameters String comment ApproveAsync(String) Approves the file. The approval comment Declaration Task ApproveAsync(string comment = null) Parameters String comment Returns Task ApproveBatch(Batch, String) Approves the file. The approval comment The batch instance to use. Declaration void ApproveBatch(Batch batch, string comment = null) Parameters Batch batch String comment ApproveBatch(String) Approves the file. The approval comment Declaration void ApproveBatch(string comment = null) Parameters String comment ApproveBatchAsync(Batch, String) Approves the file. The approval comment The batch instance to use. Declaration Task ApproveBatchAsync(Batch batch, string comment = null) Parameters Batch batch String comment Returns Task ApproveBatchAsync(String) Approves the file. The approval comment Declaration Task ApproveBatchAsync(string comment = null) Parameters String comment Returns Task Checkin(String, CheckinType) Checks in the file. The check in comment. The type of check in to use. Declaration void Checkin(string comment = null, CheckinType checkinType = default(CheckinType)) Parameters String comment CheckinType checkinType CheckinAsync(String, CheckinType) Checks in the file. The check in comment. The type of check in to use. Declaration Task CheckinAsync(string comment = null, CheckinType checkinType = default(CheckinType)) Parameters String comment CheckinType checkinType Returns Task CheckinBatch(Batch, String, CheckinType) Checks in the file. The check in comment. The type of check in to use. The batch instance to use. Declaration void CheckinBatch(Batch batch, string comment = null, CheckinType checkinType = default(CheckinType)) Parameters Batch batch String comment CheckinType checkinType CheckinBatch(String, CheckinType) Checks in the file. The check in comment. The type of check in to use. Declaration void CheckinBatch(string comment = null, CheckinType checkinType = default(CheckinType)) Parameters String comment CheckinType checkinType CheckinBatchAsync(Batch, String, CheckinType) Checks in the file. The check in comment. The type of check in to use. The batch instance to use. Declaration Task CheckinBatchAsync(Batch batch, string comment = null, CheckinType checkinType = default(CheckinType)) Parameters Batch batch String comment CheckinType checkinType Returns Task CheckinBatchAsync(String, CheckinType) Checks in the file. The check in comment. The type of check in to use. Declaration Task CheckinBatchAsync(string comment = null, CheckinType checkinType = default(CheckinType)) Parameters String comment CheckinType checkinType Returns Task Checkout() Checks out the file. Declaration void Checkout() CheckoutAsync() Checks out the file. Declaration Task CheckoutAsync() Returns Task CheckoutBatch() Checks out the file. Declaration void CheckoutBatch() CheckoutBatch(Batch) Checks out the file. The batch instance to use. Declaration void CheckoutBatch(Batch batch) Parameters Batch batch CheckoutBatchAsync() Checks out the file. Declaration Task CheckoutBatchAsync() Returns Task CheckoutBatchAsync(Batch) Checks out the file. The batch instance to use. Declaration Task CheckoutBatchAsync(Batch batch) Parameters Batch batch Returns Task ClassifyAndExtract() Requests Syntex AI models to classify and extract information from this file Declaration ISyntexClassifyAndExtractResult ClassifyAndExtract() Returns ISyntexClassifyAndExtractResult Information about the classify and extract request ClassifyAndExtractAsync() Requests Syntex AI models to classify and extract information from this file Declaration Task ClassifyAndExtractAsync() Returns Task < ISyntexClassifyAndExtractResult > Information about the classify and extract request ClassifyAndExtractBatch() Requests Syntex AI models to classify and extract information from this file Declaration IBatchSingleResult ClassifyAndExtractBatch() Returns IBatchSingleResult < ISyntexClassifyAndExtractResult > Information about the classify and extract request ClassifyAndExtractBatch(Batch) Requests Syntex AI models to classify and extract information from this file Declaration IBatchSingleResult ClassifyAndExtractBatch(Batch batch) Parameters Batch batch Batch to add this request to Returns IBatchSingleResult < ISyntexClassifyAndExtractResult > Information about the classify and extract request ClassifyAndExtractBatchAsync() Requests Syntex AI models to classify and extract information from this file Declaration Task> ClassifyAndExtractBatchAsync() Returns Task < IBatchSingleResult < ISyntexClassifyAndExtractResult >> Information about the classify and extract request ClassifyAndExtractBatchAsync(Batch) Requests Syntex AI models to classify and extract information from this file Declaration Task> ClassifyAndExtractBatchAsync(Batch batch) Parameters Batch batch Batch to add this request to Returns Task < IBatchSingleResult < ISyntexClassifyAndExtractResult >> Information about the classify and extract request ConvertTo(ConvertToOptions) Converts the file to PDF, JPG, Html or Glb Declaration Stream ConvertTo(ConvertToOptions options) Parameters ConvertToOptions options Defines the file conversion options Returns Stream Stream of the converted file ConvertToAsync(ConvertToOptions) Converts the file to PDF, JPG, Html or Glb Declaration Task ConvertToAsync(ConvertToOptions options) Parameters ConvertToOptions options Defines the file conversion options Returns Task < Stream > Stream of the converted file CopyTo(String, Boolean, MoveCopyOptions) Copies a file to the destination URL. Declaration void CopyTo(string destinationUrl, bool overwrite = false, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL including file name. Boolean overwrite Indicates whether the file should be overwritten if already existing. MoveCopyOptions options Options of the copy operation. CopyToAsync(String, Boolean, MoveCopyOptions) Copies a file to the destination URL. Declaration Task CopyToAsync(string destinationUrl, bool overwrite = false, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL including file name. Boolean overwrite Indicates whether the file should be overwritten if already existing. MoveCopyOptions options Options of the copy operation. Returns Task CopyToBatch(Batch, String, Boolean, MoveCopyOptions) Copies a file to the destination URL. Declaration void CopyToBatch(Batch batch, string destinationUrl, bool overwrite = false, MoveCopyOptions options = null) Parameters Batch batch The batch instance to use. String destinationUrl The destination URL including file name. Boolean overwrite Indicates whether the file should be overwritten if already existing. MoveCopyOptions options Options of the copy operation. CopyToBatch(String, Boolean, MoveCopyOptions) Copies a file to the destination URL. Declaration void CopyToBatch(string destinationUrl, bool overwrite = false, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL including file name. Boolean overwrite Indicates whether the file should be overwritten if already existing. MoveCopyOptions options Options of the copy operation. CopyToBatchAsync(Batch, String, Boolean, MoveCopyOptions) Copies a file to the destination URL. Declaration Task CopyToBatchAsync(Batch batch, string destinationUrl, bool overwrite = false, MoveCopyOptions options = null) Parameters Batch batch The batch instance to use. String destinationUrl The destination URL including file name. Boolean overwrite Indicates whether the file should be overwritten if already existing. MoveCopyOptions options Options of the copy operation. Returns Task CopyToBatchAsync(String, Boolean, MoveCopyOptions) Copies a file to the destination URL. Declaration Task CopyToBatchAsync(string destinationUrl, bool overwrite = false, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL including file name. Boolean overwrite Indicates whether the file should be overwritten if already existing. MoveCopyOptions options Options of the copy operation. Returns Task CreateAnonymousSharingLink(AnonymousLinkOptions) Creates an anonymous sharing link for a file Declaration IGraphPermission CreateAnonymousSharingLink(AnonymousLinkOptions anonymousLinkOptions) Parameters AnonymousLinkOptions anonymousLinkOptions Returns IGraphPermission Permission that has been created CreateAnonymousSharingLinkAsync(AnonymousLinkOptions) Creates an anonymous sharing link for a file Declaration Task CreateAnonymousSharingLinkAsync(AnonymousLinkOptions anonymousLinkOptions) Parameters AnonymousLinkOptions anonymousLinkOptions Returns Task < IGraphPermission > Permission that has been created CreateOrganizationalSharingLink(OrganizationalLinkOptions) Creates an organization sharing link for a file Declaration IGraphPermission CreateOrganizationalSharingLink(OrganizationalLinkOptions organizationalLinkOptions) Parameters OrganizationalLinkOptions organizationalLinkOptions Returns IGraphPermission Permission that has been created CreateOrganizationalSharingLinkAsync(OrganizationalLinkOptions) Creates an organization sharing link for a file Declaration Task CreateOrganizationalSharingLinkAsync(OrganizationalLinkOptions organizationalLinkOptions) Parameters OrganizationalLinkOptions organizationalLinkOptions Returns Task < IGraphPermission > Permission that has been created CreateSharingInvite(InviteOptions) Creates a sharing invite to a specific user Declaration IGraphPermission CreateSharingInvite(InviteOptions inviteOptions) Parameters InviteOptions inviteOptions Returns IGraphPermission Permission that has been created CreateSharingInviteAsync(InviteOptions) Creates a sharing invite to a specific user Declaration Task CreateSharingInviteAsync(InviteOptions inviteOptions) Parameters InviteOptions inviteOptions Returns Task < IGraphPermission > Permission that has been created CreateUserSharingLink(UserLinkOptions) Creates a user sharing link for a file Declaration IGraphPermission CreateUserSharingLink(UserLinkOptions userLinkOptions) Parameters UserLinkOptions userLinkOptions Returns IGraphPermission Permission that has been created CreateUserSharingLinkAsync(UserLinkOptions) Creates a user sharing link for a file Declaration Task CreateUserSharingLinkAsync(UserLinkOptions userLinkOptions) Parameters UserLinkOptions userLinkOptions Returns Task < IGraphPermission > Permission that has been created DeleteShareLinks() Deletes the share links on the file item Declaration void DeleteShareLinks() DeleteShareLinksAsync() Deletes the share links on the file item Declaration Task DeleteShareLinksAsync() Returns Task GetAnalytics(AnalyticsOptions) Gets file analytics Declaration List GetAnalytics(AnalyticsOptions options = null) Parameters AnalyticsOptions options Defines which analytics are needed Returns PnP.Core.Model.SharePoint.List < IActivityStat > The requested analytics data GetAnalyticsAsync(AnalyticsOptions) Gets file analytics Declaration Task> GetAnalyticsAsync(AnalyticsOptions options = null) Parameters AnalyticsOptions options Defines which analytics are needed Returns Task < PnP.Core.Model.SharePoint.List < IActivityStat >> The requested analytics data GetContent(Boolean) Get the content of the file. Declaration Stream GetContent(bool streamContent = false) Parameters Boolean streamContent Already return the content before all bytes are read, needed for large file downloads Returns Stream Stream containing the binary content of the file GetContentAsync(Boolean) Get the content of the file. Declaration Task GetContentAsync(bool streamContent = false) Parameters Boolean streamContent Already return the content before all bytes are read, needed for large file downloads Returns Task < Stream > Stream containing the binary content of the file GetContentBytes() Get the content of the file. Declaration byte[] GetContentBytes() Returns Byte [] The binary content of the file GetContentBytesAsync() Get the content of the file. Declaration Task GetContentBytesAsync() Returns Task < Byte []> The binary content of the file GetPreview(PreviewOptions) This action allows you to obtain short-lived embeddable URLs for an item in order to render a temporary preview. The 'page' and 'zoom' options may not be available for all preview apps, but will be applied if the preview app supports it. Declaration IFilePreview GetPreview(PreviewOptions options = null) Parameters PreviewOptions options Options for configuring the created preview URL Returns IFilePreview FilePreview object. Either getUrl, postUrl, or both might be returned depending on the current state of embed support for the specified options. GetPreviewAsync(PreviewOptions) This action allows you to obtain short-lived embeddable URLs for an item in order to render a temporary preview. The 'page' and 'zoom' options may not be available for all preview apps, but will be applied if the preview app supports it. Declaration Task GetPreviewAsync(PreviewOptions options = null) Parameters PreviewOptions options Options for configuring the created preview URL Returns Task < IFilePreview > FilePreview object. Either getUrl, postUrl, or both might be returned depending on the current state of embed support for the specified options. GetShareLinks() Gets the share links on the file item Declaration IGraphPermissionCollection GetShareLinks() Returns IGraphPermissionCollection Collection of share links existing on the file GetShareLinksAsync() Gets the share links on the file item Declaration Task GetShareLinksAsync() Returns Task < IGraphPermissionCollection > Collection of share links existing on the file GetThumbnails(ThumbnailOptions) Returns a list of thumbnails for this file Declaration List GetThumbnails(ThumbnailOptions options = null) Parameters ThumbnailOptions options Optionally specify which thumbnails you need Returns PnP.Core.Model.SharePoint.List < IThumbnail > The requested thumbnails GetThumbnailsAsync(ThumbnailOptions) Returns a list of thumbnails for this file Declaration Task> GetThumbnailsAsync(ThumbnailOptions options = null) Parameters ThumbnailOptions options Optionally specify which thumbnails you need Returns Task < PnP.Core.Model.SharePoint.List < IThumbnail >> The requested thumbnails GetThumbnailsBatch(ThumbnailOptions) Returns a list of thumbnails for this file Declaration IEnumerableBatchResult GetThumbnailsBatch(ThumbnailOptions options = null) Parameters ThumbnailOptions options Optionally specify which thumbnails you need Returns IEnumerableBatchResult < IThumbnail > The requested thumbnails GetThumbnailsBatch(Batch, ThumbnailOptions) Returns a list of thumbnails for this file Declaration IEnumerableBatchResult GetThumbnailsBatch(Batch batch, ThumbnailOptions options = null) Parameters Batch batch The batch instance to use. ThumbnailOptions options Optionally specify which thumbnails you need Returns IEnumerableBatchResult < IThumbnail > The requested thumbnails GetThumbnailsBatchAsync(ThumbnailOptions) Returns a list of thumbnails for this file Declaration Task> GetThumbnailsBatchAsync(ThumbnailOptions options = null) Parameters ThumbnailOptions options Optionally specify which thumbnails you need Returns Task < IEnumerableBatchResult < IThumbnail >> The requested thumbnails GetThumbnailsBatchAsync(Batch, ThumbnailOptions) Returns a list of thumbnails for this file Declaration Task> GetThumbnailsBatchAsync(Batch batch, ThumbnailOptions options = null) Parameters Batch batch The batch instance to use. ThumbnailOptions options Optionally specify which thumbnails you need Returns Task < IEnumerableBatchResult < IThumbnail >> The requested thumbnails MoveTo(String, MoveOperations, MoveCopyOptions) Move a file to the destination URL. Declaration void MoveTo(string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null) Parameters String destinationUrl The destination URL including file name. MoveOperations moveOperations combinable flags to indicate the type of move operations. MoveCopyOptions options Options of the move operation. Remarks If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations . MoveToAsync(String, MoveOperations, MoveCopyOptions) Move a file to the destination URL. Declaration Task MoveToAsync(string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null) Parameters String destinationUrl The destination URL including file name. MoveOperations moveOperations combinable flags to indicate the type of move operations. MoveCopyOptions options Options of the move operation. Returns Task Remarks If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations . MoveToBatch(Batch, String, MoveOperations, MoveCopyOptions) Move a file to the destination URL. Declaration void MoveToBatch(Batch batch, string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null) Parameters Batch batch The batch instance to use. String destinationUrl The destination URL including file name. MoveOperations moveOperations combinable flags to indicate the type of move operations. MoveCopyOptions options Options of the move operation. Remarks If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations . MoveToBatch(String, MoveOperations, MoveCopyOptions) Move a file to the destination URL. Declaration void MoveToBatch(string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null) Parameters String destinationUrl The destination URL including file name. MoveOperations moveOperations combinable flags to indicate the type of move operations. MoveCopyOptions options Options of the move operation. Remarks If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations . MoveToBatchAsync(Batch, String, MoveOperations, MoveCopyOptions) Move a file to the destination URL. Declaration Task MoveToBatchAsync(Batch batch, string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null) Parameters Batch batch The batch instance to use. String destinationUrl The destination URL including file name. MoveOperations moveOperations combinable flags to indicate the type of move operations. MoveCopyOptions options Options of the move operation. Returns Task Remarks If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations . MoveToBatchAsync(String, MoveOperations, MoveCopyOptions) Move a file to the destination URL. Declaration Task MoveToBatchAsync(string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null) Parameters String destinationUrl The destination URL including file name. MoveOperations moveOperations combinable flags to indicate the type of move operations. MoveCopyOptions options Options of the move operation. Returns Task Remarks If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations . Publish(String) Publish a major version of the current file. The comments to add on file publishing. Declaration void Publish(string comment = null) Parameters String comment PublishAsync(String) Publish a major version of the current file. The comments to add on file publishing. Declaration Task PublishAsync(string comment = null) Parameters String comment Returns Task PublishBatch(Batch, String) Publish a major version of the current file. The batch instance to use. The comments to add on file publishing. Declaration void PublishBatch(Batch batch, string comment = null) Parameters Batch batch String comment PublishBatch(String) Publish a major version of the current file. The comments to add on file publishing. Declaration void PublishBatch(string comment = null) Parameters String comment PublishBatchAsync(Batch, String) Publish a major version of the current file. The batch instance to use. The comments to add on file publishing. Declaration Task PublishBatchAsync(Batch batch, string comment = null) Parameters Batch batch String comment Returns Task PublishBatchAsync(String) Publish a major version of the current file. The comments to add on file publishing. Declaration Task PublishBatchAsync(string comment = null) Parameters String comment Returns Task Recycle() Send the file to recycle bin. Declaration Guid Recycle() Returns Guid The Id of the created recycle bin item RecycleAsync() Send the file to recycle bin. Declaration Task RecycleAsync() Returns Task < Guid > The Id of the created recycle bin item RecycleBatch() Send the file to recycle bin. Declaration IBatchSingleResult> RecycleBatch() Returns IBatchSingleResult < BatchResultValue < Guid >> RecycleBatch(Batch) Send the file to recycle bin Declaration IBatchSingleResult> RecycleBatch(Batch batch) Parameters Batch batch The batch instance to use. Returns IBatchSingleResult < BatchResultValue < Guid >> RecycleBatchAsync() Send the file to recycle bin. Declaration Task>> RecycleBatchAsync() Returns Task < IBatchSingleResult < BatchResultValue < Guid >>> RecycleBatchAsync(Batch) Send the file to recycle bin. Declaration Task>> RecycleBatchAsync(Batch batch) Parameters Batch batch The batch instance to use. Returns Task < IBatchSingleResult < BatchResultValue < Guid >>> Rename(String) Renames a file Declaration void Rename(string name) Parameters String name New file name RenameAsync(String) Renames a file Declaration Task RenameAsync(string name) Parameters String name New file name Returns Task UndoCheckout() Release the checked out file without saving the changes. Declaration void UndoCheckout() UndoCheckoutAsync() Release the checked out file without saving the changes. Declaration Task UndoCheckoutAsync() Returns Task UndoCheckoutBatch() Release the checked out file without saving the changes. Declaration void UndoCheckoutBatch() UndoCheckoutBatch(Batch) Release the checked out file without saving the changes. The batch instance to use. Declaration void UndoCheckoutBatch(Batch batch) Parameters Batch batch UndoCheckoutBatchAsync() Release the checked out file without saving the changes. Declaration Task UndoCheckoutBatchAsync() Returns Task UndoCheckoutBatchAsync(Batch) Release the checked out file without saving the changes. The batch instance to use. Declaration Task UndoCheckoutBatchAsync(Batch batch) Parameters Batch batch Returns Task Unpublish(String) Unpublish the latest major version of the current file. The comments to add on file unpublishing. Declaration void Unpublish(string comment = null) Parameters String comment UnpublishAsync(String) Unpublish the latest major version of the current file. The comments to add on file unpublishing. Declaration Task UnpublishAsync(string comment = null) Parameters String comment Returns Task UnpublishBatch(Batch, String) Unpublish the latest major version of the current file. The batch instance to use. The comments to add on file unpublishing. Declaration void UnpublishBatch(Batch batch, string comment = null) Parameters Batch batch String comment UnpublishBatch(String) Unpublish the latest major version of the current file. The comments to add on file unpublishing. Declaration void UnpublishBatch(string comments = null) Parameters String comments UnpublishBatchAsync(Batch, String) Unpublish the latest major version of the current file. The batch instance to use. The comments to add on file unpublishing. Declaration Task UnpublishBatchAsync(Batch batch, string comment = null) Parameters Batch batch String comment Returns Task UnpublishBatchAsync(String) Unpublish the latest major version of the current file. The comments to add on file unpublishing. Declaration Task UnpublishBatchAsync(string comment = null) Parameters String comment Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IFile Public interface to define a File object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IFile : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object Author Gets a value that specifies the user who added the file. Declaration ISharePointUser Author { get; } Property Value ISharePointUser CheckedOutByUser Gets a value that returns the user who has checked out the file. Declaration ISharePointUser CheckedOutByUser { get; } Property Value ISharePointUser CheckInComment Returns the comment that was specified when the document was checked into the document library Declaration string CheckInComment { get; } Property Value String CheckOutType Gets a value that specifies the type of check out associated with the file. Declaration CheckOutType CheckOutType { get; } Property Value CheckOutType ContentTag Returns internal version of content, used to validate document equality for read purposes. Declaration string ContentTag { get; } Property Value String CustomizedPageStatus Gets a value that specifies the customization status of the file. Declaration CustomizedPageStatus CustomizedPageStatus { get; } Property Value CustomizedPageStatus EffectiveInformationRightsManagementSettings Gets the Information Rights Management settings of the file. Declaration IEffectiveInformationRightsManagementSettings EffectiveInformationRightsManagementSettings { get; } Property Value IEffectiveInformationRightsManagementSettings ETag Gets a value that specifies the ETag value. Declaration string ETag { get; } Property Value String HasAlternateContentStreams Indicates whether this file has alternate streams with content. Declaration bool HasAlternateContentStreams { get; } Property Value Boolean InformationRightsManagementSettings Gets the Information Rights Management settings of the file. Declaration IInformationRightsManagementFileSettings InformationRightsManagementSettings { get; } Property Value IInformationRightsManagementFileSettings IrmEnabled Gets or sets whether Irm is enabled on the file. Declaration bool IrmEnabled { get; set; } Property Value Boolean Length Gets the file size of the file. Declaration long Length { get; } Property Value Int64 Level Level of the file (published or draft) Declaration PublishedStatus Level { get; } Property Value PublishedStatus LinkingUri Gets the linking URI of the file. Declaration string LinkingUri { get; } Property Value String LinkingUrl Gets the linking URL of the file. Declaration string LinkingUrl { get; } Property Value String ListId Gets the id of the list containing the file. Declaration Guid ListId { get; } Property Value Guid ListItemAllFields Gets a value that specifies the list item field values for the list item corresponding to the file. Declaration IListItem ListItemAllFields { get; } Property Value IListItem LockedByUser Gets a value that returns the user who has locked the file. Declaration ISharePointUser LockedByUser { get; } Property Value ISharePointUser MajorVersion Gets a value that specifies the major version of the file. Declaration int MajorVersion { get; } Property Value Int32 MinorVersion Gets a value that specifies the minor version of the file. Declaration int MinorVersion { get; } Property Value Int32 ModifiedBy Gets a value that returns the last user who has modified the file. Declaration ISharePointUser ModifiedBy { get; } Property Value ISharePointUser Name Gets the name of the file including the extension. Declaration string Name { get; } Property Value String PageRenderType Gets the list page render type of the file. Declaration ListPageRenderType PageRenderType { get; } Property Value ListPageRenderType Properties Gets the properties of the file. Declaration IPropertyValues Properties { get; } Property Value IPropertyValues ServerRedirectedUrl Gets the URL which opens the document in Office Web Apps. Declaration string ServerRedirectedUrl { get; } Property Value String ServerRelativeUrl Gets the relative URL of the file based on the URL for the server. Declaration string ServerRelativeUrl { get; } Property Value String SiteId Gets the Id of the Site collection in which the file is stored. Declaration Guid SiteId { get; } Property Value Guid TimeCreated Gets a value that specifies when the file was created. Declaration DateTime TimeCreated { get; } Property Value DateTime TimeLastModified Gets a value that specifies when the file was last modified. Declaration DateTime TimeLastModified { get; } Property Value DateTime Title Gets a value that specifies the display name of the file. Declaration string Title { get; } Property Value String UIVersion Gets a value that specifies the implementation-specific version identifier of the file. Declaration int UIVersion { get; } Property Value Int32 UIVersionLabel Gets a value that specifies the implementation-specific version identifier of the file. Declaration string UIVersionLabel { get; } Property Value String UniqueId Gets the unique Id of the file. Declaration Guid UniqueId { get; } Property Value Guid VersionEvents Gets a value that returns a collection of file version event objects that represent the version events of the file. Declaration IFileVersionEventCollection VersionEvents { get; } Property Value IFileVersionEventCollection Versions Gets a value that returns a collection of file version objects that represent the versions of the file. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFileVersionCollection Versions { get; } Property Value IFileVersionCollection VroomDriveID Get the Graph Drive ID of the drive to which the file belongs. Declaration string VroomDriveID { get; } Property Value String VroomItemID Get the Graph DriveItem ID of the file. Declaration string VroomItemID { get; } Property Value String WebId Gets the Id of the site in which the file is stored. Declaration Guid WebId { get; } Property Value Guid Methods Approve(String) Approves the file. The approval comment Declaration void Approve(string comment = null) Parameters String comment ApproveAsync(String) Approves the file. The approval comment Declaration Task ApproveAsync(string comment = null) Parameters String comment Returns Task ApproveBatch(Batch, String) Approves the file. The approval comment The batch instance to use. Declaration void ApproveBatch(Batch batch, string comment = null) Parameters Batch batch String comment ApproveBatch(String) Approves the file. The approval comment Declaration void ApproveBatch(string comment = null) Parameters String comment ApproveBatchAsync(Batch, String) Approves the file. The approval comment The batch instance to use. Declaration Task ApproveBatchAsync(Batch batch, string comment = null) Parameters Batch batch String comment Returns Task ApproveBatchAsync(String) Approves the file. The approval comment Declaration Task ApproveBatchAsync(string comment = null) Parameters String comment Returns Task Checkin(String, CheckinType) Checks in the file. The check in comment. The type of check in to use. Declaration void Checkin(string comment = null, CheckinType checkinType = default(CheckinType)) Parameters String comment CheckinType checkinType CheckinAsync(String, CheckinType) Checks in the file. The check in comment. The type of check in to use. Declaration Task CheckinAsync(string comment = null, CheckinType checkinType = default(CheckinType)) Parameters String comment CheckinType checkinType Returns Task CheckinBatch(Batch, String, CheckinType) Checks in the file. The check in comment. The type of check in to use. The batch instance to use. Declaration void CheckinBatch(Batch batch, string comment = null, CheckinType checkinType = default(CheckinType)) Parameters Batch batch String comment CheckinType checkinType CheckinBatch(String, CheckinType) Checks in the file. The check in comment. The type of check in to use. Declaration void CheckinBatch(string comment = null, CheckinType checkinType = default(CheckinType)) Parameters String comment CheckinType checkinType CheckinBatchAsync(Batch, String, CheckinType) Checks in the file. The check in comment. The type of check in to use. The batch instance to use. Declaration Task CheckinBatchAsync(Batch batch, string comment = null, CheckinType checkinType = default(CheckinType)) Parameters Batch batch String comment CheckinType checkinType Returns Task CheckinBatchAsync(String, CheckinType) Checks in the file. The check in comment. The type of check in to use. Declaration Task CheckinBatchAsync(string comment = null, CheckinType checkinType = default(CheckinType)) Parameters String comment CheckinType checkinType Returns Task Checkout() Checks out the file. Declaration void Checkout() CheckoutAsync() Checks out the file. Declaration Task CheckoutAsync() Returns Task CheckoutBatch() Checks out the file. Declaration void CheckoutBatch() CheckoutBatch(Batch) Checks out the file. The batch instance to use. Declaration void CheckoutBatch(Batch batch) Parameters Batch batch CheckoutBatchAsync() Checks out the file. Declaration Task CheckoutBatchAsync() Returns Task CheckoutBatchAsync(Batch) Checks out the file. The batch instance to use. Declaration Task CheckoutBatchAsync(Batch batch) Parameters Batch batch Returns Task ClassifyAndExtract() Requests Syntex AI models to classify and extract information from this file Declaration ISyntexClassifyAndExtractResult ClassifyAndExtract() Returns ISyntexClassifyAndExtractResult Information about the classify and extract request ClassifyAndExtractAsync() Requests Syntex AI models to classify and extract information from this file Declaration Task ClassifyAndExtractAsync() Returns Task < ISyntexClassifyAndExtractResult > Information about the classify and extract request ClassifyAndExtractBatch() Requests Syntex AI models to classify and extract information from this file Declaration IBatchSingleResult ClassifyAndExtractBatch() Returns IBatchSingleResult < ISyntexClassifyAndExtractResult > Information about the classify and extract request ClassifyAndExtractBatch(Batch) Requests Syntex AI models to classify and extract information from this file Declaration IBatchSingleResult ClassifyAndExtractBatch(Batch batch) Parameters Batch batch Batch to add this request to Returns IBatchSingleResult < ISyntexClassifyAndExtractResult > Information about the classify and extract request ClassifyAndExtractBatchAsync() Requests Syntex AI models to classify and extract information from this file Declaration Task> ClassifyAndExtractBatchAsync() Returns Task < IBatchSingleResult < ISyntexClassifyAndExtractResult >> Information about the classify and extract request ClassifyAndExtractBatchAsync(Batch) Requests Syntex AI models to classify and extract information from this file Declaration Task> ClassifyAndExtractBatchAsync(Batch batch) Parameters Batch batch Batch to add this request to Returns Task < IBatchSingleResult < ISyntexClassifyAndExtractResult >> Information about the classify and extract request ConvertTo(ConvertToOptions) Converts the file to PDF, JPG, Html or Glb Declaration Stream ConvertTo(ConvertToOptions options) Parameters ConvertToOptions options Defines the file conversion options Returns Stream Stream of the converted file ConvertToAsync(ConvertToOptions) Converts the file to PDF, JPG, Html or Glb Declaration Task ConvertToAsync(ConvertToOptions options) Parameters ConvertToOptions options Defines the file conversion options Returns Task < Stream > Stream of the converted file CopyTo(String, Boolean, MoveCopyOptions) Copies a file to the destination URL. Declaration void CopyTo(string destinationUrl, bool overwrite = false, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL including file name. Boolean overwrite Indicates whether the file should be overwritten if already existing. MoveCopyOptions options Options of the copy operation. CopyToAsync(String, Boolean, MoveCopyOptions) Copies a file to the destination URL. Declaration Task CopyToAsync(string destinationUrl, bool overwrite = false, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL including file name. Boolean overwrite Indicates whether the file should be overwritten if already existing. MoveCopyOptions options Options of the copy operation. Returns Task CopyToBatch(Batch, String, Boolean, MoveCopyOptions) Copies a file to the destination URL. Declaration void CopyToBatch(Batch batch, string destinationUrl, bool overwrite = false, MoveCopyOptions options = null) Parameters Batch batch The batch instance to use. String destinationUrl The destination URL including file name. Boolean overwrite Indicates whether the file should be overwritten if already existing. MoveCopyOptions options Options of the copy operation. CopyToBatch(String, Boolean, MoveCopyOptions) Copies a file to the destination URL. Declaration void CopyToBatch(string destinationUrl, bool overwrite = false, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL including file name. Boolean overwrite Indicates whether the file should be overwritten if already existing. MoveCopyOptions options Options of the copy operation. CopyToBatchAsync(Batch, String, Boolean, MoveCopyOptions) Copies a file to the destination URL. Declaration Task CopyToBatchAsync(Batch batch, string destinationUrl, bool overwrite = false, MoveCopyOptions options = null) Parameters Batch batch The batch instance to use. String destinationUrl The destination URL including file name. Boolean overwrite Indicates whether the file should be overwritten if already existing. MoveCopyOptions options Options of the copy operation. Returns Task CopyToBatchAsync(String, Boolean, MoveCopyOptions) Copies a file to the destination URL. Declaration Task CopyToBatchAsync(string destinationUrl, bool overwrite = false, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL including file name. Boolean overwrite Indicates whether the file should be overwritten if already existing. MoveCopyOptions options Options of the copy operation. Returns Task CreateAnonymousSharingLink(AnonymousLinkOptions) Creates an anonymous sharing link for a file Declaration IGraphPermission CreateAnonymousSharingLink(AnonymousLinkOptions anonymousLinkOptions) Parameters AnonymousLinkOptions anonymousLinkOptions Returns IGraphPermission Permission that has been created CreateAnonymousSharingLinkAsync(AnonymousLinkOptions) Creates an anonymous sharing link for a file Declaration Task CreateAnonymousSharingLinkAsync(AnonymousLinkOptions anonymousLinkOptions) Parameters AnonymousLinkOptions anonymousLinkOptions Returns Task < IGraphPermission > Permission that has been created CreateOrganizationalSharingLink(OrganizationalLinkOptions) Creates an organization sharing link for a file Declaration IGraphPermission CreateOrganizationalSharingLink(OrganizationalLinkOptions organizationalLinkOptions) Parameters OrganizationalLinkOptions organizationalLinkOptions Returns IGraphPermission Permission that has been created CreateOrganizationalSharingLinkAsync(OrganizationalLinkOptions) Creates an organization sharing link for a file Declaration Task CreateOrganizationalSharingLinkAsync(OrganizationalLinkOptions organizationalLinkOptions) Parameters OrganizationalLinkOptions organizationalLinkOptions Returns Task < IGraphPermission > Permission that has been created CreateSharingInvite(InviteOptions) Creates a sharing invite to a specific user Declaration IGraphPermission CreateSharingInvite(InviteOptions inviteOptions) Parameters InviteOptions inviteOptions Returns IGraphPermission Permission that has been created CreateSharingInviteAsync(InviteOptions) Creates a sharing invite to a specific user Declaration Task CreateSharingInviteAsync(InviteOptions inviteOptions) Parameters InviteOptions inviteOptions Returns Task < IGraphPermission > Permission that has been created CreateUserSharingLink(UserLinkOptions) Creates a user sharing link for a file Declaration IGraphPermission CreateUserSharingLink(UserLinkOptions userLinkOptions) Parameters UserLinkOptions userLinkOptions Returns IGraphPermission Permission that has been created CreateUserSharingLinkAsync(UserLinkOptions) Creates a user sharing link for a file Declaration Task CreateUserSharingLinkAsync(UserLinkOptions userLinkOptions) Parameters UserLinkOptions userLinkOptions Returns Task < IGraphPermission > Permission that has been created DeleteShareLinks() Deletes the share links on the file item Declaration void DeleteShareLinks() DeleteShareLinksAsync() Deletes the share links on the file item Declaration Task DeleteShareLinksAsync() Returns Task GetAnalytics(AnalyticsOptions) Gets file analytics Declaration List GetAnalytics(AnalyticsOptions options = null) Parameters AnalyticsOptions options Defines which analytics are needed Returns PnP.Core.Model.SharePoint.List < IActivityStat > The requested analytics data GetAnalyticsAsync(AnalyticsOptions) Gets file analytics Declaration Task> GetAnalyticsAsync(AnalyticsOptions options = null) Parameters AnalyticsOptions options Defines which analytics are needed Returns Task < PnP.Core.Model.SharePoint.List < IActivityStat >> The requested analytics data GetContent(Boolean) Get the content of the file. Declaration Stream GetContent(bool streamContent = false) Parameters Boolean streamContent Already return the content before all bytes are read, needed for large file downloads Returns Stream Stream containing the binary content of the file GetContentAsync(Boolean) Get the content of the file. Declaration Task GetContentAsync(bool streamContent = false) Parameters Boolean streamContent Already return the content before all bytes are read, needed for large file downloads Returns Task < Stream > Stream containing the binary content of the file GetContentBytes() Get the content of the file. Declaration byte[] GetContentBytes() Returns Byte [] The binary content of the file GetContentBytesAsync() Get the content of the file. Declaration Task GetContentBytesAsync() Returns Task < Byte []> The binary content of the file GetPreview(PreviewOptions) This action allows you to obtain short-lived embeddable URLs for an item in order to render a temporary preview. The 'page' and 'zoom' options may not be available for all preview apps, but will be applied if the preview app supports it. Declaration IFilePreview GetPreview(PreviewOptions options = null) Parameters PreviewOptions options Options for configuring the created preview URL Returns IFilePreview FilePreview object. Either getUrl, postUrl, or both might be returned depending on the current state of embed support for the specified options. GetPreviewAsync(PreviewOptions) This action allows you to obtain short-lived embeddable URLs for an item in order to render a temporary preview. The 'page' and 'zoom' options may not be available for all preview apps, but will be applied if the preview app supports it. Declaration Task GetPreviewAsync(PreviewOptions options = null) Parameters PreviewOptions options Options for configuring the created preview URL Returns Task < IFilePreview > FilePreview object. Either getUrl, postUrl, or both might be returned depending on the current state of embed support for the specified options. GetShareLinks() Gets the share links on the file item Declaration IGraphPermissionCollection GetShareLinks() Returns IGraphPermissionCollection Collection of share links existing on the file GetShareLinksAsync() Gets the share links on the file item Declaration Task GetShareLinksAsync() Returns Task < IGraphPermissionCollection > Collection of share links existing on the file GetThumbnails(ThumbnailOptions) Returns a list of thumbnails for this file Declaration List GetThumbnails(ThumbnailOptions options = null) Parameters ThumbnailOptions options Optionally specify which thumbnails you need Returns PnP.Core.Model.SharePoint.List < IThumbnail > The requested thumbnails GetThumbnailsAsync(ThumbnailOptions) Returns a list of thumbnails for this file Declaration Task> GetThumbnailsAsync(ThumbnailOptions options = null) Parameters ThumbnailOptions options Optionally specify which thumbnails you need Returns Task < PnP.Core.Model.SharePoint.List < IThumbnail >> The requested thumbnails GetThumbnailsBatch(ThumbnailOptions) Returns a list of thumbnails for this file Declaration IEnumerableBatchResult GetThumbnailsBatch(ThumbnailOptions options = null) Parameters ThumbnailOptions options Optionally specify which thumbnails you need Returns IEnumerableBatchResult < IThumbnail > The requested thumbnails GetThumbnailsBatch(Batch, ThumbnailOptions) Returns a list of thumbnails for this file Declaration IEnumerableBatchResult GetThumbnailsBatch(Batch batch, ThumbnailOptions options = null) Parameters Batch batch The batch instance to use. ThumbnailOptions options Optionally specify which thumbnails you need Returns IEnumerableBatchResult < IThumbnail > The requested thumbnails GetThumbnailsBatchAsync(ThumbnailOptions) Returns a list of thumbnails for this file Declaration Task> GetThumbnailsBatchAsync(ThumbnailOptions options = null) Parameters ThumbnailOptions options Optionally specify which thumbnails you need Returns Task < IEnumerableBatchResult < IThumbnail >> The requested thumbnails GetThumbnailsBatchAsync(Batch, ThumbnailOptions) Returns a list of thumbnails for this file Declaration Task> GetThumbnailsBatchAsync(Batch batch, ThumbnailOptions options = null) Parameters Batch batch The batch instance to use. ThumbnailOptions options Optionally specify which thumbnails you need Returns Task < IEnumerableBatchResult < IThumbnail >> The requested thumbnails MoveTo(String, MoveOperations, MoveCopyOptions) Move a file to the destination URL. Declaration void MoveTo(string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null) Parameters String destinationUrl The destination URL including file name. MoveOperations moveOperations combinable flags to indicate the type of move operations. MoveCopyOptions options Options of the move operation. Remarks If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations . MoveToAsync(String, MoveOperations, MoveCopyOptions) Move a file to the destination URL. Declaration Task MoveToAsync(string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null) Parameters String destinationUrl The destination URL including file name. MoveOperations moveOperations combinable flags to indicate the type of move operations. MoveCopyOptions options Options of the move operation. Returns Task Remarks If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations . MoveToBatch(Batch, String, MoveOperations, MoveCopyOptions) Move a file to the destination URL. Declaration void MoveToBatch(Batch batch, string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null) Parameters Batch batch The batch instance to use. String destinationUrl The destination URL including file name. MoveOperations moveOperations combinable flags to indicate the type of move operations. MoveCopyOptions options Options of the move operation. Remarks If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations . MoveToBatch(String, MoveOperations, MoveCopyOptions) Move a file to the destination URL. Declaration void MoveToBatch(string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null) Parameters String destinationUrl The destination URL including file name. MoveOperations moveOperations combinable flags to indicate the type of move operations. MoveCopyOptions options Options of the move operation. Remarks If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations . MoveToBatchAsync(Batch, String, MoveOperations, MoveCopyOptions) Move a file to the destination URL. Declaration Task MoveToBatchAsync(Batch batch, string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null) Parameters Batch batch The batch instance to use. String destinationUrl The destination URL including file name. MoveOperations moveOperations combinable flags to indicate the type of move operations. MoveCopyOptions options Options of the move operation. Returns Task Remarks If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations . MoveToBatchAsync(String, MoveOperations, MoveCopyOptions) Move a file to the destination URL. Declaration Task MoveToBatchAsync(string destinationUrl, MoveOperations moveOperations = default(MoveOperations), MoveCopyOptions options = null) Parameters String destinationUrl The destination URL including file name. MoveOperations moveOperations combinable flags to indicate the type of move operations. MoveCopyOptions options Options of the move operation. Returns Task Remarks If AllowBrokenThickets or BypassSharedLock are used and the move is inside the same site then these are respected but the MoveCopyOptions are not used. For cross site moves the MoveCopyOptions options are always used, if you want to use for example KeepBoth for a move inside the same site then omit the earlier mentioned MoveOperations . Publish(String) Publish a major version of the current file. The comments to add on file publishing. Declaration void Publish(string comment = null) Parameters String comment PublishAsync(String) Publish a major version of the current file. The comments to add on file publishing. Declaration Task PublishAsync(string comment = null) Parameters String comment Returns Task PublishBatch(Batch, String) Publish a major version of the current file. The batch instance to use. The comments to add on file publishing. Declaration void PublishBatch(Batch batch, string comment = null) Parameters Batch batch String comment PublishBatch(String) Publish a major version of the current file. The comments to add on file publishing. Declaration void PublishBatch(string comment = null) Parameters String comment PublishBatchAsync(Batch, String) Publish a major version of the current file. The batch instance to use. The comments to add on file publishing. Declaration Task PublishBatchAsync(Batch batch, string comment = null) Parameters Batch batch String comment Returns Task PublishBatchAsync(String) Publish a major version of the current file. The comments to add on file publishing. Declaration Task PublishBatchAsync(string comment = null) Parameters String comment Returns Task Recycle() Send the file to recycle bin. Declaration Guid Recycle() Returns Guid The Id of the created recycle bin item RecycleAsync() Send the file to recycle bin. Declaration Task RecycleAsync() Returns Task < Guid > The Id of the created recycle bin item RecycleBatch() Send the file to recycle bin. Declaration IBatchSingleResult> RecycleBatch() Returns IBatchSingleResult < BatchResultValue < Guid >> RecycleBatch(Batch) Send the file to recycle bin Declaration IBatchSingleResult> RecycleBatch(Batch batch) Parameters Batch batch The batch instance to use. Returns IBatchSingleResult < BatchResultValue < Guid >> RecycleBatchAsync() Send the file to recycle bin. Declaration Task>> RecycleBatchAsync() Returns Task < IBatchSingleResult < BatchResultValue < Guid >>> RecycleBatchAsync(Batch) Send the file to recycle bin. Declaration Task>> RecycleBatchAsync(Batch batch) Parameters Batch batch The batch instance to use. Returns Task < IBatchSingleResult < BatchResultValue < Guid >>> Rename(String) Renames a file Declaration void Rename(string name) Parameters String name New file name RenameAsync(String) Renames a file Declaration Task RenameAsync(string name) Parameters String name New file name Returns Task UndoCheckout() Release the checked out file without saving the changes. Declaration void UndoCheckout() UndoCheckoutAsync() Release the checked out file without saving the changes. Declaration Task UndoCheckoutAsync() Returns Task UndoCheckoutBatch() Release the checked out file without saving the changes. Declaration void UndoCheckoutBatch() UndoCheckoutBatch(Batch) Release the checked out file without saving the changes. The batch instance to use. Declaration void UndoCheckoutBatch(Batch batch) Parameters Batch batch UndoCheckoutBatchAsync() Release the checked out file without saving the changes. Declaration Task UndoCheckoutBatchAsync() Returns Task UndoCheckoutBatchAsync(Batch) Release the checked out file without saving the changes. The batch instance to use. Declaration Task UndoCheckoutBatchAsync(Batch batch) Parameters Batch batch Returns Task Unpublish(String) Unpublish the latest major version of the current file. The comments to add on file unpublishing. Declaration void Unpublish(string comment = null) Parameters String comment UnpublishAsync(String) Unpublish the latest major version of the current file. The comments to add on file unpublishing. Declaration Task UnpublishAsync(string comment = null) Parameters String comment Returns Task UnpublishBatch(Batch, String) Unpublish the latest major version of the current file. The batch instance to use. The comments to add on file unpublishing. Declaration void UnpublishBatch(Batch batch, string comment = null) Parameters Batch batch String comment UnpublishBatch(String) Unpublish the latest major version of the current file. The comments to add on file unpublishing. Declaration void UnpublishBatch(string comments = null) Parameters String comments UnpublishBatchAsync(Batch, String) Unpublish the latest major version of the current file. The batch instance to use. The comments to add on file unpublishing. Declaration Task UnpublishBatchAsync(Batch batch, string comment = null) Parameters Batch batch String comment Returns Task UnpublishBatchAsync(String) Unpublish the latest major version of the current file. The comments to add on file unpublishing. Declaration Task UnpublishBatchAsync(string comment = null) Parameters String comment Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IFileCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IFileCollection.html", @@ -1912,12 +1912,12 @@ "api/PnP.Core.Model.SharePoint.IFileVersion.html": { "href": "api/PnP.Core.Model.SharePoint.IFileVersion.html", "title": "Interface IFileVersion | PnP Core SDK", - "keywords": "Interface IFileVersion Public interface to define a FileVersion object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IFileVersion : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object CheckInComment Gets a value that specifies the check-in comment. Declaration string CheckInComment { get; } Property Value String Created Gets a value that specifies the creation date and time for the file version. Declaration DateTime Created { get; } Property Value DateTime CreatedBy The ISharePointUser that created this version Declaration ISharePointUser CreatedBy { get; } Property Value ISharePointUser Id Gets the internal identifier for the file version. Declaration int Id { get; } Property Value Int32 IsCurrentVersion Gets a value that specifies whether the file version is the current version. Declaration bool IsCurrentVersion { get; } Property Value Boolean Size Gets the size of this version of the file. Declaration long Size { get; } Property Value Int64 Url Gets a value that specifies the relative URL of the file version based on the URL for the site or subsite. Declaration string Url { get; } Property Value String VersionLabel Gets a value that specifies the implementation specific identifier of the file. Declaration string VersionLabel { get; } Property Value String Methods GetContent(Boolean) Get the content of this file version. Declaration Stream GetContent(bool streamContent = false) Parameters Boolean streamContent Already return the content before all bytes are read, needed for large file downloads Returns Stream Stream containing the binary content of the file GetContentAsync(Boolean) Get the content of this file version. Declaration Task GetContentAsync(bool streamContent = false) Parameters Boolean streamContent Already return the content before all bytes are read, needed for large file downloads Returns Task < Stream > Stream containing the binary content of the file GetContentBytes() Get the content of the file version. Declaration byte[] GetContentBytes() Returns Byte [] The binary content of the file GetContentBytesAsync() Get the content of this file version. Declaration Task GetContentBytesAsync() Returns Task < Byte []> The binary content of the file Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IFileVersion Public interface to define a FileVersion object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IFileVersion : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object CheckInComment Gets a value that specifies the check-in comment. Declaration string CheckInComment { get; } Property Value String Created Gets a value that specifies the creation date and time for the file version. Declaration DateTime Created { get; } Property Value DateTime CreatedBy The ISharePointUser that created this version Declaration ISharePointUser CreatedBy { get; } Property Value ISharePointUser Id Gets the internal identifier for the file version. Declaration int Id { get; } Property Value Int32 IsCurrentVersion Gets a value that specifies whether the file version is the current version. Declaration bool IsCurrentVersion { get; } Property Value Boolean Size Gets the size of this version of the file. Declaration long Size { get; } Property Value Int64 Url Gets a value that specifies the relative URL of the file version based on the URL for the site or subsite. Declaration string Url { get; } Property Value String VersionLabel Gets a value that specifies the implementation specific identifier of the file. Declaration string VersionLabel { get; } Property Value String Methods GetContent(Boolean) Get the content of this file version. Declaration Stream GetContent(bool streamContent = false) Parameters Boolean streamContent Already return the content before all bytes are read, needed for large file downloads Returns Stream Stream containing the binary content of the file GetContentAsync(Boolean) Get the content of this file version. Declaration Task GetContentAsync(bool streamContent = false) Parameters Boolean streamContent Already return the content before all bytes are read, needed for large file downloads Returns Task < Stream > Stream containing the binary content of the file GetContentBytes() Get the content of the file version. Declaration byte[] GetContentBytes() Returns Byte [] The binary content of the file GetContentBytesAsync() Get the content of this file version. Declaration Task GetContentBytesAsync() Returns Task < Byte []> The binary content of the file Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IFileVersionCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IFileVersionCollection.html", "title": "Interface IFileVersionCollection | PnP Core SDK", - "keywords": "Interface IFileVersionCollection Collection of file versions Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() IDataModelCollectionLoad.LoadAsync(Expression>[]) IDataModelCollectionLoad.LoadBatchAsync(Batch, Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IFileVersionCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad, ISupportModules Methods GetById(Int32, Expression>[]) Method to select a file version by Id Declaration IFileVersion GetById(int id, params Expression>[] selectors) Parameters Int32 id The Id to search for Expression < Func < IFileVersion , Object >>[] selectors The expressions declaring the fields to select Returns IFileVersion The resulting file version instance, if any GetByIdAsync(Int32, Expression>[]) Method to select a file version by Id asynchronously Declaration Task GetByIdAsync(int id, params Expression>[] selectors) Parameters Int32 id The Id to search for Expression < Func < IFileVersion , Object >>[] selectors The expressions declaring the fields to select Returns Task < IFileVersion > The resulting file version instance, if any Extension Methods DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.Load(IDataModelCollectionLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" + "keywords": "Interface IFileVersionCollection Collection of file versions Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() IDataModelCollectionLoad.LoadAsync(Expression>[]) IDataModelCollectionLoad.LoadBatchAsync(Batch, Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IFileVersionCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad, ISupportModules Methods GetById(Int32, Expression>[]) Method to select a file version by Id Declaration IFileVersion GetById(int id, params Expression>[] selectors) Parameters Int32 id The Id to search for Expression < Func < IFileVersion , System.Object >>[] selectors The expressions declaring the fields to select Returns IFileVersion The resulting file version instance, if any GetByIdAsync(Int32, Expression>[]) Method to select a file version by Id asynchronously Declaration Task GetByIdAsync(int id, params Expression>[] selectors) Parameters Int32 id The Id to search for Expression < Func < IFileVersion , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < IFileVersion > The resulting file version instance, if any Extension Methods DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.Load(IDataModelCollectionLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" }, "api/PnP.Core.Model.SharePoint.IFileVersionEvent.html": { "href": "api/PnP.Core.Model.SharePoint.IFileVersionEvent.html", @@ -1937,7 +1937,7 @@ "api/PnP.Core.Model.SharePoint.IFolder.html": { "href": "api/PnP.Core.Model.SharePoint.IFolder.html", "title": "Interface IFolder | PnP Core SDK", - "keywords": "Interface IFolder Public interface to define a Folder object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() IDataModelSupportingGetChanges.GetChangesAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChanges(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(ChangeQueryOptions) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IFolder : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IDataModelSupportingGetChanges, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object ContentTypeOrder Default ordered list of content types on a list, before adjustments Declaration IContentTypeIdCollection ContentTypeOrder { get; } Property Value IContentTypeIdCollection Exists Gets whether the folder exists, Declaration bool Exists { get; } Property Value Boolean Files Gets the collection of files contained in the folder Declaration IFileCollection Files { get; } Property Value IFileCollection Folders Gets the collection of list folders contained in the list folder. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFolderCollection Folders { get; } Property Value IFolderCollection IsWOPIEnabled Indicate whether the folder is enabled for WOPI default action. Declaration bool IsWOPIEnabled { get; } Property Value Boolean ItemCount Gets a value that specifies the count of items in the list folder. Declaration int ItemCount { get; } Property Value Int32 ListItemAllFields Gets the list item field values for the list item corresponding to the file. Declaration IListItem ListItemAllFields { get; } Property Value IListItem Name Gets the name of the folder. Declaration string Name { get; } Property Value String ParentFolder Gets the parent list folder of the folder. Declaration IFolder ParentFolder { get; } Property Value IFolder ProgID Gets a string that identifies the application in which the folder was created. Declaration string ProgID { get; } Property Value String Properties Gets the collection of all properties defined for this folder. Declaration IPropertyValues Properties { get; } Property Value IPropertyValues ServerRelativeUrl Gets the server-relative URL of the list folder. Declaration string ServerRelativeUrl { get; } Property Value String StorageMetrics Get the storage metrics of the folder. Declaration IStorageMetrics StorageMetrics { get; } Property Value IStorageMetrics TimeCreated Gets the creation time of the folder. Declaration DateTime TimeCreated { get; } Property Value DateTime TimeLastModified Gets the last modification time of the folder. Declaration DateTime TimeLastModified { get; } Property Value DateTime UniqueContentTypeOrder Ordered list of content types on a list: controls order of items in the \"New\" menu and \"List Settings\" page Declaration IContentTypeIdCollection UniqueContentTypeOrder { get; } Property Value IContentTypeIdCollection UniqueId Gets the Unique Id of the folder. Declaration Guid UniqueId { get; } Property Value Guid WelcomePage Gets or sets a value that specifies folder-relative URL for the list folder welcome page. Declaration string WelcomePage { get; set; } Property Value String Methods AddFolder(String) Add a folder to the current folder. Declaration IFolder AddFolder(string name) Parameters String name The name of the folder to add. Returns IFolder The added folder. AddFolderAsync(String) Add a folder to the current folder. Declaration Task AddFolderAsync(string name) Parameters String name The name of the folder to add. Returns Task < IFolder > The added folder. AddFolderBatch(Batch, String) Add a folder to the current folder via batch. Declaration IFolder AddFolderBatch(Batch batch, string name) Parameters Batch batch Batch to add the reques to String name The name of the folder to add. Returns IFolder The added folder. AddFolderBatch(String) Add a folder to the current folder via batch. Declaration IFolder AddFolderBatch(string name) Parameters String name The name of the folder to add. Returns IFolder The added folder. AddFolderBatchAsync(Batch, String) Add a folder to the current folder via batch. Declaration Task AddFolderBatchAsync(Batch batch, string name) Parameters Batch batch Batch to add the reques to String name The name of the folder to add. Returns Task < IFolder > The added folder. AddFolderBatchAsync(String) Add a folder to the current folder via batch. Declaration Task AddFolderBatchAsync(string name) Parameters String name The name of the folder to add. Returns Task < IFolder > The added folder. ClassifyAndExtractOffPeak() Classifies and extracts all unprocessed files in this folder and it's sub folders via the Syntex off-peak queue Declaration ISyntexClassifyAndExtractResult ClassifyAndExtractOffPeak() Returns ISyntexClassifyAndExtractResult Information about the created classify and extract requests ClassifyAndExtractOffPeakAsync() Classifies and extracts all unprocessed files in this folder and it's sub folders via the Syntex off-peak queue Declaration Task ClassifyAndExtractOffPeakAsync() Returns Task < ISyntexClassifyAndExtractResult > Information about the created classify and extract requests CopyTo(String, MoveCopyOptions) Copies a folder to the destination URL. Declaration void CopyTo(string destinationUrl, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL. MoveCopyOptions options options of the copy operation. CopyToAsync(String, MoveCopyOptions) Copies a folder to the destination URL. Declaration Task CopyToAsync(string destinationUrl, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL. MoveCopyOptions options options of the copy operation. Returns Task CopyToBatch(Batch, String, MoveCopyOptions) Copies a folder to the destination URL. Declaration void CopyToBatch(Batch batch, string destinationUrl, MoveCopyOptions options = null) Parameters Batch batch The batch instance to use. String destinationUrl The destination URL. MoveCopyOptions options options of the copy operation. CopyToBatch(String, MoveCopyOptions) Copies a folder to the destination URL. Declaration void CopyToBatch(string destinationUrl, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL. MoveCopyOptions options options of the copy operation. CopyToBatchAsync(Batch, String, MoveCopyOptions) Copies a folder to the destination URL. Declaration Task CopyToBatchAsync(Batch batch, string destinationUrl, MoveCopyOptions options = null) Parameters Batch batch The batch instance to use. String destinationUrl The destination URL. MoveCopyOptions options options of the copy operation. Returns Task CopyToBatchAsync(String, MoveCopyOptions) Copies a folder to the destination URL. Declaration Task CopyToBatchAsync(string destinationUrl, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL. MoveCopyOptions options options of the copy operation. Returns Task CreateAnonymousSharingLink(AnonymousLinkOptions) Creates an anonymous sharing link for a file Declaration IGraphPermission CreateAnonymousSharingLink(AnonymousLinkOptions anonymousLinkOptions) Parameters AnonymousLinkOptions anonymousLinkOptions Returns IGraphPermission Permission that has been created CreateAnonymousSharingLinkAsync(AnonymousLinkOptions) Creates an anonymous sharing link for a file Declaration Task CreateAnonymousSharingLinkAsync(AnonymousLinkOptions anonymousLinkOptions) Parameters AnonymousLinkOptions anonymousLinkOptions Returns Task < IGraphPermission > Permission that has been created CreateOrganizationalSharingLink(OrganizationalLinkOptions) Creates an organization sharing link for a file Declaration IGraphPermission CreateOrganizationalSharingLink(OrganizationalLinkOptions organizationalLinkOptions) Parameters OrganizationalLinkOptions organizationalLinkOptions Returns IGraphPermission Permission that has been created CreateOrganizationalSharingLinkAsync(OrganizationalLinkOptions) Creates an organization sharing link for a file Declaration Task CreateOrganizationalSharingLinkAsync(OrganizationalLinkOptions organizationalLinkOptions) Parameters OrganizationalLinkOptions organizationalLinkOptions Returns Task < IGraphPermission > Permission that has been created CreateSharingInvite(InviteOptions) Creates a sharing invite to a specific user Declaration IGraphPermission CreateSharingInvite(InviteOptions inviteOptions) Parameters InviteOptions inviteOptions Returns IGraphPermission Permission that has been created CreateSharingInviteAsync(InviteOptions) Creates a sharing invite to a specific user Declaration Task CreateSharingInviteAsync(InviteOptions inviteOptions) Parameters InviteOptions inviteOptions Returns Task < IGraphPermission > Permission that has been created CreateUserSharingLink(UserLinkOptions) Creates a user sharing link for a file Declaration IGraphPermission CreateUserSharingLink(UserLinkOptions userLinkOptions) Parameters UserLinkOptions userLinkOptions Returns IGraphPermission Permission that has been created CreateUserSharingLinkAsync(UserLinkOptions) Creates a user sharing link for a file Declaration Task CreateUserSharingLinkAsync(UserLinkOptions userLinkOptions) Parameters UserLinkOptions userLinkOptions Returns Task < IGraphPermission > Permission that has been created DeleteShareLinks() Deletes the share links on the file item Declaration void DeleteShareLinks() DeleteShareLinksAsync() Deletes the share links on the file item Declaration Task DeleteShareLinksAsync() Returns Task EnsureFolder(String) Ensures a (hiarchy) of folders exists on a given folder Declaration IFolder EnsureFolder(string folderRelativeUrl) Parameters String folderRelativeUrl a (hiarchy) of folders (e.g. folderA/folderB/FolderC) Returns IFolder The IFolder representing the final folder in the hiarchy (e.g. FolderC) EnsureFolderAsync(String) Ensures a (hiarchy) of folders exists on a given folder Declaration Task EnsureFolderAsync(string folderRelativeUrl) Parameters String folderRelativeUrl a (hiarchy) of folders (e.g. folderA/folderB/FolderC) Returns Task < IFolder > The IFolder representing the final folder in the hiarchy (e.g. FolderC) FindFiles(String) Find files in the folder, can be slow as it iterates over all the files in the folder and it's sub folders. If performance is key, then try using a search based solution Declaration List FindFiles(string match) Parameters String match Returns PnP.Core.Model.SharePoint.List < IFile > A of found files as type IFile FindFilesAsync(String) Find files in the folder, can be slow as it iterates over all the files in the folder and it's sub folders. If performance is key, then try using a search based solution Declaration Task> FindFilesAsync(string match) Parameters String match Returns Task < PnP.Core.Model.SharePoint.List < IFile >> A of found files as type IFile GetShareLinks() Gets the share links on the file item Declaration IGraphPermissionCollection GetShareLinks() Returns IGraphPermissionCollection Collection of share links existing on the file GetShareLinksAsync() Gets the share links on the file item Declaration Task GetShareLinksAsync() Returns Task < IGraphPermissionCollection > Collection of share links existing on the file MoveTo(String, MoveCopyOptions) Moves a folder to the destination URL. Declaration void MoveTo(string destinationUrl, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL. MoveCopyOptions options options of the move operation. MoveToAsync(String, MoveCopyOptions) Moves a folder to the destination URL. Declaration Task MoveToAsync(string destinationUrl, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL. MoveCopyOptions options options of the move operation. Returns Task MoveToBatch(Batch, String, MoveCopyOptions) Moves a folder to the destination URL. Declaration void MoveToBatch(Batch batch, string destinationUrl, MoveCopyOptions options = null) Parameters Batch batch The batch instance to use. String destinationUrl The destination URL. MoveCopyOptions options options of the move operation. MoveToBatch(String, MoveCopyOptions) Moves a folder to the destination URL. Declaration void MoveToBatch(string destinationUrl, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL. MoveCopyOptions options options of the move operation. MoveToBatchAsync(Batch, String, MoveCopyOptions) Moves a folder to the destination URL. Declaration Task MoveToBatchAsync(Batch batch, string destinationUrl, MoveCopyOptions options = null) Parameters Batch batch The batch instance to use. String destinationUrl The destination URL. MoveCopyOptions options options of the move operation. Returns Task MoveToBatchAsync(String, MoveCopyOptions) Moves a folder to the destination URL. Declaration Task MoveToBatchAsync(string destinationUrl, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL. MoveCopyOptions options options of the move operation. Returns Task Rename(String) Renames a folder Declaration void Rename(string name) Parameters String name New folder name RenameAsync(String) Renames a folder Declaration Task RenameAsync(string name) Parameters String name New folder name Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IFolder Public interface to define a Folder object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() IDataModelSupportingGetChanges.GetChangesAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChanges(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(ChangeQueryOptions) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IFolder : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IDataModelSupportingGetChanges, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object ContentTypeOrder Default ordered list of content types on a list, before adjustments Declaration IContentTypeIdCollection ContentTypeOrder { get; } Property Value IContentTypeIdCollection Exists Gets whether the folder exists, Declaration bool Exists { get; } Property Value Boolean Files Gets the collection of files contained in the folder Declaration IFileCollection Files { get; } Property Value IFileCollection Folders Gets the collection of list folders contained in the list folder. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFolderCollection Folders { get; } Property Value IFolderCollection IsWOPIEnabled Indicate whether the folder is enabled for WOPI default action. Declaration bool IsWOPIEnabled { get; } Property Value Boolean ItemCount Gets a value that specifies the count of items in the list folder. Declaration int ItemCount { get; } Property Value Int32 ListItemAllFields Gets the list item field values for the list item corresponding to the file. Declaration IListItem ListItemAllFields { get; } Property Value IListItem Name Gets the name of the folder. Declaration string Name { get; } Property Value String ParentFolder Gets the parent list folder of the folder. Declaration IFolder ParentFolder { get; } Property Value IFolder ProgID Gets a string that identifies the application in which the folder was created. Declaration string ProgID { get; } Property Value String Properties Gets the collection of all properties defined for this folder. Declaration IPropertyValues Properties { get; } Property Value IPropertyValues ServerRelativeUrl Gets the server-relative URL of the list folder. Declaration string ServerRelativeUrl { get; } Property Value String StorageMetrics Get the storage metrics of the folder. Declaration IStorageMetrics StorageMetrics { get; } Property Value IStorageMetrics TimeCreated Gets the creation time of the folder. Declaration DateTime TimeCreated { get; } Property Value DateTime TimeLastModified Gets the last modification time of the folder. Declaration DateTime TimeLastModified { get; } Property Value DateTime UniqueContentTypeOrder Ordered list of content types on a list: controls order of items in the \"New\" menu and \"List Settings\" page Declaration IContentTypeIdCollection UniqueContentTypeOrder { get; } Property Value IContentTypeIdCollection UniqueId Gets the Unique Id of the folder. Declaration Guid UniqueId { get; } Property Value Guid WelcomePage Gets or sets a value that specifies folder-relative URL for the list folder welcome page. Declaration string WelcomePage { get; set; } Property Value String Methods AddFolder(String) Add a folder to the current folder. Declaration IFolder AddFolder(string name) Parameters String name The name of the folder to add. Returns IFolder The added folder. AddFolderAsync(String) Add a folder to the current folder. Declaration Task AddFolderAsync(string name) Parameters String name The name of the folder to add. Returns Task < IFolder > The added folder. AddFolderBatch(Batch, String) Add a folder to the current folder via batch. Declaration IFolder AddFolderBatch(Batch batch, string name) Parameters Batch batch Batch to add the reques to String name The name of the folder to add. Returns IFolder The added folder. AddFolderBatch(String) Add a folder to the current folder via batch. Declaration IFolder AddFolderBatch(string name) Parameters String name The name of the folder to add. Returns IFolder The added folder. AddFolderBatchAsync(Batch, String) Add a folder to the current folder via batch. Declaration Task AddFolderBatchAsync(Batch batch, string name) Parameters Batch batch Batch to add the reques to String name The name of the folder to add. Returns Task < IFolder > The added folder. AddFolderBatchAsync(String) Add a folder to the current folder via batch. Declaration Task AddFolderBatchAsync(string name) Parameters String name The name of the folder to add. Returns Task < IFolder > The added folder. ClassifyAndExtractOffPeak() Classifies and extracts all unprocessed files in this folder and it's sub folders via the Syntex off-peak queue Declaration ISyntexClassifyAndExtractResult ClassifyAndExtractOffPeak() Returns ISyntexClassifyAndExtractResult Information about the created classify and extract requests ClassifyAndExtractOffPeakAsync() Classifies and extracts all unprocessed files in this folder and it's sub folders via the Syntex off-peak queue Declaration Task ClassifyAndExtractOffPeakAsync() Returns Task < ISyntexClassifyAndExtractResult > Information about the created classify and extract requests CopyTo(String, MoveCopyOptions) Copies a folder to the destination URL. Declaration void CopyTo(string destinationUrl, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL. MoveCopyOptions options options of the copy operation. CopyToAsync(String, MoveCopyOptions) Copies a folder to the destination URL. Declaration Task CopyToAsync(string destinationUrl, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL. MoveCopyOptions options options of the copy operation. Returns Task CopyToBatch(Batch, String, MoveCopyOptions) Copies a folder to the destination URL. Declaration void CopyToBatch(Batch batch, string destinationUrl, MoveCopyOptions options = null) Parameters Batch batch The batch instance to use. String destinationUrl The destination URL. MoveCopyOptions options options of the copy operation. CopyToBatch(String, MoveCopyOptions) Copies a folder to the destination URL. Declaration void CopyToBatch(string destinationUrl, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL. MoveCopyOptions options options of the copy operation. CopyToBatchAsync(Batch, String, MoveCopyOptions) Copies a folder to the destination URL. Declaration Task CopyToBatchAsync(Batch batch, string destinationUrl, MoveCopyOptions options = null) Parameters Batch batch The batch instance to use. String destinationUrl The destination URL. MoveCopyOptions options options of the copy operation. Returns Task CopyToBatchAsync(String, MoveCopyOptions) Copies a folder to the destination URL. Declaration Task CopyToBatchAsync(string destinationUrl, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL. MoveCopyOptions options options of the copy operation. Returns Task CreateAnonymousSharingLink(AnonymousLinkOptions) Creates an anonymous sharing link for a file Declaration IGraphPermission CreateAnonymousSharingLink(AnonymousLinkOptions anonymousLinkOptions) Parameters AnonymousLinkOptions anonymousLinkOptions Returns IGraphPermission Permission that has been created CreateAnonymousSharingLinkAsync(AnonymousLinkOptions) Creates an anonymous sharing link for a file Declaration Task CreateAnonymousSharingLinkAsync(AnonymousLinkOptions anonymousLinkOptions) Parameters AnonymousLinkOptions anonymousLinkOptions Returns Task < IGraphPermission > Permission that has been created CreateOrganizationalSharingLink(OrganizationalLinkOptions) Creates an organization sharing link for a file Declaration IGraphPermission CreateOrganizationalSharingLink(OrganizationalLinkOptions organizationalLinkOptions) Parameters OrganizationalLinkOptions organizationalLinkOptions Returns IGraphPermission Permission that has been created CreateOrganizationalSharingLinkAsync(OrganizationalLinkOptions) Creates an organization sharing link for a file Declaration Task CreateOrganizationalSharingLinkAsync(OrganizationalLinkOptions organizationalLinkOptions) Parameters OrganizationalLinkOptions organizationalLinkOptions Returns Task < IGraphPermission > Permission that has been created CreateSharingInvite(InviteOptions) Creates a sharing invite to a specific user Declaration IGraphPermission CreateSharingInvite(InviteOptions inviteOptions) Parameters InviteOptions inviteOptions Returns IGraphPermission Permission that has been created CreateSharingInviteAsync(InviteOptions) Creates a sharing invite to a specific user Declaration Task CreateSharingInviteAsync(InviteOptions inviteOptions) Parameters InviteOptions inviteOptions Returns Task < IGraphPermission > Permission that has been created CreateUserSharingLink(UserLinkOptions) Creates a user sharing link for a file Declaration IGraphPermission CreateUserSharingLink(UserLinkOptions userLinkOptions) Parameters UserLinkOptions userLinkOptions Returns IGraphPermission Permission that has been created CreateUserSharingLinkAsync(UserLinkOptions) Creates a user sharing link for a file Declaration Task CreateUserSharingLinkAsync(UserLinkOptions userLinkOptions) Parameters UserLinkOptions userLinkOptions Returns Task < IGraphPermission > Permission that has been created DeleteShareLinks() Deletes the share links on the file item Declaration void DeleteShareLinks() DeleteShareLinksAsync() Deletes the share links on the file item Declaration Task DeleteShareLinksAsync() Returns Task EnsureFolder(String) Ensures a (hiarchy) of folders exists on a given folder Declaration IFolder EnsureFolder(string folderRelativeUrl) Parameters String folderRelativeUrl a (hiarchy) of folders (e.g. folderA/folderB/FolderC) Returns IFolder The IFolder representing the final folder in the hiarchy (e.g. FolderC) EnsureFolderAsync(String) Ensures a (hiarchy) of folders exists on a given folder Declaration Task EnsureFolderAsync(string folderRelativeUrl) Parameters String folderRelativeUrl a (hiarchy) of folders (e.g. folderA/folderB/FolderC) Returns Task < IFolder > The IFolder representing the final folder in the hiarchy (e.g. FolderC) FindFiles(String) Find files in the folder, can be slow as it iterates over all the files in the folder and it's sub folders. If performance is key, then try using a search based solution Declaration List FindFiles(string match) Parameters String match Returns PnP.Core.Model.SharePoint.List < IFile > A of found files as type IFile FindFilesAsync(String) Find files in the folder, can be slow as it iterates over all the files in the folder and it's sub folders. If performance is key, then try using a search based solution Declaration Task> FindFilesAsync(string match) Parameters String match Returns Task < PnP.Core.Model.SharePoint.List < IFile >> A of found files as type IFile GetShareLinks() Gets the share links on the file item Declaration IGraphPermissionCollection GetShareLinks() Returns IGraphPermissionCollection Collection of share links existing on the file GetShareLinksAsync() Gets the share links on the file item Declaration Task GetShareLinksAsync() Returns Task < IGraphPermissionCollection > Collection of share links existing on the file MoveTo(String, MoveCopyOptions) Moves a folder to the destination URL. Declaration void MoveTo(string destinationUrl, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL. MoveCopyOptions options options of the move operation. MoveToAsync(String, MoveCopyOptions) Moves a folder to the destination URL. Declaration Task MoveToAsync(string destinationUrl, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL. MoveCopyOptions options options of the move operation. Returns Task MoveToBatch(Batch, String, MoveCopyOptions) Moves a folder to the destination URL. Declaration void MoveToBatch(Batch batch, string destinationUrl, MoveCopyOptions options = null) Parameters Batch batch The batch instance to use. String destinationUrl The destination URL. MoveCopyOptions options options of the move operation. MoveToBatch(String, MoveCopyOptions) Moves a folder to the destination URL. Declaration void MoveToBatch(string destinationUrl, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL. MoveCopyOptions options options of the move operation. MoveToBatchAsync(Batch, String, MoveCopyOptions) Moves a folder to the destination URL. Declaration Task MoveToBatchAsync(Batch batch, string destinationUrl, MoveCopyOptions options = null) Parameters Batch batch The batch instance to use. String destinationUrl The destination URL. MoveCopyOptions options options of the move operation. Returns Task MoveToBatchAsync(String, MoveCopyOptions) Moves a folder to the destination URL. Declaration Task MoveToBatchAsync(string destinationUrl, MoveCopyOptions options = null) Parameters String destinationUrl The destination URL. MoveCopyOptions options options of the move operation. Returns Task Rename(String) Renames a folder Declaration void Rename(string name) Parameters String name New folder name RenameAsync(String) Renames a folder Declaration Task RenameAsync(string name) Parameters String name New folder name Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IFolderCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IFolderCollection.html", @@ -1947,7 +1947,7 @@ "api/PnP.Core.Model.SharePoint.IFollowing.html": { "href": "api/PnP.Core.Model.SharePoint.IFollowing.html", "title": "Interface IFollowing | PnP Core SDK", - "keywords": "Interface IFollowing An entry point to the social following APIs Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IFollowing : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules Methods AmIFollowedBy(String) Checks whether the specified user is following the current user. Declaration bool AmIFollowedBy(string accountName) Parameters String accountName The account name of the user, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Returns Boolean True if the specified user follows the current user AmIFollowedByAsync(String) Checks whether the specified user is following the current user. Declaration Task AmIFollowedByAsync(string accountName) Parameters String accountName The account name of the user, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Returns Task < Boolean > True if the specified user follows the current user AmIFollowing(String) Checks whether the current user is following the specified user. Declaration bool AmIFollowing(string accountName) Parameters String accountName The account name of the user, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Returns Boolean True if the current user follows the specified user AmIFollowingAsync(String) Checks whether the current user is following the specified user. Declaration Task AmIFollowingAsync(string accountName) Parameters String accountName The account name of the user, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Returns Task < Boolean > True if the current user follows the specified user Follow(FollowData) Makes the current user start following a user, document, site, or tag. Declaration SocialFollowResult Follow(FollowData data) Parameters FollowData data Depending on what entity your're going to follow, can be an instance of FollowTagData , FollowDocumentData , FollowPersonData or FollowSiteData Returns SocialFollowResult A result, the follow status or an error FollowAsync(FollowData) Makes the current user start following a user, document, site, or tag. Declaration Task FollowAsync(FollowData data) Parameters FollowData data Depending on what entity your're going to follow, can be an instance of FollowTagData , FollowDocumentData , FollowPersonData or FollowSiteData Returns Task < SocialFollowResult > A result, the follow status or an error FollowedByMe(SocialActorTypes) Gets users, documents, sites, and tags that the current user is following. Declaration IList FollowedByMe(SocialActorTypes types) Parameters SocialActorTypes types The actor type to include. You can include many actory using bitwise operatoins. I.e. to include document and site types use SocialActorTypes.Documents | SocialActorTypes.Sites Returns PnP.Core.Model.SharePoint.IList < ISocialActor > A collection of ISocialActor FollowedByMeAsync(SocialActorTypes) Gets users, documents, sites, and tags that the current user is following. Declaration Task> FollowedByMeAsync(SocialActorTypes types) Parameters SocialActorTypes types The actor type to include. You can include many actory using bitwise operatoins. I.e. to include document and site types use SocialActorTypes.Documents | SocialActorTypes.Sites Returns Task < PnP.Core.Model.SharePoint.IList < ISocialActor >> A collection of ISocialActor FollowedByMeCount(SocialActorTypes) Gets the count of users, documents, sites, and tags that the current user is following. Declaration int FollowedByMeCount(SocialActorTypes types) Parameters SocialActorTypes types The actor type to include. You can include many actory using bitwise operatoins. I.e. to include document and site types use SocialActorTypes.Documents | SocialActorTypes.Sites Returns Int32 The number of followed items FollowedByMeCountAsync(SocialActorTypes) Gets the count of users, documents, sites, and tags that the current user is following. Declaration Task FollowedByMeCountAsync(SocialActorTypes types) Parameters SocialActorTypes types The actor type to include. You can include many actory using bitwise operatoins. I.e. to include document and site types use SocialActorTypes.Documents | SocialActorTypes.Sites Returns Task < Int32 > The number of followed items GetFollowersFor(String, Expression>[]) Gets the people who are following the specified user. Declaration IList GetFollowersFor(string accountName, params Expression>[] selectors) Parameters String accountName The account name of the user, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Expression < Func < IPersonProperties , Object >>[] selectors Specific properties to return Returns PnP.Core.Model.SharePoint.IList < IPersonProperties > An instance of IPersonProperties GetFollowersForAsync(String, Expression>[]) Gets the people who are following the specified user. Declaration Task> GetFollowersForAsync(string accountName, params Expression>[] selectors) Parameters String accountName The account name of the user, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Expression < Func < IPersonProperties , Object >>[] selectors Specific properties to return Returns Task < PnP.Core.Model.SharePoint.IList < IPersonProperties >> An instance of IPersonProperties GetFollowingInfo() Gets following information for the current user Declaration IFollowingInfo GetFollowingInfo() Returns IFollowingInfo An instance of IFollowingInfo GetFollowingInfoAsync() Gets following information for the current user Declaration Task GetFollowingInfoAsync() Returns Task < IFollowingInfo > An instance of IFollowingInfo GetPeopleFollowedBy(String, Expression>[]) Gets the people who the specified user is following. Declaration IList GetPeopleFollowedBy(string accountName, params Expression>[] selectors) Parameters String accountName The account name of the user, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Expression < Func < IPersonProperties , Object >>[] selectors Specific properties to return Returns PnP.Core.Model.SharePoint.IList < IPersonProperties > An instance of IPersonProperties GetPeopleFollowedByAsync(String, Expression>[]) Gets the people who the specified user is following. Declaration Task> GetPeopleFollowedByAsync(string accountName, params Expression>[] selectors) Parameters String accountName The account name of the user, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Expression < Func < IPersonProperties , Object >>[] selectors Specific properties to return Returns Task < PnP.Core.Model.SharePoint.IList < IPersonProperties >> An instance of IPersonProperties IsFollowed(FollowData) Indicates whether the current user is following a specified user, document, site, or tag. Declaration bool IsFollowed(FollowData data) Parameters FollowData data Depending on what entity your're going to stop following, can be an instance of FollowTagData , FollowDocumentData , FollowPersonData or FollowSiteData Returns Boolean True if the current user is following a specified user, document, site, or tag. IsFollowedAsync(FollowData) Indicates whether the current user is following a specified user, document, site, or tag. Declaration Task IsFollowedAsync(FollowData data) Parameters FollowData data Depending on what entity your're going to stop following, can be an instance of FollowTagData , FollowDocumentData , FollowPersonData or FollowSiteData Returns Task < Boolean > True if the current user is following a specified user, document, site, or tag. MyFollowers() Gets the users who are following the current user. Declaration IList MyFollowers() Returns PnP.Core.Model.SharePoint.IList < ISocialActor > A collection of ISocialActor MyFollowersAsync() Gets the users who are following the current user. Declaration Task> MyFollowersAsync() Returns Task < PnP.Core.Model.SharePoint.IList < ISocialActor >> A collection of ISocialActor MySuggestions() Gets users who the current user might want to follow. Declaration IList MySuggestions() Returns PnP.Core.Model.SharePoint.IList < ISocialActor > A collection of ISocialActor MySuggestionsAsync() Gets users who the current user might want to follow. Declaration Task> MySuggestionsAsync() Returns Task < PnP.Core.Model.SharePoint.IList < ISocialActor >> A collection of ISocialActor StopFollowing(FollowData) Makes the current user stop following a user, document, site, or tag. Declaration void StopFollowing(FollowData data) Parameters FollowData data Depending on what entity your're going to stop following, can be an instance of FollowTagData , FollowDocumentData , FollowPersonData or FollowSiteData StopFollowingAsync(FollowData) Makes the current user stop following a user, document, site, or tag. Declaration Task StopFollowingAsync(FollowData data) Parameters FollowData data Depending on what entity your're going to stop following, can be an instance of FollowTagData , FollowDocumentData , FollowPersonData or FollowSiteData Returns Task Extension Methods RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IFollowing An entry point to the social following APIs Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IFollowing : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules Methods AmIFollowedBy(String) Checks whether the specified user is following the current user. Declaration bool AmIFollowedBy(string accountName) Parameters String accountName The account name of the user, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Returns Boolean True if the specified user follows the current user AmIFollowedByAsync(String) Checks whether the specified user is following the current user. Declaration Task AmIFollowedByAsync(string accountName) Parameters String accountName The account name of the user, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Returns Task < Boolean > True if the specified user follows the current user AmIFollowing(String) Checks whether the current user is following the specified user. Declaration bool AmIFollowing(string accountName) Parameters String accountName The account name of the user, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Returns Boolean True if the current user follows the specified user AmIFollowingAsync(String) Checks whether the current user is following the specified user. Declaration Task AmIFollowingAsync(string accountName) Parameters String accountName The account name of the user, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Returns Task < Boolean > True if the current user follows the specified user Follow(FollowData) Makes the current user start following a user, document, site, or tag. Declaration SocialFollowResult Follow(FollowData data) Parameters FollowData data Depending on what entity your're going to follow, can be an instance of FollowTagData , FollowDocumentData , FollowPersonData or FollowSiteData Returns SocialFollowResult A result, the follow status or an error FollowAsync(FollowData) Makes the current user start following a user, document, site, or tag. Declaration Task FollowAsync(FollowData data) Parameters FollowData data Depending on what entity your're going to follow, can be an instance of FollowTagData , FollowDocumentData , FollowPersonData or FollowSiteData Returns Task < SocialFollowResult > A result, the follow status or an error FollowedByMe(SocialActorTypes) Gets users, documents, sites, and tags that the current user is following. Declaration IList FollowedByMe(SocialActorTypes types) Parameters SocialActorTypes types The actor type to include. You can include many actory using bitwise operatoins. I.e. to include document and site types use SocialActorTypes.Documents | SocialActorTypes.Sites Returns PnP.Core.Model.SharePoint.IList < ISocialActor > A collection of ISocialActor FollowedByMeAsync(SocialActorTypes) Gets users, documents, sites, and tags that the current user is following. Declaration Task> FollowedByMeAsync(SocialActorTypes types) Parameters SocialActorTypes types The actor type to include. You can include many actory using bitwise operatoins. I.e. to include document and site types use SocialActorTypes.Documents | SocialActorTypes.Sites Returns Task < PnP.Core.Model.SharePoint.IList < ISocialActor >> A collection of ISocialActor FollowedByMeCount(SocialActorTypes) Gets the count of users, documents, sites, and tags that the current user is following. Declaration int FollowedByMeCount(SocialActorTypes types) Parameters SocialActorTypes types The actor type to include. You can include many actory using bitwise operatoins. I.e. to include document and site types use SocialActorTypes.Documents | SocialActorTypes.Sites Returns Int32 The number of followed items FollowedByMeCountAsync(SocialActorTypes) Gets the count of users, documents, sites, and tags that the current user is following. Declaration Task FollowedByMeCountAsync(SocialActorTypes types) Parameters SocialActorTypes types The actor type to include. You can include many actory using bitwise operatoins. I.e. to include document and site types use SocialActorTypes.Documents | SocialActorTypes.Sites Returns Task < Int32 > The number of followed items GetFollowersFor(String, Expression>[]) Gets the people who are following the specified user. Declaration IList GetFollowersFor(string accountName, params Expression>[] selectors) Parameters String accountName The account name of the user, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Expression < Func < IPersonProperties , System.Object >>[] selectors Specific properties to return Returns PnP.Core.Model.SharePoint.IList < IPersonProperties > An instance of IPersonProperties GetFollowersForAsync(String, Expression>[]) Gets the people who are following the specified user. Declaration Task> GetFollowersForAsync(string accountName, params Expression>[] selectors) Parameters String accountName The account name of the user, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Expression < Func < IPersonProperties , System.Object >>[] selectors Specific properties to return Returns Task < PnP.Core.Model.SharePoint.IList < IPersonProperties >> An instance of IPersonProperties GetFollowingInfo() Gets following information for the current user Declaration IFollowingInfo GetFollowingInfo() Returns IFollowingInfo An instance of IFollowingInfo GetFollowingInfoAsync() Gets following information for the current user Declaration Task GetFollowingInfoAsync() Returns Task < IFollowingInfo > An instance of IFollowingInfo GetPeopleFollowedBy(String, Expression>[]) Gets the people who the specified user is following. Declaration IList GetPeopleFollowedBy(string accountName, params Expression>[] selectors) Parameters String accountName The account name of the user, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Expression < Func < IPersonProperties , System.Object >>[] selectors Specific properties to return Returns PnP.Core.Model.SharePoint.IList < IPersonProperties > An instance of IPersonProperties GetPeopleFollowedByAsync(String, Expression>[]) Gets the people who the specified user is following. Declaration Task> GetPeopleFollowedByAsync(string accountName, params Expression>[] selectors) Parameters String accountName The account name of the user, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Expression < Func < IPersonProperties , System.Object >>[] selectors Specific properties to return Returns Task < PnP.Core.Model.SharePoint.IList < IPersonProperties >> An instance of IPersonProperties IsFollowed(FollowData) Indicates whether the current user is following a specified user, document, site, or tag. Declaration bool IsFollowed(FollowData data) Parameters FollowData data Depending on what entity your're going to stop following, can be an instance of FollowTagData , FollowDocumentData , FollowPersonData or FollowSiteData Returns Boolean True if the current user is following a specified user, document, site, or tag. IsFollowedAsync(FollowData) Indicates whether the current user is following a specified user, document, site, or tag. Declaration Task IsFollowedAsync(FollowData data) Parameters FollowData data Depending on what entity your're going to stop following, can be an instance of FollowTagData , FollowDocumentData , FollowPersonData or FollowSiteData Returns Task < Boolean > True if the current user is following a specified user, document, site, or tag. MyFollowers() Gets the users who are following the current user. Declaration IList MyFollowers() Returns PnP.Core.Model.SharePoint.IList < ISocialActor > A collection of ISocialActor MyFollowersAsync() Gets the users who are following the current user. Declaration Task> MyFollowersAsync() Returns Task < PnP.Core.Model.SharePoint.IList < ISocialActor >> A collection of ISocialActor MySuggestions() Gets users who the current user might want to follow. Declaration IList MySuggestions() Returns PnP.Core.Model.SharePoint.IList < ISocialActor > A collection of ISocialActor MySuggestionsAsync() Gets users who the current user might want to follow. Declaration Task> MySuggestionsAsync() Returns Task < PnP.Core.Model.SharePoint.IList < ISocialActor >> A collection of ISocialActor StopFollowing(FollowData) Makes the current user stop following a user, document, site, or tag. Declaration void StopFollowing(FollowData data) Parameters FollowData data Depending on what entity your're going to stop following, can be an instance of FollowTagData , FollowDocumentData , FollowPersonData or FollowSiteData StopFollowingAsync(FollowData) Makes the current user stop following a user, document, site, or tag. Declaration Task StopFollowingAsync(FollowData data) Parameters FollowData data Depending on what entity your're going to stop following, can be an instance of FollowTagData , FollowDocumentData , FollowPersonData or FollowSiteData Returns Task Extension Methods RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IFollowingInfo.html": { "href": "api/PnP.Core.Model.SharePoint.IFollowingInfo.html", @@ -1967,7 +1967,7 @@ "api/PnP.Core.Model.SharePoint.IHubSite.html": { "href": "api/PnP.Core.Model.SharePoint.IHubSite.html", "title": "Interface IHubSite | PnP Core SDK", - "keywords": "Interface IHubSite Public interface to define a HubSite object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IHubSite : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object Description The description of the HubSite. Declaration string Description { get; set; } Property Value String EnablePermissionsSync Gets or sets if permission sync to associated sites is enabled or not. Declaration bool EnablePermissionsSync { get; set; } Property Value Boolean EnforcedECTs Gets or sets the list of Enforced ECTs on the HubSite Declaration string EnforcedECTs { get; set; } Property Value String EnforcedECTsVersion Gets or sets EnforcedECTs version Declaration int EnforcedECTsVersion { get; set; } Property Value Int32 HideNameInNavigation Gets or sets if the HubSite nav includes the name as well as the logo. Declaration bool HideNameInNavigation { get; set; } Property Value Boolean Id The HubSite ID Declaration Guid Id { get; } Property Value Guid LogoUrl The logo URL of the HubSite Declaration string LogoUrl { get; set; } Property Value String ParentHubSiteId The parent hub site id to which this hub connects Declaration Guid ParentHubSiteId { get; set; } Property Value Guid PermissionsSyncTag Hub permissions sync tag Declaration int PermissionsSyncTag { get; } Property Value Int32 RequiresJoinApproval Gets or sets if the HubSite Join requires approval. Declaration bool RequiresJoinApproval { get; set; } Property Value Boolean SiteDesignId The site design to be executed when the hub is joined. Declaration Guid SiteDesignId { get; set; } Property Value Guid SiteId The Site Collection ID of the HubSite Declaration Guid SiteId { get; } Property Value Guid SiteUrl The URL of the HubSite Declaration string SiteUrl { get; } Property Value String Targets List of security groups with access to join the HubSite. Null if everyone has permission. Declaration string Targets { get; set; } Property Value String TenantInstanceId The tenant instance ID in which the site hub is located. Use empty guid for the default tenant instance. Declaration Guid TenantInstanceId { get; } Property Value Guid Title Specifies the name of the HubSite. Declaration string Title { get; set; } Property Value String Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IHubSite Public interface to define a HubSite object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IHubSite : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object Description The description of the HubSite. Declaration string Description { get; set; } Property Value String EnablePermissionsSync Gets or sets if permission sync to associated sites is enabled or not. Declaration bool EnablePermissionsSync { get; set; } Property Value Boolean EnforcedECTs Gets or sets the list of Enforced ECTs on the HubSite Declaration string EnforcedECTs { get; set; } Property Value String EnforcedECTsVersion Gets or sets EnforcedECTs version Declaration int EnforcedECTsVersion { get; set; } Property Value Int32 HideNameInNavigation Gets or sets if the HubSite nav includes the name as well as the logo. Declaration bool HideNameInNavigation { get; set; } Property Value Boolean Id The HubSite ID Declaration Guid Id { get; } Property Value Guid LogoUrl The logo URL of the HubSite Declaration string LogoUrl { get; set; } Property Value String ParentHubSiteId The parent hub site id to which this hub connects Declaration Guid ParentHubSiteId { get; set; } Property Value Guid PermissionsSyncTag Hub permissions sync tag Declaration int PermissionsSyncTag { get; } Property Value Int32 RequiresJoinApproval Gets or sets if the HubSite Join requires approval. Declaration bool RequiresJoinApproval { get; set; } Property Value Boolean SiteDesignId The site design to be executed when the hub is joined. Declaration Guid SiteDesignId { get; set; } Property Value Guid SiteId The Site Collection ID of the HubSite Declaration Guid SiteId { get; } Property Value Guid SiteUrl The URL of the HubSite Declaration string SiteUrl { get; } Property Value String Targets List of security groups with access to join the HubSite. Null if everyone has permission. Declaration string Targets { get; set; } Property Value String TenantInstanceId The tenant instance ID in which the site hub is located. Use empty guid for the default tenant instance. Declaration Guid TenantInstanceId { get; } Property Value Guid Title Specifies the name of the HubSite. Declaration string Title { get; set; } Property Value String Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IInformationRightsManagementFileSettings.html": { "href": "api/PnP.Core.Model.SharePoint.IInformationRightsManagementFileSettings.html", @@ -1977,7 +1977,7 @@ "api/PnP.Core.Model.SharePoint.IInformationRightsManagementSettings.html": { "href": "api/PnP.Core.Model.SharePoint.IInformationRightsManagementSettings.html", "title": "Interface IInformationRightsManagementSettings | PnP Core SDK", - "keywords": "Interface IInformationRightsManagementSettings Public interface to define a InformationRightsManagementSettings object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IInformationRightsManagementSettings : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object AllowPrint Allow viewers to print the IRM protected Office document Declaration bool AllowPrint { get; set; } Property Value Boolean AllowScript Allow viewers to run script and screen reader to function on the IRM protected Office document Declaration bool AllowScript { get; set; } Property Value Boolean AllowWriteCopy Allow viewers to write on a copy of the downloaded document Declaration bool AllowWriteCopy { get; set; } Property Value Boolean DisableDocumentBrowserView Prevent opening documents in the browser for this Document Library Declaration bool DisableDocumentBrowserView { get; set; } Property Value Boolean DocumentAccessExpireDays After download, document access rights will expire after these number of days (1-365) Declaration int DocumentAccessExpireDays { get; set; } Property Value Int32 DocumentLibraryProtectionExpireDate Stop restricting access to the library at Declaration DateTime DocumentLibraryProtectionExpireDate { get; set; } Property Value DateTime EnableDocumentAccessExpire Enable restricting access to the library at a given date ( DocumentLibraryProtectionExpireDate ) Declaration bool EnableDocumentAccessExpire { get; set; } Property Value Boolean EnableDocumentBrowserPublishingView Prevent opening documents in the browser for this Document Library Declaration bool EnableDocumentBrowserPublishingView { get; set; } Property Value Boolean EnableGroupProtection Allow group protection Declaration bool EnableGroupProtection { get; set; } Property Value Boolean EnableLicenseCacheExpire Enable document access rights expiration. Set the number of days via DocumentAccessExpireDays Declaration bool EnableLicenseCacheExpire { get; set; } Property Value Boolean GroupName Group name used for group protection Declaration string GroupName { get; set; } Property Value String LicenseCacheExpireDays Users must verify their credentials using this interval (days) Declaration int LicenseCacheExpireDays { get; set; } Property Value Int32 PolicyDescription Permission policy description: Declaration string PolicyDescription { get; set; } Property Value String PolicyTitle Permission policy title Declaration string PolicyTitle { get; set; } Property Value String TemplateId IRM template ID (not used?) Declaration string TemplateId { get; set; } Property Value String Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IInformationRightsManagementSettings Public interface to define a InformationRightsManagementSettings object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IInformationRightsManagementSettings : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object AllowPrint Allow viewers to print the IRM protected Office document Declaration bool AllowPrint { get; set; } Property Value Boolean AllowScript Allow viewers to run script and screen reader to function on the IRM protected Office document Declaration bool AllowScript { get; set; } Property Value Boolean AllowWriteCopy Allow viewers to write on a copy of the downloaded document Declaration bool AllowWriteCopy { get; set; } Property Value Boolean DisableDocumentBrowserView Prevent opening documents in the browser for this Document Library Declaration bool DisableDocumentBrowserView { get; set; } Property Value Boolean DocumentAccessExpireDays After download, document access rights will expire after these number of days (1-365) Declaration int DocumentAccessExpireDays { get; set; } Property Value Int32 DocumentLibraryProtectionExpireDate Stop restricting access to the library at Declaration DateTime DocumentLibraryProtectionExpireDate { get; set; } Property Value DateTime EnableDocumentAccessExpire Enable restricting access to the library at a given date ( DocumentLibraryProtectionExpireDate ) Declaration bool EnableDocumentAccessExpire { get; set; } Property Value Boolean EnableDocumentBrowserPublishingView Prevent opening documents in the browser for this Document Library Declaration bool EnableDocumentBrowserPublishingView { get; set; } Property Value Boolean EnableGroupProtection Allow group protection Declaration bool EnableGroupProtection { get; set; } Property Value Boolean EnableLicenseCacheExpire Enable document access rights expiration. Set the number of days via DocumentAccessExpireDays Declaration bool EnableLicenseCacheExpire { get; set; } Property Value Boolean GroupName Group name used for group protection Declaration string GroupName { get; set; } Property Value String LicenseCacheExpireDays Users must verify their credentials using this interval (days) Declaration int LicenseCacheExpireDays { get; set; } Property Value Int32 PolicyDescription Permission policy description: Declaration string PolicyDescription { get; set; } Property Value String PolicyTitle Permission policy title Declaration string PolicyTitle { get; set; } Property Value String TemplateId IRM template ID (not used?) Declaration string TemplateId { get; set; } Property Value String Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.ILikedByInformation.html": { "href": "api/PnP.Core.Model.SharePoint.ILikedByInformation.html", @@ -1987,32 +1987,32 @@ "api/PnP.Core.Model.SharePoint.IList.html": { "href": "api/PnP.Core.Model.SharePoint.IList.html", "title": "Interface IList | PnP Core SDK", - "keywords": "Interface IList Public interface to define a List object of SharePoint Online Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() IDataModelSupportingGetChanges.GetChangesAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChanges(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(ChangeQueryOptions) ISecurableObject.RoleAssignments ISecurableObject.HasUniqueRoleAssignments ISecurableObject.BreakRoleInheritance(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceAsync(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatch(Batch, Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatchAsync(Batch, Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatch(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatchAsync(Boolean, Boolean) ISecurableObject.ResetRoleInheritance() ISecurableObject.ResetRoleInheritanceAsync() ISecurableObject.ResetRoleInheritanceBatch(Batch) ISecurableObject.ResetRoleInheritanceBatchAsync(Batch) ISecurableObject.ResetRoleInheritanceBatch() ISecurableObject.ResetRoleInheritanceBatchAsync() ISecurableObject.GetRoleDefinitions(Int32) ISecurableObject.GetRoleDefinitionsAsync(Int32) ISecurableObject.AddRoleDefinitions(Int32, String[]) ISecurableObject.AddRoleDefinitionsAsync(Int32, String[]) ISecurableObject.AddRoleDefinition(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionAsync(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatch(Batch, Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatch(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatchAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitions(Int32, String[]) ISecurableObject.RemoveRoleDefinitionsAsync(Int32, String[]) ISecurableObject.RemoveRoleDefinition(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatch(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatchAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatch(Batch, Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IList : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IDataModelSupportingGetChanges, ISecurableObject, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object ContentTypes Collection of content types for this list Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IContentTypeCollection ContentTypes { get; } Property Value IContentTypeCollection ContentTypesEnabled Gets or sets whether content types are enabled Declaration bool ContentTypesEnabled { get; set; } Property Value Boolean Created Specifies the date and time that the list was created. Declaration DateTime Created { get; } Property Value DateTime DefaultDisplayFormUrl Defines a value that specifies the location of the default display form for the list. Declaration string DefaultDisplayFormUrl { get; set; } Property Value String DefaultEditFormUrl Defines a value that specifies the URL of the edit form to use for list items in the list. Declaration string DefaultEditFormUrl { get; set; } Property Value String DefaultItemOpenInBrowser Gets or sets whether the item is opened by default using the browser. Declaration bool DefaultItemOpenInBrowser { get; set; } Property Value Boolean DefaultNewFormUrl Defines a value that specifies the location of the default new form for the list. Declaration string DefaultNewFormUrl { get; set; } Property Value String DefaultViewUrl The url to the default view of this list. Declaration string DefaultViewUrl { get; } Property Value String Description Gets or sets the description of the list Declaration string Description { get; set; } Property Value String Direction Defines a value that specifies the reading order of the list. Declaration ListReadingDirection Direction { get; set; } Property Value ListReadingDirection DocumentTemplate Gets or sets a value that specifies the identifier of the document template for the new list. SP REST property name: DocumentTemplateUrl. Declaration string DocumentTemplate { get; set; } Property Value String DraftVersionVisibility Gets or sets the DraftVersionVisibility for the list Declaration DraftVisibilityType DraftVersionVisibility { get; set; } Property Value DraftVisibilityType EnableAttachments Gets or sets whether attachments are enabled. Defaults to true. Declaration bool EnableAttachments { get; set; } Property Value Boolean EnableFolderCreation Gets or sets whether folder is enabled. Defaults to true. Declaration bool EnableFolderCreation { get; set; } Property Value Boolean EnableMinorVersions Gets or sets whether minor verisioning is enabled on the list Declaration bool EnableMinorVersions { get; set; } Property Value Boolean EnableModeration Gets or sets whether moderation/content approval is enabled on the list Declaration bool EnableModeration { get; set; } Property Value Boolean EnableVersioning Gets or sets whether verisioning is enabled on the list Declaration bool EnableVersioning { get; set; } Property Value Boolean EventReceivers Event Receivers defined in this list Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IEventReceiverDefinitionCollection EventReceivers { get; } Property Value IEventReceiverDefinitionCollection FieldDefaults Defines a list of default values for the Fields of the List Instance Declaration Dictionary FieldDefaults { get; } Property Value Dictionary < String , String > Fields Collection of fields for this list Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFieldCollection Fields { get; } Property Value IFieldCollection ForceCheckout Gets or sets whether to force checkout of documents in the library Declaration bool ForceCheckout { get; set; } Property Value Boolean Hidden Gets or sets whether to hide the list Declaration bool Hidden { get; set; } Property Value Boolean Id The Unique ID of the List object Declaration Guid Id { get; } Property Value Guid ImageUrl Defines a value that specifies the URI for the icon of the list, optional attribute. Declaration string ImageUrl { get; set; } Property Value String InformationRightsManagementSettings Load the IRM settings of this list Declaration IInformationRightsManagementSettings InformationRightsManagementSettings { get; } Property Value IInformationRightsManagementSettings IrmEnabled Defines if IRM is enabled for this list. Declaration bool IrmEnabled { get; set; } Property Value Boolean IrmExpire Defines if IRM Expire property, optional attribute. Declaration bool IrmExpire { get; set; } Property Value Boolean IrmReject Defines the IRM Reject property, optional attribute. Declaration bool IrmReject { get; set; } Property Value Boolean IsApplicationList Defines a value that specifies a flag that a client application can use to determine whether to display the list, optional attribute. Declaration bool IsApplicationList { get; set; } Property Value Boolean IsCatalog Gets a bool value that indicates whether the list is a gallery, such list templates, Web Parts, or Master Pages. Declaration bool IsCatalog { get; } Property Value Boolean IsDefaultDocumentLibrary Is this library the default document library of this site Declaration bool IsDefaultDocumentLibrary { get; } Property Value Boolean IsPrivate Gets a bool value that indicates whether the document library is a private list with restricted permissions, such as for Solutions Declaration bool IsPrivate { get; } Property Value Boolean IsSiteAssetsLibrary Is this library the site's site asset library Declaration bool IsSiteAssetsLibrary { get; } Property Value Boolean IsSystemList Specifies whether the list is system list that does not contain end user data and created by system account. Declaration bool IsSystemList { get; } Property Value Boolean ItemCount Number of items in the library Declaration int ItemCount { get; } Property Value Int32 Items Collection of list items in the current List object Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IListItemCollection Items { get; } Property Value IListItemCollection LastItemDeletedDate Specifies when an item in the list was last deleted. If no item has yet been deleted from the list the list creation time is returned. Declaration DateTime LastItemDeletedDate { get; } Property Value DateTime LastItemModifiedDate Specifies when an item, field, or property of the list was last modified. If no item has been created in the list, the list creation time is returned. Declaration DateTime LastItemModifiedDate { get; } Property Value DateTime LastItemUserModifiedDate Specifies when an item of the list was last modified by a non-system update. A non-system update is a change to a list item that is visible to users. If no item has been created in the list, the list creation time is returned. Declaration DateTime LastItemUserModifiedDate { get; } Property Value DateTime ListExperience Defines the current list UI/UX experience (valid for SPO only). SP REST property name: ListExperienceOptions. Declaration ListExperience ListExperience { get; set; } Property Value ListExperience ListItemEntityTypeFullName The entity needed when updating list items Declaration string ListItemEntityTypeFullName { get; } Property Value String MaxVersionLimit Gets or sets the MinorVersionLimit for verisioning, just in case it is enabled on the list SP REST property name: MajorVersionLimit. Declaration int MaxVersionLimit { get; set; } Property Value Int32 MinorVersionLimit Gets or sets the MinorVersionLimit for versioning, just in case it is enabled on the list SP REST property name: MajorWithMinorVersionsLimit. Declaration int MinorVersionLimit { get; set; } Property Value Int32 NoCrawl Defines if the current list or library has to be included in crawling, optional attribute. Declaration bool NoCrawl { get; set; } Property Value Boolean OnQuickLaunch Gets or sets a value that specifies whether the new list is displayed on the Quick Launch of the site. Declaration bool OnQuickLaunch { get; set; } Property Value Boolean ReadSecurity Defines the Read Security property, optional attribute. Declaration int ReadSecurity { get; set; } Property Value Int32 RootFolder Gets the root folder of the list. Declaration IFolder RootFolder { get; } Property Value IFolder TemplateFeatureId Gets or sets the Guid for TemplateFeature Declaration Guid TemplateFeatureId { get; } Property Value Guid TemplateType Gets or sets a value that specifies the list server template of the new list. https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.listtemplatetype.aspx SP REST property name: BaseTemplate Declaration ListTemplateType TemplateType { get; } Property Value ListTemplateType Title Gets or sets the list title Declaration string Title { get; set; } Property Value String UserCustomActions Gets a value that specifies the collection of user custom actions for this list Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IUserCustomActionCollection UserCustomActions { get; } Property Value IUserCustomActionCollection ValidationFormula Defines a value that specifies the data validation criteria for a list item, optional attribute. Declaration string ValidationFormula { get; set; } Property Value String ValidationMessage Defines a value that specifies the error message returned when data validation fails for a list item, optional attribute. Declaration string ValidationMessage { get; set; } Property Value String Views Get a list of the views Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IViewCollection Views { get; } Property Value IViewCollection Webhooks Collection of list webhooks Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IListSubscriptionCollection Webhooks { get; } Property Value IListSubscriptionCollection WriteSecurity Defines the Write Security property, optional attribute. Declaration int WriteSecurity { get; set; } Property Value Int32 Methods AddListFolder(String, String, String) Adds a folder Declaration IListItem AddListFolder(string path, string parentFolder = null, string contentTypeId = \"0x0120\") Parameters String path String parentFolder String contentTypeId Returns IListItem AddListFolderAsync(String, String, String) Adds a folder Declaration Task AddListFolderAsync(string path, string parentFolder = null, string contentTypeId = \"0x0120\") Parameters String path String parentFolder String contentTypeId Returns Task < IListItem > AddListFolderBatch(Batch, String, String, String) Adds a folder Declaration IListItem AddListFolderBatch(Batch batch, string path, string parentFolder = null, string contentTypeId = \"0x0120\") Parameters Batch batch Batch to add this request to String path String parentFolder String contentTypeId Returns IListItem AddListFolderBatch(String, String, String) Adds a folder Declaration IListItem AddListFolderBatch(string path, string parentFolder = null, string contentTypeId = \"0x0120\") Parameters String path String parentFolder String contentTypeId Returns IListItem AddListFolderBatchAsync(Batch, String, String, String) Adds a folder Declaration Task AddListFolderBatchAsync(Batch batch, string path, string parentFolder = null, string contentTypeId = \"0x0120\") Parameters Batch batch Batch to add this request to String path String parentFolder String contentTypeId Returns Task < IListItem > AddListFolderBatchAsync(String, String, String) Adds a folder Declaration Task AddListFolderBatchAsync(string path, string parentFolder = null, string contentTypeId = \"0x0120\") Parameters String path String parentFolder String contentTypeId Returns Task < IListItem > CheckIfUserHasPermissions(String, PermissionKind) Checks if a user has a specific kind of permissions to a list Declaration bool CheckIfUserHasPermissions(string userPrincipalName, PermissionKind permissionKind) Parameters String userPrincipalName Login name of the user you wish to check if he has a specific permission PermissionKind permissionKind Permission kind to check Returns Boolean Boolean that says if the user has permissions or not CheckIfUserHasPermissionsAsync(String, PermissionKind) Checks if a user has a specific kind of permissions to a list Declaration Task CheckIfUserHasPermissionsAsync(string userPrincipalName, PermissionKind permissionKind) Parameters String userPrincipalName Login name of the user you wish to check if he has a specific permission PermissionKind permissionKind Permission kind to check Returns Task < Boolean > Boolean that says if the user has permissions or not ClassifyAndExtract(Boolean, Int32) Classifies and extracts all unprocessed files in the list Declaration List ClassifyAndExtract(bool force = false, int pageSize = 500) Parameters Boolean force Also classify and extract files that were processed before Int32 pageSize Page size used when loading the files in this library Returns PnP.Core.Model.SharePoint.List < ISyntexClassifyAndExtractResult > Information about the created classify and extract requests ClassifyAndExtractAsync(Boolean, Int32) Classifies and extracts all unprocessed files in the list Declaration Task> ClassifyAndExtractAsync(bool force = false, int pageSize = 500) Parameters Boolean force Also classify and extract files that were processed before Int32 pageSize Page size used when loading the files in this library Returns Task < PnP.Core.Model.SharePoint.List < ISyntexClassifyAndExtractResult >> Information about the created classify and extract requests ClassifyAndExtractOffPeak() Classifies and extracts all unprocessed files in the list via the Syntex off-peak queue Declaration ISyntexClassifyAndExtractResult ClassifyAndExtractOffPeak() Returns ISyntexClassifyAndExtractResult Information about the created classify and extract requests ClassifyAndExtractOffPeakAsync() Classifies and extracts all unprocessed files in the list via the Syntex off-peak queue Declaration Task ClassifyAndExtractOffPeakAsync() Returns Task < ISyntexClassifyAndExtractResult > Information about the created classify and extract requests ClearDefaultColumnValues() Clears the default column values set (at folder level) for this library Declaration void ClearDefaultColumnValues() ClearDefaultColumnValuesAsync() Clears the default column values set (at folder level) for this library Declaration Task ClearDefaultColumnValuesAsync() Returns Task EnableAudienceTargeting() Enable audience targeting for a list Declaration void EnableAudienceTargeting() EnableAudienceTargetingAsync() Enable audience targeting for a list Declaration Task EnableAudienceTargetingAsync() Returns Task FindFiles(String) Find files in the list, can be slow as it iterates over all the files in the list. If performance is key, then try using a search based solution Declaration List FindFiles(string match) Parameters String match Returns PnP.Core.Model.SharePoint.List < IFile > A of found files as type IFile FindFilesAsync(String) Find files in the list, can be slow as it iterates over all the files in the list. If performance is key, then try using a search based solution Declaration Task> FindFilesAsync(string match) Parameters String match Returns Task < PnP.Core.Model.SharePoint.List < IFile >> A of found files as type IFile GetComplianceTag() Retrieves the compliance tag / retention label for this list Declaration IComplianceTag GetComplianceTag() Returns IComplianceTag GetComplianceTagAsync() Retrieves the compliance tag / retention label for this list Declaration Task GetComplianceTagAsync() Returns Task < IComplianceTag > GetComplianceTagBatch() Retrieves the compliance tag / retention label for this list Declaration IBatchSingleResult GetComplianceTagBatch() Returns IBatchSingleResult < IComplianceTag > GetComplianceTagBatch(Batch) Retrieves the compliance tag / retention label for this list Declaration IBatchSingleResult GetComplianceTagBatch(Batch batch) Parameters Batch batch Batch to add this request to Returns IBatchSingleResult < IComplianceTag > GetComplianceTagBatchAsync() Retrieves the compliance tag / retention label for this list Declaration Task> GetComplianceTagBatchAsync() Returns Task < IBatchSingleResult < IComplianceTag >> GetComplianceTagBatchAsync(Batch) Retrieves the compliance tag / retention label for this list Declaration Task> GetComplianceTagBatchAsync(Batch batch) Parameters Batch batch Batch to add this request to Returns Task < IBatchSingleResult < IComplianceTag >> GetContentTypeOrder() Returns the current list or content types in the current order Declaration List GetContentTypeOrder() Returns PnP.Core.Model.SharePoint.List < String > Ordered list of content type id's, returns null when the list is not enabled to use content types GetContentTypeOrderAsync() Returns the current list or content types in the current order Declaration Task> GetContentTypeOrderAsync() Returns Task < PnP.Core.Model.SharePoint.List < String >> Ordered list of content type id's, returns null when the list is not enabled to use content types GetDefaultColumnValues() Gets a list of default column values set (at folder level) for this library Declaration List GetDefaultColumnValues() Returns PnP.Core.Model.SharePoint.List < DefaultColumnValueOptions > List of default column values GetDefaultColumnValuesAsync() Gets a list of default column values set (at folder level) for this library Declaration Task> GetDefaultColumnValuesAsync() Returns Task < PnP.Core.Model.SharePoint.List < DefaultColumnValueOptions >> List of default column values GetFlowInstances() Returns a list of flow instances connected to this list Declaration List GetFlowInstances() Returns PnP.Core.Model.SharePoint.List < IFlowInstance > List of connected flow instances GetFlowInstancesAsync() Returns a list of flow instances connected to this list Declaration Task> GetFlowInstancesAsync() Returns Task < PnP.Core.Model.SharePoint.List < IFlowInstance >> List of connected flow instances GetFlowInstancesBatch() Returns a list of flow instances connected to this list Declaration IEnumerableBatchResult GetFlowInstancesBatch() Returns IEnumerableBatchResult < IFlowInstance > List of connected flow instances GetFlowInstancesBatch(Batch) Returns a list of flow instances connected to this list Declaration IEnumerableBatchResult GetFlowInstancesBatch(Batch batch) Parameters Batch batch Batch to add this request to Returns IEnumerableBatchResult < IFlowInstance > List of connected flow instances GetFlowInstancesBatchAsync() Returns a list of flow instances connected to this list Declaration Task> GetFlowInstancesBatchAsync() Returns Task < IEnumerableBatchResult < IFlowInstance >> List of connected flow instances GetFlowInstancesBatchAsync(Batch) Returns a list of flow instances connected to this list Declaration Task> GetFlowInstancesBatchAsync(Batch batch) Parameters Batch batch Batch to add this request to Returns Task < IEnumerableBatchResult < IFlowInstance >> List of connected flow instances GetUserEffectivePermissions(String) Gets the user effective permissions of a user for a list Declaration IBasePermissions GetUserEffectivePermissions(string userPrincipalName) Parameters String userPrincipalName Login name of the user you wish to retrieve the permissions of Returns IBasePermissions Base permissions object that contains the High and the Low permissions GetUserEffectivePermissionsAsync(String) Gets the user effective permissions of a user for a list Declaration Task GetUserEffectivePermissionsAsync(string userPrincipalName) Parameters String userPrincipalName Login name of the user you wish to retrieve the permissions of Returns Task < IBasePermissions > Base permissions object that contains the High and the Low permissions LoadItemsByCamlQuery(CamlQueryOptions, Expression>[]) Loads list items based up on a CAML query Declaration void LoadItemsByCamlQuery(CamlQueryOptions queryOptions, params Expression>[] selectors) Parameters CamlQueryOptions queryOptions CamlQueryOptions defining the query to execute Expression < Func < IListItem , Object >>[] selectors The expressions declaring the fields to select LoadItemsByCamlQuery(String, Expression>[]) Loads list items based up on a CAML query Declaration void LoadItemsByCamlQuery(string query, params Expression>[] selectors) Parameters String query query to execute Expression < Func < IListItem , Object >>[] selectors The expressions declaring the fields to select LoadItemsByCamlQueryAsync(CamlQueryOptions, Expression>[]) Loads list items based up on a CAML query Declaration Task LoadItemsByCamlQueryAsync(CamlQueryOptions queryOptions, params Expression>[] selectors) Parameters CamlQueryOptions queryOptions CamlQueryOptions defining the query to execute Expression < Func < IListItem , Object >>[] selectors The expressions declaring the fields to select Returns Task LoadItemsByCamlQueryAsync(String, Expression>[]) Loads list items based up on a CAML query Declaration Task LoadItemsByCamlQueryAsync(string query, params Expression>[] selectors) Parameters String query query to execute Expression < Func < IListItem , Object >>[] selectors The expressions declaring the fields to select Returns Task LoadItemsByCamlQueryBatch(CamlQueryOptions, Expression>[]) Loads list items based up on a CAML query Declaration void LoadItemsByCamlQueryBatch(CamlQueryOptions queryOptions, params Expression>[] selectors) Parameters CamlQueryOptions queryOptions CamlQueryOptions defining the query to execute Expression < Func < IListItem , Object >>[] selectors The expressions declaring the fields to select LoadItemsByCamlQueryBatch(Batch, CamlQueryOptions, Expression>[]) Loads list items based up on a CAML query Declaration void LoadItemsByCamlQueryBatch(Batch batch, CamlQueryOptions queryOptions, params Expression>[] selectors) Parameters Batch batch Batch to add this request to CamlQueryOptions queryOptions CamlQueryOptions defining the query to execute Expression < Func < IListItem , Object >>[] selectors The expressions declaring the fields to select LoadItemsByCamlQueryBatch(Batch, String, Expression>[]) Loads list items based up on a CAML query Declaration void LoadItemsByCamlQueryBatch(Batch batch, string query, params Expression>[] selectors) Parameters Batch batch Batch to add this request to String query query to execute Expression < Func < IListItem , Object >>[] selectors The expressions declaring the fields to select LoadItemsByCamlQueryBatch(String, Expression>[]) Loads list items based up on a CAML query Declaration void LoadItemsByCamlQueryBatch(string query, params Expression>[] selectors) Parameters String query query to execute Expression < Func < IListItem , Object >>[] selectors The expressions declaring the fields to select LoadItemsByCamlQueryBatchAsync(CamlQueryOptions, Expression>[]) Loads list items based up on a CAML query Declaration Task LoadItemsByCamlQueryBatchAsync(CamlQueryOptions queryOptions, params Expression>[] selectors) Parameters CamlQueryOptions queryOptions CamlQueryOptions defining the query to execute Expression < Func < IListItem , Object >>[] selectors The expressions declaring the fields to select Returns Task LoadItemsByCamlQueryBatchAsync(Batch, CamlQueryOptions, Expression>[]) Loads list items based up on a CAML query Declaration Task LoadItemsByCamlQueryBatchAsync(Batch batch, CamlQueryOptions queryOptions, params Expression>[] selectors) Parameters Batch batch Batch to add this request to CamlQueryOptions queryOptions CamlQueryOptions defining the query to execute Expression < Func < IListItem , Object >>[] selectors The expressions declaring the fields to select Returns Task LoadItemsByCamlQueryBatchAsync(Batch, String, Expression>[]) Loads list items based up on a CAML query Declaration Task LoadItemsByCamlQueryBatchAsync(Batch batch, string query, params Expression>[] selectors) Parameters Batch batch Batch to add this request to String query query to execute Expression < Func < IListItem , Object >>[] selectors The expressions declaring the fields to select Returns Task LoadItemsByCamlQueryBatchAsync(String, Expression>[]) Loads list items based up on a CAML query Declaration Task LoadItemsByCamlQueryBatchAsync(string query, params Expression>[] selectors) Parameters String query query to execute Expression < Func < IListItem , Object >>[] selectors The expressions declaring the fields to select Returns Task LoadListDataAsStream(RenderListDataOptions) Loads list items based up on a CAML query and the RenderListDataAsStream API Declaration Dictionary LoadListDataAsStream(RenderListDataOptions renderOptions) Parameters RenderListDataOptions renderOptions RenderListDataOptions defining the query to execute Returns Dictionary < String , Object > LoadListDataAsStreamAsync(RenderListDataOptions) Loads list items based up on a CAML query and the RenderListDataAsStream API Declaration Task> LoadListDataAsStreamAsync(RenderListDataOptions renderOptions) Parameters RenderListDataOptions renderOptions RenderListDataOptions defining the query to execute Returns Task < Dictionary < String , Object >> LoadListDataAsStreamBatch(RenderListDataOptions) Loads list items based up on a CAML query and the RenderListDataAsStream API Declaration IBatchSingleResult> LoadListDataAsStreamBatch(RenderListDataOptions renderOptions) Parameters RenderListDataOptions renderOptions RenderListDataOptions defining the query to execute Returns IBatchSingleResult < Dictionary < String , Object >> LoadListDataAsStreamBatch(Batch, RenderListDataOptions) Loads list items based up on a CAML query and the RenderListDataAsStream API Declaration IBatchSingleResult> LoadListDataAsStreamBatch(Batch batch, RenderListDataOptions renderOptions) Parameters Batch batch Batch to add this request to RenderListDataOptions renderOptions RenderListDataOptions defining the query to execute Returns IBatchSingleResult < Dictionary < String , Object >> LoadListDataAsStreamBatchAsync(RenderListDataOptions) Loads list items based up on a CAML query and the RenderListDataAsStream API Declaration Task>> LoadListDataAsStreamBatchAsync(RenderListDataOptions renderOptions) Parameters RenderListDataOptions renderOptions RenderListDataOptions defining the query to execute Returns Task < IBatchSingleResult < Dictionary < String , Object >>> LoadListDataAsStreamBatchAsync(Batch, RenderListDataOptions) Loads list items based up on a CAML query and the RenderListDataAsStream API Declaration Task>> LoadListDataAsStreamBatchAsync(Batch batch, RenderListDataOptions renderOptions) Parameters Batch batch Batch to add this request to RenderListDataOptions renderOptions RenderListDataOptions defining the query to execute Returns Task < IBatchSingleResult < Dictionary < String , Object >>> Recycle() Moves this list into the site collection recycle bin, returns the recyle bin item id Declaration Guid Recycle() Returns Guid Id of the recycle bin item RecycleAsync() Moves this list into the site collection recycle bin, returns the recyle bin item id Declaration Task RecycleAsync() Returns Task < Guid > Id of the recycle bin item RecycleBatch() Moves this list into the site collection recycle bin, returns the recyle bin item id Declaration IBatchSingleResult> RecycleBatch() Returns IBatchSingleResult < BatchResultValue < Guid >> Id of the recycle bin item RecycleBatch(Batch) Moves this list into the site collection recycle bin, returns the recyle bin item id Declaration IBatchSingleResult> RecycleBatch(Batch batch) Parameters Batch batch Batch to add the request to Returns IBatchSingleResult < BatchResultValue < Guid >> Id of the recycle bin item RecycleBatchAsync() Moves this list into the site collection recycle bin, returns the recyle bin item id Declaration Task>> RecycleBatchAsync() Returns Task < IBatchSingleResult < BatchResultValue < Guid >>> Id of the recycle bin item RecycleBatchAsync(Batch) Moves this list into the site collection recycle bin, returns the recyle bin item id Declaration Task>> RecycleBatchAsync(Batch batch) Parameters Batch batch Batch to add the request to Returns Task < IBatchSingleResult < BatchResultValue < Guid >>> Id of the recycle bin item ReIndex() Reindexes this list Declaration void ReIndex() ReIndexAsync() Reindexes this list Declaration Task ReIndexAsync() Returns Task ReorderContentTypes(List) Reorders the content types on the list. This controls the order of content types in the \"New\" menu and \"List Settings\" page Declaration void ReorderContentTypes(List contentTypeIdList) Parameters PnP.Core.Model.SharePoint.List < String > contentTypeIdList Ordered list of content type ids to set ReorderContentTypesAsync(List) Reorders the content types on the list. This controls the order of content types in the \"New\" menu and \"List Settings\" page Declaration Task ReorderContentTypesAsync(List contentTypeIdList) Parameters PnP.Core.Model.SharePoint.List < String > contentTypeIdList Ordered list of content type ids to set Returns Task SetComplianceTag(String, Boolean, Boolean, Boolean) Sets a compliance tag / retention label for this list Declaration void SetComplianceTag(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems) Parameters String complianceTagValue Compliance tag Boolean blockDelete Prevent deletion of the list (Hold) Boolean blockEdit Prevent editing of the list (Record) Boolean syncToItems If true the compliance tag is synced to the list items in this list SetComplianceTagAsync(String, Boolean, Boolean, Boolean) Sets a compliance tag / retention label for this list Declaration Task SetComplianceTagAsync(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems) Parameters String complianceTagValue Compliance tag Boolean blockDelete Prevent deletion of the list (Hold) Boolean blockEdit Prevent editing of the list (Record) Boolean syncToItems If true the compliance tag is synced to the list items in this list Returns Task SetComplianceTagBatch(Batch, String, Boolean, Boolean, Boolean) Sets a compliance tag / retention label for this list Declaration void SetComplianceTagBatch(Batch batch, string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems) Parameters Batch batch Batch to add this request to String complianceTagValue Compliance tag Boolean blockDelete Prevent deletion of the list (Hold) Boolean blockEdit Prevent editing of the list (Record) Boolean syncToItems If true the compliance tag is synced to the list items in this list SetComplianceTagBatch(String, Boolean, Boolean, Boolean) Sets a compliance tag / retention label for this list Declaration void SetComplianceTagBatch(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems) Parameters String complianceTagValue Compliance tag Boolean blockDelete Prevent deletion of the list (Hold) Boolean blockEdit Prevent editing of the list (Record) Boolean syncToItems If true the compliance tag is synced to the list items in this list SetComplianceTagBatchAsync(Batch, String, Boolean, Boolean, Boolean) Sets a compliance tag / retention label for this list Declaration Task SetComplianceTagBatchAsync(Batch batch, string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems) Parameters Batch batch Batch to add this request to String complianceTagValue Compliance tag Boolean blockDelete Prevent deletion of the list (Hold) Boolean blockEdit Prevent editing of the list (Record) Boolean syncToItems If true the compliance tag is synced to the list items in this list Returns Task SetComplianceTagBatchAsync(String, Boolean, Boolean, Boolean) Sets a compliance tag / retention label for this list Declaration Task SetComplianceTagBatchAsync(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems) Parameters String complianceTagValue Compliance tag Boolean blockDelete Prevent deletion of the list (Hold) Boolean blockEdit Prevent editing of the list (Record) Boolean syncToItems If true the compliance tag is synced to the list items in this list Returns Task SetDefaultColumnValues(List) Sets the default column value settings (at folder level) for this library Declaration void SetDefaultColumnValues(List defaultColumnValues) Parameters PnP.Core.Model.SharePoint.List < DefaultColumnValueOptions > defaultColumnValues List with default column values to set SetDefaultColumnValuesAsync(List) Sets the default column value settings (at folder level) for this library Declaration Task SetDefaultColumnValuesAsync(List defaultColumnValues) Parameters PnP.Core.Model.SharePoint.List < DefaultColumnValueOptions > defaultColumnValues List with default column values to set Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IList Public interface to define a List object of SharePoint Online Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() IDataModelSupportingGetChanges.GetChangesAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChanges(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(ChangeQueryOptions) ISecurableObject.RoleAssignments ISecurableObject.HasUniqueRoleAssignments ISecurableObject.BreakRoleInheritance(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceAsync(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatch(Batch, Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatchAsync(Batch, Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatch(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatchAsync(Boolean, Boolean) ISecurableObject.ResetRoleInheritance() ISecurableObject.ResetRoleInheritanceAsync() ISecurableObject.ResetRoleInheritanceBatch(Batch) ISecurableObject.ResetRoleInheritanceBatchAsync(Batch) ISecurableObject.ResetRoleInheritanceBatch() ISecurableObject.ResetRoleInheritanceBatchAsync() ISecurableObject.GetRoleDefinitions(Int32) ISecurableObject.GetRoleDefinitionsAsync(Int32) ISecurableObject.AddRoleDefinitions(Int32, String[]) ISecurableObject.AddRoleDefinitionsAsync(Int32, String[]) ISecurableObject.AddRoleDefinition(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionAsync(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatch(Batch, Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatch(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatchAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitions(Int32, String[]) ISecurableObject.RemoveRoleDefinitionsAsync(Int32, String[]) ISecurableObject.RemoveRoleDefinition(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatch(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatchAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatch(Batch, Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IList : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IDataModelSupportingGetChanges, ISecurableObject, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object ContentTypes Collection of content types for this list Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IContentTypeCollection ContentTypes { get; } Property Value IContentTypeCollection ContentTypesEnabled Gets or sets whether content types are enabled Declaration bool ContentTypesEnabled { get; set; } Property Value Boolean Created Specifies the date and time that the list was created. Declaration DateTime Created { get; } Property Value DateTime DefaultDisplayFormUrl Defines a value that specifies the location of the default display form for the list. Declaration string DefaultDisplayFormUrl { get; set; } Property Value String DefaultEditFormUrl Defines a value that specifies the URL of the edit form to use for list items in the list. Declaration string DefaultEditFormUrl { get; set; } Property Value String DefaultItemOpenInBrowser Gets or sets whether the item is opened by default using the browser. Declaration bool DefaultItemOpenInBrowser { get; set; } Property Value Boolean DefaultNewFormUrl Defines a value that specifies the location of the default new form for the list. Declaration string DefaultNewFormUrl { get; set; } Property Value String DefaultViewUrl The url to the default view of this list. Declaration string DefaultViewUrl { get; } Property Value String Description Gets or sets the description of the list Declaration string Description { get; set; } Property Value String Direction Defines a value that specifies the reading order of the list. Declaration ListReadingDirection Direction { get; set; } Property Value ListReadingDirection DocumentTemplate Gets or sets a value that specifies the identifier of the document template for the new list. SP REST property name: DocumentTemplateUrl. Declaration string DocumentTemplate { get; set; } Property Value String DraftVersionVisibility Gets or sets the DraftVersionVisibility for the list Declaration DraftVisibilityType DraftVersionVisibility { get; set; } Property Value DraftVisibilityType EnableAttachments Gets or sets whether attachments are enabled. Defaults to true. Declaration bool EnableAttachments { get; set; } Property Value Boolean EnableFolderCreation Gets or sets whether folder is enabled. Defaults to true. Declaration bool EnableFolderCreation { get; set; } Property Value Boolean EnableMinorVersions Gets or sets whether minor verisioning is enabled on the list Declaration bool EnableMinorVersions { get; set; } Property Value Boolean EnableModeration Gets or sets whether moderation/content approval is enabled on the list Declaration bool EnableModeration { get; set; } Property Value Boolean EnableVersioning Gets or sets whether verisioning is enabled on the list Declaration bool EnableVersioning { get; set; } Property Value Boolean EventReceivers Event Receivers defined in this list Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IEventReceiverDefinitionCollection EventReceivers { get; } Property Value IEventReceiverDefinitionCollection FieldDefaults Defines a list of default values for the Fields of the List Instance Declaration Dictionary FieldDefaults { get; } Property Value Dictionary < String , String > Fields Collection of fields for this list Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFieldCollection Fields { get; } Property Value IFieldCollection ForceCheckout Gets or sets whether to force checkout of documents in the library Declaration bool ForceCheckout { get; set; } Property Value Boolean Hidden Gets or sets whether to hide the list Declaration bool Hidden { get; set; } Property Value Boolean Id The Unique ID of the List object Declaration Guid Id { get; } Property Value Guid ImageUrl Defines a value that specifies the URI for the icon of the list, optional attribute. Declaration string ImageUrl { get; set; } Property Value String InformationRightsManagementSettings Load the IRM settings of this list Declaration IInformationRightsManagementSettings InformationRightsManagementSettings { get; } Property Value IInformationRightsManagementSettings IrmEnabled Defines if IRM is enabled for this list. Declaration bool IrmEnabled { get; set; } Property Value Boolean IrmExpire Defines if IRM Expire property, optional attribute. Declaration bool IrmExpire { get; set; } Property Value Boolean IrmReject Defines the IRM Reject property, optional attribute. Declaration bool IrmReject { get; set; } Property Value Boolean IsApplicationList Defines a value that specifies a flag that a client application can use to determine whether to display the list, optional attribute. Declaration bool IsApplicationList { get; set; } Property Value Boolean IsCatalog Gets a bool value that indicates whether the list is a gallery, such list templates, Web Parts, or Master Pages. Declaration bool IsCatalog { get; } Property Value Boolean IsDefaultDocumentLibrary Is this library the default document library of this site Declaration bool IsDefaultDocumentLibrary { get; } Property Value Boolean IsPrivate Gets a bool value that indicates whether the document library is a private list with restricted permissions, such as for Solutions Declaration bool IsPrivate { get; } Property Value Boolean IsSiteAssetsLibrary Is this library the site's site asset library Declaration bool IsSiteAssetsLibrary { get; } Property Value Boolean IsSystemList Specifies whether the list is system list that does not contain end user data and created by system account. Declaration bool IsSystemList { get; } Property Value Boolean ItemCount Number of items in the library Declaration int ItemCount { get; } Property Value Int32 Items Collection of list items in the current List object Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IListItemCollection Items { get; } Property Value IListItemCollection LastItemDeletedDate Specifies when an item in the list was last deleted. If no item has yet been deleted from the list the list creation time is returned. Declaration DateTime LastItemDeletedDate { get; } Property Value DateTime LastItemModifiedDate Specifies when an item, field, or property of the list was last modified. If no item has been created in the list, the list creation time is returned. Declaration DateTime LastItemModifiedDate { get; } Property Value DateTime LastItemUserModifiedDate Specifies when an item of the list was last modified by a non-system update. A non-system update is a change to a list item that is visible to users. If no item has been created in the list, the list creation time is returned. Declaration DateTime LastItemUserModifiedDate { get; } Property Value DateTime ListExperience Defines the current list UI/UX experience (valid for SPO only). SP REST property name: ListExperienceOptions. Declaration ListExperience ListExperience { get; set; } Property Value ListExperience ListItemEntityTypeFullName The entity needed when updating list items Declaration string ListItemEntityTypeFullName { get; } Property Value String MaxVersionLimit Gets or sets the MinorVersionLimit for verisioning, just in case it is enabled on the list SP REST property name: MajorVersionLimit. Declaration int MaxVersionLimit { get; set; } Property Value Int32 MinorVersionLimit Gets or sets the MinorVersionLimit for versioning, just in case it is enabled on the list SP REST property name: MajorWithMinorVersionsLimit. Declaration int MinorVersionLimit { get; set; } Property Value Int32 NoCrawl Defines if the current list or library has to be included in crawling, optional attribute. Declaration bool NoCrawl { get; set; } Property Value Boolean OnQuickLaunch Gets or sets a value that specifies whether the new list is displayed on the Quick Launch of the site. Declaration bool OnQuickLaunch { get; set; } Property Value Boolean ReadSecurity Defines the Read Security property, optional attribute. Declaration int ReadSecurity { get; set; } Property Value Int32 RootFolder Gets the root folder of the list. Declaration IFolder RootFolder { get; } Property Value IFolder TemplateFeatureId Gets or sets the Guid for TemplateFeature Declaration Guid TemplateFeatureId { get; } Property Value Guid TemplateType Gets or sets a value that specifies the list server template of the new list. https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.listtemplatetype.aspx SP REST property name: BaseTemplate Declaration ListTemplateType TemplateType { get; } Property Value ListTemplateType Title Gets or sets the list title Declaration string Title { get; set; } Property Value String UserCustomActions Gets a value that specifies the collection of user custom actions for this list Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IUserCustomActionCollection UserCustomActions { get; } Property Value IUserCustomActionCollection ValidationFormula Defines a value that specifies the data validation criteria for a list item, optional attribute. Declaration string ValidationFormula { get; set; } Property Value String ValidationMessage Defines a value that specifies the error message returned when data validation fails for a list item, optional attribute. Declaration string ValidationMessage { get; set; } Property Value String Views Get a list of the views Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IViewCollection Views { get; } Property Value IViewCollection Webhooks Collection of list webhooks Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IListSubscriptionCollection Webhooks { get; } Property Value IListSubscriptionCollection WriteSecurity Defines the Write Security property, optional attribute. Declaration int WriteSecurity { get; set; } Property Value Int32 Methods AddListFolder(String, String, String) Adds a folder Declaration IListItem AddListFolder(string path, string parentFolder = null, string contentTypeId = \"0x0120\") Parameters String path String parentFolder String contentTypeId Returns IListItem AddListFolderAsync(String, String, String) Adds a folder Declaration Task AddListFolderAsync(string path, string parentFolder = null, string contentTypeId = \"0x0120\") Parameters String path String parentFolder String contentTypeId Returns Task < IListItem > AddListFolderBatch(Batch, String, String, String) Adds a folder Declaration IListItem AddListFolderBatch(Batch batch, string path, string parentFolder = null, string contentTypeId = \"0x0120\") Parameters Batch batch Batch to add this request to String path String parentFolder String contentTypeId Returns IListItem AddListFolderBatch(String, String, String) Adds a folder Declaration IListItem AddListFolderBatch(string path, string parentFolder = null, string contentTypeId = \"0x0120\") Parameters String path String parentFolder String contentTypeId Returns IListItem AddListFolderBatchAsync(Batch, String, String, String) Adds a folder Declaration Task AddListFolderBatchAsync(Batch batch, string path, string parentFolder = null, string contentTypeId = \"0x0120\") Parameters Batch batch Batch to add this request to String path String parentFolder String contentTypeId Returns Task < IListItem > AddListFolderBatchAsync(String, String, String) Adds a folder Declaration Task AddListFolderBatchAsync(string path, string parentFolder = null, string contentTypeId = \"0x0120\") Parameters String path String parentFolder String contentTypeId Returns Task < IListItem > CheckIfUserHasPermissions(String, PermissionKind) Checks if a user has a specific kind of permissions to a list Declaration bool CheckIfUserHasPermissions(string userPrincipalName, PermissionKind permissionKind) Parameters String userPrincipalName Login name of the user you wish to check if he has a specific permission PermissionKind permissionKind Permission kind to check Returns Boolean Boolean that says if the user has permissions or not CheckIfUserHasPermissionsAsync(String, PermissionKind) Checks if a user has a specific kind of permissions to a list Declaration Task CheckIfUserHasPermissionsAsync(string userPrincipalName, PermissionKind permissionKind) Parameters String userPrincipalName Login name of the user you wish to check if he has a specific permission PermissionKind permissionKind Permission kind to check Returns Task < Boolean > Boolean that says if the user has permissions or not ClassifyAndExtract(Boolean, Int32) Classifies and extracts all unprocessed files in the list Declaration List ClassifyAndExtract(bool force = false, int pageSize = 500) Parameters Boolean force Also classify and extract files that were processed before Int32 pageSize Page size used when loading the files in this library Returns PnP.Core.Model.SharePoint.List < ISyntexClassifyAndExtractResult > Information about the created classify and extract requests ClassifyAndExtractAsync(Boolean, Int32) Classifies and extracts all unprocessed files in the list Declaration Task> ClassifyAndExtractAsync(bool force = false, int pageSize = 500) Parameters Boolean force Also classify and extract files that were processed before Int32 pageSize Page size used when loading the files in this library Returns Task < PnP.Core.Model.SharePoint.List < ISyntexClassifyAndExtractResult >> Information about the created classify and extract requests ClassifyAndExtractOffPeak() Classifies and extracts all unprocessed files in the list via the Syntex off-peak queue Declaration ISyntexClassifyAndExtractResult ClassifyAndExtractOffPeak() Returns ISyntexClassifyAndExtractResult Information about the created classify and extract requests ClassifyAndExtractOffPeakAsync() Classifies and extracts all unprocessed files in the list via the Syntex off-peak queue Declaration Task ClassifyAndExtractOffPeakAsync() Returns Task < ISyntexClassifyAndExtractResult > Information about the created classify and extract requests ClearDefaultColumnValues() Clears the default column values set (at folder level) for this library Declaration void ClearDefaultColumnValues() ClearDefaultColumnValuesAsync() Clears the default column values set (at folder level) for this library Declaration Task ClearDefaultColumnValuesAsync() Returns Task EnableAudienceTargeting() Enable audience targeting for a list Declaration void EnableAudienceTargeting() EnableAudienceTargetingAsync() Enable audience targeting for a list Declaration Task EnableAudienceTargetingAsync() Returns Task FindFiles(String) Find files in the list, can be slow as it iterates over all the files in the list. If performance is key, then try using a search based solution Declaration List FindFiles(string match) Parameters String match Returns PnP.Core.Model.SharePoint.List < IFile > A of found files as type IFile FindFilesAsync(String) Find files in the list, can be slow as it iterates over all the files in the list. If performance is key, then try using a search based solution Declaration Task> FindFilesAsync(string match) Parameters String match Returns Task < PnP.Core.Model.SharePoint.List < IFile >> A of found files as type IFile GetComplianceTag() Retrieves the compliance tag / retention label for this list Declaration IComplianceTag GetComplianceTag() Returns IComplianceTag GetComplianceTagAsync() Retrieves the compliance tag / retention label for this list Declaration Task GetComplianceTagAsync() Returns Task < IComplianceTag > GetComplianceTagBatch() Retrieves the compliance tag / retention label for this list Declaration IBatchSingleResult GetComplianceTagBatch() Returns IBatchSingleResult < IComplianceTag > GetComplianceTagBatch(Batch) Retrieves the compliance tag / retention label for this list Declaration IBatchSingleResult GetComplianceTagBatch(Batch batch) Parameters Batch batch Batch to add this request to Returns IBatchSingleResult < IComplianceTag > GetComplianceTagBatchAsync() Retrieves the compliance tag / retention label for this list Declaration Task> GetComplianceTagBatchAsync() Returns Task < IBatchSingleResult < IComplianceTag >> GetComplianceTagBatchAsync(Batch) Retrieves the compliance tag / retention label for this list Declaration Task> GetComplianceTagBatchAsync(Batch batch) Parameters Batch batch Batch to add this request to Returns Task < IBatchSingleResult < IComplianceTag >> GetContentTypeOrder() Returns the current list or content types in the current order Declaration List GetContentTypeOrder() Returns PnP.Core.Model.SharePoint.List < String > Ordered list of content type id's, returns null when the list is not enabled to use content types GetContentTypeOrderAsync() Returns the current list or content types in the current order Declaration Task> GetContentTypeOrderAsync() Returns Task < PnP.Core.Model.SharePoint.List < String >> Ordered list of content type id's, returns null when the list is not enabled to use content types GetDefaultColumnValues() Gets a list of default column values set (at folder level) for this library Declaration List GetDefaultColumnValues() Returns PnP.Core.Model.SharePoint.List < DefaultColumnValueOptions > List of default column values GetDefaultColumnValuesAsync() Gets a list of default column values set (at folder level) for this library Declaration Task> GetDefaultColumnValuesAsync() Returns Task < PnP.Core.Model.SharePoint.List < DefaultColumnValueOptions >> List of default column values GetFlowInstances() Returns a list of flow instances connected to this list Declaration List GetFlowInstances() Returns PnP.Core.Model.SharePoint.List < IFlowInstance > List of connected flow instances GetFlowInstancesAsync() Returns a list of flow instances connected to this list Declaration Task> GetFlowInstancesAsync() Returns Task < PnP.Core.Model.SharePoint.List < IFlowInstance >> List of connected flow instances GetFlowInstancesBatch() Returns a list of flow instances connected to this list Declaration IEnumerableBatchResult GetFlowInstancesBatch() Returns IEnumerableBatchResult < IFlowInstance > List of connected flow instances GetFlowInstancesBatch(Batch) Returns a list of flow instances connected to this list Declaration IEnumerableBatchResult GetFlowInstancesBatch(Batch batch) Parameters Batch batch Batch to add this request to Returns IEnumerableBatchResult < IFlowInstance > List of connected flow instances GetFlowInstancesBatchAsync() Returns a list of flow instances connected to this list Declaration Task> GetFlowInstancesBatchAsync() Returns Task < IEnumerableBatchResult < IFlowInstance >> List of connected flow instances GetFlowInstancesBatchAsync(Batch) Returns a list of flow instances connected to this list Declaration Task> GetFlowInstancesBatchAsync(Batch batch) Parameters Batch batch Batch to add this request to Returns Task < IEnumerableBatchResult < IFlowInstance >> List of connected flow instances GetUserEffectivePermissions(String) Gets the user effective permissions of a user for a list Declaration IBasePermissions GetUserEffectivePermissions(string userPrincipalName) Parameters String userPrincipalName Login name of the user you wish to retrieve the permissions of Returns IBasePermissions Base permissions object that contains the High and the Low permissions GetUserEffectivePermissionsAsync(String) Gets the user effective permissions of a user for a list Declaration Task GetUserEffectivePermissionsAsync(string userPrincipalName) Parameters String userPrincipalName Login name of the user you wish to retrieve the permissions of Returns Task < IBasePermissions > Base permissions object that contains the High and the Low permissions LoadItemsByCamlQuery(CamlQueryOptions, Expression>[]) Loads list items based up on a CAML query Declaration void LoadItemsByCamlQuery(CamlQueryOptions queryOptions, params Expression>[] selectors) Parameters CamlQueryOptions queryOptions CamlQueryOptions defining the query to execute Expression < Func < IListItem , System.Object >>[] selectors The expressions declaring the fields to select LoadItemsByCamlQuery(String, Expression>[]) Loads list items based up on a CAML query Declaration void LoadItemsByCamlQuery(string query, params Expression>[] selectors) Parameters String query query to execute Expression < Func < IListItem , System.Object >>[] selectors The expressions declaring the fields to select LoadItemsByCamlQueryAsync(CamlQueryOptions, Expression>[]) Loads list items based up on a CAML query Declaration Task LoadItemsByCamlQueryAsync(CamlQueryOptions queryOptions, params Expression>[] selectors) Parameters CamlQueryOptions queryOptions CamlQueryOptions defining the query to execute Expression < Func < IListItem , System.Object >>[] selectors The expressions declaring the fields to select Returns Task LoadItemsByCamlQueryAsync(String, Expression>[]) Loads list items based up on a CAML query Declaration Task LoadItemsByCamlQueryAsync(string query, params Expression>[] selectors) Parameters String query query to execute Expression < Func < IListItem , System.Object >>[] selectors The expressions declaring the fields to select Returns Task LoadItemsByCamlQueryBatch(CamlQueryOptions, Expression>[]) Loads list items based up on a CAML query Declaration void LoadItemsByCamlQueryBatch(CamlQueryOptions queryOptions, params Expression>[] selectors) Parameters CamlQueryOptions queryOptions CamlQueryOptions defining the query to execute Expression < Func < IListItem , System.Object >>[] selectors The expressions declaring the fields to select LoadItemsByCamlQueryBatch(Batch, CamlQueryOptions, Expression>[]) Loads list items based up on a CAML query Declaration void LoadItemsByCamlQueryBatch(Batch batch, CamlQueryOptions queryOptions, params Expression>[] selectors) Parameters Batch batch Batch to add this request to CamlQueryOptions queryOptions CamlQueryOptions defining the query to execute Expression < Func < IListItem , System.Object >>[] selectors The expressions declaring the fields to select LoadItemsByCamlQueryBatch(Batch, String, Expression>[]) Loads list items based up on a CAML query Declaration void LoadItemsByCamlQueryBatch(Batch batch, string query, params Expression>[] selectors) Parameters Batch batch Batch to add this request to String query query to execute Expression < Func < IListItem , System.Object >>[] selectors The expressions declaring the fields to select LoadItemsByCamlQueryBatch(String, Expression>[]) Loads list items based up on a CAML query Declaration void LoadItemsByCamlQueryBatch(string query, params Expression>[] selectors) Parameters String query query to execute Expression < Func < IListItem , System.Object >>[] selectors The expressions declaring the fields to select LoadItemsByCamlQueryBatchAsync(CamlQueryOptions, Expression>[]) Loads list items based up on a CAML query Declaration Task LoadItemsByCamlQueryBatchAsync(CamlQueryOptions queryOptions, params Expression>[] selectors) Parameters CamlQueryOptions queryOptions CamlQueryOptions defining the query to execute Expression < Func < IListItem , System.Object >>[] selectors The expressions declaring the fields to select Returns Task LoadItemsByCamlQueryBatchAsync(Batch, CamlQueryOptions, Expression>[]) Loads list items based up on a CAML query Declaration Task LoadItemsByCamlQueryBatchAsync(Batch batch, CamlQueryOptions queryOptions, params Expression>[] selectors) Parameters Batch batch Batch to add this request to CamlQueryOptions queryOptions CamlQueryOptions defining the query to execute Expression < Func < IListItem , System.Object >>[] selectors The expressions declaring the fields to select Returns Task LoadItemsByCamlQueryBatchAsync(Batch, String, Expression>[]) Loads list items based up on a CAML query Declaration Task LoadItemsByCamlQueryBatchAsync(Batch batch, string query, params Expression>[] selectors) Parameters Batch batch Batch to add this request to String query query to execute Expression < Func < IListItem , System.Object >>[] selectors The expressions declaring the fields to select Returns Task LoadItemsByCamlQueryBatchAsync(String, Expression>[]) Loads list items based up on a CAML query Declaration Task LoadItemsByCamlQueryBatchAsync(string query, params Expression>[] selectors) Parameters String query query to execute Expression < Func < IListItem , System.Object >>[] selectors The expressions declaring the fields to select Returns Task LoadListDataAsStream(RenderListDataOptions) Loads list items based up on a CAML query and the RenderListDataAsStream API Declaration Dictionary LoadListDataAsStream(RenderListDataOptions renderOptions) Parameters RenderListDataOptions renderOptions RenderListDataOptions defining the query to execute Returns Dictionary < String , System.Object > LoadListDataAsStreamAsync(RenderListDataOptions) Loads list items based up on a CAML query and the RenderListDataAsStream API Declaration Task> LoadListDataAsStreamAsync(RenderListDataOptions renderOptions) Parameters RenderListDataOptions renderOptions RenderListDataOptions defining the query to execute Returns Task < Dictionary < String , System.Object >> LoadListDataAsStreamBatch(RenderListDataOptions) Loads list items based up on a CAML query and the RenderListDataAsStream API Declaration IBatchSingleResult> LoadListDataAsStreamBatch(RenderListDataOptions renderOptions) Parameters RenderListDataOptions renderOptions RenderListDataOptions defining the query to execute Returns IBatchSingleResult < Dictionary < String , System.Object >> LoadListDataAsStreamBatch(Batch, RenderListDataOptions) Loads list items based up on a CAML query and the RenderListDataAsStream API Declaration IBatchSingleResult> LoadListDataAsStreamBatch(Batch batch, RenderListDataOptions renderOptions) Parameters Batch batch Batch to add this request to RenderListDataOptions renderOptions RenderListDataOptions defining the query to execute Returns IBatchSingleResult < Dictionary < String , System.Object >> LoadListDataAsStreamBatchAsync(RenderListDataOptions) Loads list items based up on a CAML query and the RenderListDataAsStream API Declaration Task>> LoadListDataAsStreamBatchAsync(RenderListDataOptions renderOptions) Parameters RenderListDataOptions renderOptions RenderListDataOptions defining the query to execute Returns Task < IBatchSingleResult < Dictionary < String , System.Object >>> LoadListDataAsStreamBatchAsync(Batch, RenderListDataOptions) Loads list items based up on a CAML query and the RenderListDataAsStream API Declaration Task>> LoadListDataAsStreamBatchAsync(Batch batch, RenderListDataOptions renderOptions) Parameters Batch batch Batch to add this request to RenderListDataOptions renderOptions RenderListDataOptions defining the query to execute Returns Task < IBatchSingleResult < Dictionary < String , System.Object >>> Recycle() Moves this list into the site collection recycle bin, returns the recyle bin item id Declaration Guid Recycle() Returns Guid Id of the recycle bin item RecycleAsync() Moves this list into the site collection recycle bin, returns the recyle bin item id Declaration Task RecycleAsync() Returns Task < Guid > Id of the recycle bin item RecycleBatch() Moves this list into the site collection recycle bin, returns the recyle bin item id Declaration IBatchSingleResult> RecycleBatch() Returns IBatchSingleResult < BatchResultValue < Guid >> Id of the recycle bin item RecycleBatch(Batch) Moves this list into the site collection recycle bin, returns the recyle bin item id Declaration IBatchSingleResult> RecycleBatch(Batch batch) Parameters Batch batch Batch to add the request to Returns IBatchSingleResult < BatchResultValue < Guid >> Id of the recycle bin item RecycleBatchAsync() Moves this list into the site collection recycle bin, returns the recyle bin item id Declaration Task>> RecycleBatchAsync() Returns Task < IBatchSingleResult < BatchResultValue < Guid >>> Id of the recycle bin item RecycleBatchAsync(Batch) Moves this list into the site collection recycle bin, returns the recyle bin item id Declaration Task>> RecycleBatchAsync(Batch batch) Parameters Batch batch Batch to add the request to Returns Task < IBatchSingleResult < BatchResultValue < Guid >>> Id of the recycle bin item ReIndex() Reindexes this list Declaration void ReIndex() ReIndexAsync() Reindexes this list Declaration Task ReIndexAsync() Returns Task ReorderContentTypes(List) Reorders the content types on the list. This controls the order of content types in the \"New\" menu and \"List Settings\" page Declaration void ReorderContentTypes(List contentTypeIdList) Parameters PnP.Core.Model.SharePoint.List < String > contentTypeIdList Ordered list of content type ids to set ReorderContentTypesAsync(List) Reorders the content types on the list. This controls the order of content types in the \"New\" menu and \"List Settings\" page Declaration Task ReorderContentTypesAsync(List contentTypeIdList) Parameters PnP.Core.Model.SharePoint.List < String > contentTypeIdList Ordered list of content type ids to set Returns Task SetComplianceTag(String, Boolean, Boolean, Boolean) Sets a compliance tag / retention label for this list Declaration void SetComplianceTag(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems) Parameters String complianceTagValue Compliance tag Boolean blockDelete Prevent deletion of the list (Hold) Boolean blockEdit Prevent editing of the list (Record) Boolean syncToItems If true the compliance tag is synced to the list items in this list SetComplianceTagAsync(String, Boolean, Boolean, Boolean) Sets a compliance tag / retention label for this list Declaration Task SetComplianceTagAsync(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems) Parameters String complianceTagValue Compliance tag Boolean blockDelete Prevent deletion of the list (Hold) Boolean blockEdit Prevent editing of the list (Record) Boolean syncToItems If true the compliance tag is synced to the list items in this list Returns Task SetComplianceTagBatch(Batch, String, Boolean, Boolean, Boolean) Sets a compliance tag / retention label for this list Declaration void SetComplianceTagBatch(Batch batch, string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems) Parameters Batch batch Batch to add this request to String complianceTagValue Compliance tag Boolean blockDelete Prevent deletion of the list (Hold) Boolean blockEdit Prevent editing of the list (Record) Boolean syncToItems If true the compliance tag is synced to the list items in this list SetComplianceTagBatch(String, Boolean, Boolean, Boolean) Sets a compliance tag / retention label for this list Declaration void SetComplianceTagBatch(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems) Parameters String complianceTagValue Compliance tag Boolean blockDelete Prevent deletion of the list (Hold) Boolean blockEdit Prevent editing of the list (Record) Boolean syncToItems If true the compliance tag is synced to the list items in this list SetComplianceTagBatchAsync(Batch, String, Boolean, Boolean, Boolean) Sets a compliance tag / retention label for this list Declaration Task SetComplianceTagBatchAsync(Batch batch, string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems) Parameters Batch batch Batch to add this request to String complianceTagValue Compliance tag Boolean blockDelete Prevent deletion of the list (Hold) Boolean blockEdit Prevent editing of the list (Record) Boolean syncToItems If true the compliance tag is synced to the list items in this list Returns Task SetComplianceTagBatchAsync(String, Boolean, Boolean, Boolean) Sets a compliance tag / retention label for this list Declaration Task SetComplianceTagBatchAsync(string complianceTagValue, bool blockDelete, bool blockEdit, bool syncToItems) Parameters String complianceTagValue Compliance tag Boolean blockDelete Prevent deletion of the list (Hold) Boolean blockEdit Prevent editing of the list (Record) Boolean syncToItems If true the compliance tag is synced to the list items in this list Returns Task SetDefaultColumnValues(List) Sets the default column value settings (at folder level) for this library Declaration void SetDefaultColumnValues(List defaultColumnValues) Parameters PnP.Core.Model.SharePoint.List < DefaultColumnValueOptions > defaultColumnValues List with default column values to set SetDefaultColumnValuesAsync(List) Sets the default column value settings (at folder level) for this library Declaration Task SetDefaultColumnValuesAsync(List defaultColumnValues) Parameters PnP.Core.Model.SharePoint.List < DefaultColumnValueOptions > defaultColumnValues List with default column values to set Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IListCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IListCollection.html", "title": "Interface IListCollection | PnP Core SDK", - "keywords": "Interface IListCollection Public interface to define a collection of List objects of SharePoint Online Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() IDataModelCollectionLoad.LoadAsync(Expression>[]) IDataModelCollectionLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelCollectionDeleteByGuidId.DeleteById(Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdAsync(Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdBatch(Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdBatchAsync(Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdBatch(Batch, Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdBatchAsync(Batch, Guid) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IListCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad, IDataModelCollectionDeleteByGuidId, ISupportModules Methods Add(String, ListTemplateType) Adds a new list Declaration IList Add(string title, ListTemplateType templateType) Parameters String title Title of the list ListTemplateType templateType Template type Returns IList Newly added list AddAsync(String, ListTemplateType) Adds a new list Declaration Task AddAsync(string title, ListTemplateType templateType) Parameters String title Title of the list ListTemplateType templateType Template type Returns Task < IList > Newly added list AddBatch(Batch, String, ListTemplateType) Adds a new list Declaration IList AddBatch(Batch batch, string title, ListTemplateType templateType) Parameters Batch batch Batch to use String title Title of the list ListTemplateType templateType Template type Returns IList Newly added list AddBatch(String, ListTemplateType) Adds a new list Declaration IList AddBatch(string title, ListTemplateType templateType) Parameters String title Title of the list ListTemplateType templateType Template type Returns IList Newly added list AddBatchAsync(Batch, String, ListTemplateType) Adds a new list Declaration Task AddBatchAsync(Batch batch, string title, ListTemplateType templateType) Parameters Batch batch Batch to use String title Title of the list ListTemplateType templateType Template type Returns Task < IList > Newly added list AddBatchAsync(String, ListTemplateType) Adds a new list Declaration Task AddBatchAsync(string title, ListTemplateType templateType) Parameters String title Title of the list ListTemplateType templateType Template type Returns Task < IList > Newly added list EnsureSiteAssetsLibrary(Expression>[]) Ensures there's an Asset Library in the site, if not present it will be created Declaration IList EnsureSiteAssetsLibrary(params Expression>[] selectors) Parameters Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns IList The asset library EnsureSiteAssetsLibraryAsync(Expression>[]) Ensures there's an Asset Library in the site, if not present it will be created Declaration Task EnsureSiteAssetsLibraryAsync(params Expression>[] selectors) Parameters Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The asset library EnsureSiteAssetsLibraryBatch(Expression>[]) Ensures there's an Asset Library in the site, if not present it will be created Declaration IList EnsureSiteAssetsLibraryBatch(params Expression>[] selectors) Parameters Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns IList The asset library EnsureSiteAssetsLibraryBatch(Batch, Expression>[]) Ensures there's an Asset Library in the site, if not present it will be created Declaration IList EnsureSiteAssetsLibraryBatch(Batch batch, params Expression>[] selectors) Parameters Batch batch Batch to add this request to Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns IList The asset library EnsureSiteAssetsLibraryBatchAsync(Expression>[]) Ensures there's an Asset Library in the site, if not present it will be created Declaration Task EnsureSiteAssetsLibraryBatchAsync(params Expression>[] selectors) Parameters Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The asset library EnsureSiteAssetsLibraryBatchAsync(Batch, Expression>[]) Ensures there's an Asset Library in the site, if not present it will be created Declaration Task EnsureSiteAssetsLibraryBatchAsync(Batch batch, params Expression>[] selectors) Parameters Batch batch Batch to add this request to Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The asset library GetById(Guid, Expression>[]) Method to select a list by id Declaration IList GetById(Guid id, params Expression>[] selectors) Parameters Guid id The id to search for Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByIdAsync(Guid, Expression>[]) Method to select a list by id Declaration Task GetByIdAsync(Guid id, params Expression>[] selectors) Parameters Guid id The id to search for Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any GetByIdBatch(Guid, Expression>[]) Method to select a list by id Declaration IList GetByIdBatch(Guid id, params Expression>[] selectors) Parameters Guid id The id to search for Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByIdBatch(Batch, Guid, Expression>[]) Method to select a list by id Declaration IList GetByIdBatch(Batch batch, Guid id, params Expression>[] selectors) Parameters Batch batch Batch to add this request to Guid id The id to search for Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByIdBatchAsync(Guid, Expression>[]) Method to select a list by id Declaration Task GetByIdBatchAsync(Guid id, params Expression>[] selectors) Parameters Guid id The id to search for Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any GetByIdBatchAsync(Batch, Guid, Expression>[]) Method to select a list by id Declaration Task GetByIdBatchAsync(Batch batch, Guid id, params Expression>[] selectors) Parameters Batch batch Batch to add this request to Guid id The id to search for Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any GetByServerRelativeUrl(String, Expression>[]) Method to select a list by server relative url Declaration IList GetByServerRelativeUrl(string serverRelativeUrl, params Expression>[] selectors) Parameters String serverRelativeUrl The server relative url of the list to return Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByServerRelativeUrlAsync(String, Expression>[]) Method to select a list by server relative url Declaration Task GetByServerRelativeUrlAsync(string serverRelativeUrl, params Expression>[] selectors) Parameters String serverRelativeUrl The server relative url of the list to return Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any GetByServerRelativeUrlBatch(Batch, String, Expression>[]) Method to select a list by server relative url Declaration IList GetByServerRelativeUrlBatch(Batch batch, string serverRelativeUrl, params Expression>[] selectors) Parameters Batch batch Batch to add this request to String serverRelativeUrl The server relative url of the list to return Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByServerRelativeUrlBatch(String, Expression>[]) Method to select a list by server relative url Declaration IList GetByServerRelativeUrlBatch(string serverRelativeUrl, params Expression>[] selectors) Parameters String serverRelativeUrl The server relative url of the list to return Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByServerRelativeUrlBatchAsync(Batch, String, Expression>[]) Method to select a list by server relative url Declaration Task GetByServerRelativeUrlBatchAsync(Batch batch, string serverRelativeUrl, params Expression>[] selectors) Parameters Batch batch Batch to add this request to String serverRelativeUrl The server relative url of the list to return Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any GetByServerRelativeUrlBatchAsync(String, Expression>[]) Method to select a list by server relative url Declaration Task GetByServerRelativeUrlBatchAsync(string serverRelativeUrl, params Expression>[] selectors) Parameters String serverRelativeUrl The server relative url of the list to return Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any GetByTitle(String, Expression>[]) Select a list by title Declaration IList GetByTitle(string title, params Expression>[] selectors) Parameters String title The title to search for Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByTitleAsync(String, Expression>[]) Select a list by title Declaration Task GetByTitleAsync(string title, params Expression>[] selectors) Parameters String title The title to search for Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any GetByTitleBatch(Batch, String, Expression>[]) Select a list by title Declaration IList GetByTitleBatch(Batch batch, string title, params Expression>[] selectors) Parameters Batch batch Batch to add this request to String title The title to search for Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByTitleBatch(String, Expression>[]) Select a list by title Declaration IList GetByTitleBatch(string title, params Expression>[] selectors) Parameters String title The title to search for Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByTitleBatchAsync(Batch, String, Expression>[]) Select a list by title Declaration Task GetByTitleBatchAsync(Batch batch, string title, params Expression>[] selectors) Parameters Batch batch Batch to add this request to String title The title to search for Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any GetByTitleBatchAsync(String, Expression>[]) Select a list by title Declaration Task GetByTitleBatchAsync(string title, params Expression>[] selectors) Parameters String title The title to search for Expression < Func < IList , Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any Extension Methods DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.Load(IDataModelCollectionLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" + "keywords": "Interface IListCollection Public interface to define a collection of List objects of SharePoint Online Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() IDataModelCollectionLoad.LoadAsync(Expression>[]) IDataModelCollectionLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelCollectionDeleteByGuidId.DeleteById(Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdAsync(Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdBatch(Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdBatchAsync(Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdBatch(Batch, Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdBatchAsync(Batch, Guid) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IListCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad, IDataModelCollectionDeleteByGuidId, ISupportModules Methods Add(String, ListTemplateType) Adds a new list Declaration IList Add(string title, ListTemplateType templateType) Parameters String title Title of the list ListTemplateType templateType Template type Returns IList Newly added list AddAsync(String, ListTemplateType) Adds a new list Declaration Task AddAsync(string title, ListTemplateType templateType) Parameters String title Title of the list ListTemplateType templateType Template type Returns Task < IList > Newly added list AddBatch(Batch, String, ListTemplateType) Adds a new list Declaration IList AddBatch(Batch batch, string title, ListTemplateType templateType) Parameters Batch batch Batch to use String title Title of the list ListTemplateType templateType Template type Returns IList Newly added list AddBatch(String, ListTemplateType) Adds a new list Declaration IList AddBatch(string title, ListTemplateType templateType) Parameters String title Title of the list ListTemplateType templateType Template type Returns IList Newly added list AddBatchAsync(Batch, String, ListTemplateType) Adds a new list Declaration Task AddBatchAsync(Batch batch, string title, ListTemplateType templateType) Parameters Batch batch Batch to use String title Title of the list ListTemplateType templateType Template type Returns Task < IList > Newly added list AddBatchAsync(String, ListTemplateType) Adds a new list Declaration Task AddBatchAsync(string title, ListTemplateType templateType) Parameters String title Title of the list ListTemplateType templateType Template type Returns Task < IList > Newly added list EnsureSiteAssetsLibrary(Expression>[]) Ensures there's an Asset Library in the site, if not present it will be created Declaration IList EnsureSiteAssetsLibrary(params Expression>[] selectors) Parameters Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns IList The asset library EnsureSiteAssetsLibraryAsync(Expression>[]) Ensures there's an Asset Library in the site, if not present it will be created Declaration Task EnsureSiteAssetsLibraryAsync(params Expression>[] selectors) Parameters Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The asset library EnsureSiteAssetsLibraryBatch(Expression>[]) Ensures there's an Asset Library in the site, if not present it will be created Declaration IList EnsureSiteAssetsLibraryBatch(params Expression>[] selectors) Parameters Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns IList The asset library EnsureSiteAssetsLibraryBatch(Batch, Expression>[]) Ensures there's an Asset Library in the site, if not present it will be created Declaration IList EnsureSiteAssetsLibraryBatch(Batch batch, params Expression>[] selectors) Parameters Batch batch Batch to add this request to Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns IList The asset library EnsureSiteAssetsLibraryBatchAsync(Expression>[]) Ensures there's an Asset Library in the site, if not present it will be created Declaration Task EnsureSiteAssetsLibraryBatchAsync(params Expression>[] selectors) Parameters Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The asset library EnsureSiteAssetsLibraryBatchAsync(Batch, Expression>[]) Ensures there's an Asset Library in the site, if not present it will be created Declaration Task EnsureSiteAssetsLibraryBatchAsync(Batch batch, params Expression>[] selectors) Parameters Batch batch Batch to add this request to Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The asset library GetById(Guid, Expression>[]) Method to select a list by id Declaration IList GetById(Guid id, params Expression>[] selectors) Parameters Guid id The id to search for Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByIdAsync(Guid, Expression>[]) Method to select a list by id Declaration Task GetByIdAsync(Guid id, params Expression>[] selectors) Parameters Guid id The id to search for Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any GetByIdBatch(Guid, Expression>[]) Method to select a list by id Declaration IList GetByIdBatch(Guid id, params Expression>[] selectors) Parameters Guid id The id to search for Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByIdBatch(Batch, Guid, Expression>[]) Method to select a list by id Declaration IList GetByIdBatch(Batch batch, Guid id, params Expression>[] selectors) Parameters Batch batch Batch to add this request to Guid id The id to search for Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByIdBatchAsync(Guid, Expression>[]) Method to select a list by id Declaration Task GetByIdBatchAsync(Guid id, params Expression>[] selectors) Parameters Guid id The id to search for Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any GetByIdBatchAsync(Batch, Guid, Expression>[]) Method to select a list by id Declaration Task GetByIdBatchAsync(Batch batch, Guid id, params Expression>[] selectors) Parameters Batch batch Batch to add this request to Guid id The id to search for Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any GetByServerRelativeUrl(String, Expression>[]) Method to select a list by server relative url Declaration IList GetByServerRelativeUrl(string serverRelativeUrl, params Expression>[] selectors) Parameters String serverRelativeUrl The server relative url of the list to return Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByServerRelativeUrlAsync(String, Expression>[]) Method to select a list by server relative url Declaration Task GetByServerRelativeUrlAsync(string serverRelativeUrl, params Expression>[] selectors) Parameters String serverRelativeUrl The server relative url of the list to return Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any GetByServerRelativeUrlBatch(Batch, String, Expression>[]) Method to select a list by server relative url Declaration IList GetByServerRelativeUrlBatch(Batch batch, string serverRelativeUrl, params Expression>[] selectors) Parameters Batch batch Batch to add this request to String serverRelativeUrl The server relative url of the list to return Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByServerRelativeUrlBatch(String, Expression>[]) Method to select a list by server relative url Declaration IList GetByServerRelativeUrlBatch(string serverRelativeUrl, params Expression>[] selectors) Parameters String serverRelativeUrl The server relative url of the list to return Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByServerRelativeUrlBatchAsync(Batch, String, Expression>[]) Method to select a list by server relative url Declaration Task GetByServerRelativeUrlBatchAsync(Batch batch, string serverRelativeUrl, params Expression>[] selectors) Parameters Batch batch Batch to add this request to String serverRelativeUrl The server relative url of the list to return Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any GetByServerRelativeUrlBatchAsync(String, Expression>[]) Method to select a list by server relative url Declaration Task GetByServerRelativeUrlBatchAsync(string serverRelativeUrl, params Expression>[] selectors) Parameters String serverRelativeUrl The server relative url of the list to return Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any GetByTitle(String, Expression>[]) Select a list by title Declaration IList GetByTitle(string title, params Expression>[] selectors) Parameters String title The title to search for Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByTitleAsync(String, Expression>[]) Select a list by title Declaration Task GetByTitleAsync(string title, params Expression>[] selectors) Parameters String title The title to search for Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any GetByTitleBatch(Batch, String, Expression>[]) Select a list by title Declaration IList GetByTitleBatch(Batch batch, string title, params Expression>[] selectors) Parameters Batch batch Batch to add this request to String title The title to search for Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByTitleBatch(String, Expression>[]) Select a list by title Declaration IList GetByTitleBatch(string title, params Expression>[] selectors) Parameters String title The title to search for Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns IList The resulting list instance, if any GetByTitleBatchAsync(Batch, String, Expression>[]) Select a list by title Declaration Task GetByTitleBatchAsync(Batch batch, string title, params Expression>[] selectors) Parameters Batch batch Batch to add this request to String title The title to search for Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any GetByTitleBatchAsync(String, Expression>[]) Select a list by title Declaration Task GetByTitleBatchAsync(string title, params Expression>[] selectors) Parameters String title The title to search for Expression < Func < IList , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < IList > The resulting list instance, if any Extension Methods DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.Load(IDataModelCollectionLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" }, "api/PnP.Core.Model.SharePoint.IListItem.html": { "href": "api/PnP.Core.Model.SharePoint.IListItem.html", "title": "Interface IListItem | PnP Core SDK", - "keywords": "Interface IListItem Public interface to define a SharePoint Online list item Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() IDataModelSupportingGetChanges.GetChangesAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChanges(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(ChangeQueryOptions) ISecurableObject.RoleAssignments ISecurableObject.HasUniqueRoleAssignments ISecurableObject.BreakRoleInheritance(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceAsync(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatch(Batch, Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatchAsync(Batch, Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatch(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatchAsync(Boolean, Boolean) ISecurableObject.ResetRoleInheritance() ISecurableObject.ResetRoleInheritanceAsync() ISecurableObject.ResetRoleInheritanceBatch(Batch) ISecurableObject.ResetRoleInheritanceBatchAsync(Batch) ISecurableObject.ResetRoleInheritanceBatch() ISecurableObject.ResetRoleInheritanceBatchAsync() ISecurableObject.GetRoleDefinitions(Int32) ISecurableObject.GetRoleDefinitionsAsync(Int32) ISecurableObject.AddRoleDefinitions(Int32, String[]) ISecurableObject.AddRoleDefinitionsAsync(Int32, String[]) ISecurableObject.AddRoleDefinition(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionAsync(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatch(Batch, Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatch(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatchAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitions(Int32, String[]) ISecurableObject.RemoveRoleDefinitionsAsync(Int32, String[]) ISecurableObject.RemoveRoleDefinition(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatch(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatchAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatch(Batch, Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition) IExpandoDataModel.Item[String] IExpandoDataModel.Values IExpandoDataModel.Count IExpandoDataModel.AsDynamic() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IListItem : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IDataModelSupportingGetChanges, ISecurableObject, IExpandoDataModel, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object AttachmentFiles Collection of attachments for this list item Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IAttachmentCollection AttachmentFiles { get; } Property Value IAttachmentCollection CommentsDisabled Determines if comments are disabled for the list item Declaration bool CommentsDisabled { get; } Property Value Boolean CommentsDisabledScope The scope for which comments are disabled Declaration CommentsDisabledScope CommentsDisabledScope { get; } Property Value CommentsDisabledScope ContentType The content type for the list item Declaration IContentType ContentType { get; } Property Value IContentType FieldValuesAsHtml All the field values for the list item as HTML Declaration IFieldStringValues FieldValuesAsHtml { get; } Property Value IFieldStringValues FieldValuesAsText All the field values for the list item as text Declaration IFieldStringValues FieldValuesAsText { get; } Property Value IFieldStringValues FieldValuesForEdit All the field values for the list item for editing Declaration IFieldStringValues FieldValuesForEdit { get; } Property Value IFieldStringValues File The file, if any, associated with the list item Declaration IFile File { get; } Property Value IFile FileSystemObjectType The FileSystemObjectType for the list item, such as Folder or File Declaration FileSystemObjectType FileSystemObjectType { get; } Property Value FileSystemObjectType Folder The folder, if any, represented by the list item Declaration IFolder Folder { get; } Property Value IFolder Id Id of the list item Declaration int Id { get; } Property Value Int32 LikedByInformation Information about the likes on this list item Declaration ILikedByInformation LikedByInformation { get; } Property Value ILikedByInformation ParentList The list for the list item Declaration IList ParentList { get; } Property Value IList Properties The properties of the list item Declaration IPropertyValues Properties { get; } Property Value IPropertyValues ServerRedirectedEmbedUri The URI used to render the WOPI (Web Application Open Platform Interface) frame Declaration string ServerRedirectedEmbedUri { get; } Property Value String ServerRedirectedEmbedUrl The URL used to render the WOPI (Web Application Open Platform Interface) frame Declaration string ServerRedirectedEmbedUrl { get; } Property Value String Title Title value of the list item Declaration string Title { get; set; } Property Value String UniqueId The unique identifier of the list item Declaration Guid UniqueId { get; } Property Value Guid Versions Gets a value that returns a collection of list item version objects that represent the versions of the list item Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IListItemVersionCollection Versions { get; } Property Value IListItemVersionCollection Methods AreCommentsDisabled() Are comments disabled for this IListItem ? Declaration bool AreCommentsDisabled() Returns Boolean True if disabled, false otherwise AreCommentsDisabledAsync() Are comments disabled for this IListItem ? Declaration Task AreCommentsDisabledAsync() Returns Task < Boolean > True if disabled, false otherwise CheckIfUserHasPermissions(String, PermissionKind) Checks if a user has a specific kind of permissions to a listitem Declaration bool CheckIfUserHasPermissions(string userPrincipalName, PermissionKind permissionKind) Parameters String userPrincipalName Login name of the user you wish to check if he has a specific permission PermissionKind permissionKind Permission kind to check Returns Boolean Boolean that says if the user has permissions or not CheckIfUserHasPermissionsAsync(String, PermissionKind) Checks if a user has a specific kind of permissions to a listitem Declaration Task CheckIfUserHasPermissionsAsync(string userPrincipalName, PermissionKind permissionKind) Parameters String userPrincipalName Login name of the user you wish to check if he has a specific permission PermissionKind permissionKind Permission kind to check Returns Task < Boolean > Boolean that says if the user has permissions or not CreateAnonymousSharingLink(AnonymousLinkOptions) Creates an anonymous sharing link for a list item Declaration IGraphPermission CreateAnonymousSharingLink(AnonymousLinkOptions anonymousLinkOptions) Parameters AnonymousLinkOptions anonymousLinkOptions Returns IGraphPermission Permission that has been created CreateAnonymousSharingLinkAsync(AnonymousLinkOptions) Creates an anonymous sharing link for a list item Declaration Task CreateAnonymousSharingLinkAsync(AnonymousLinkOptions anonymousLinkOptions) Parameters AnonymousLinkOptions anonymousLinkOptions Returns Task < IGraphPermission > Permission that has been created CreateOrganizationalSharingLink(OrganizationalLinkOptions) Creates an organization sharing link for a list item Declaration IGraphPermission CreateOrganizationalSharingLink(OrganizationalLinkOptions organizationalLinkOptions) Parameters OrganizationalLinkOptions organizationalLinkOptions Returns IGraphPermission Permission that has been created CreateOrganizationalSharingLinkAsync(OrganizationalLinkOptions) Creates an organization sharing link for a list item Declaration Task CreateOrganizationalSharingLinkAsync(OrganizationalLinkOptions organizationalLinkOptions) Parameters OrganizationalLinkOptions organizationalLinkOptions Returns Task < IGraphPermission > Permission that has been created CreateUserSharingLink(UserLinkOptions) Creates a user sharing link for a list item Declaration IGraphPermission CreateUserSharingLink(UserLinkOptions userLinkOptions) Parameters UserLinkOptions userLinkOptions Returns IGraphPermission Permission that has been created CreateUserSharingLinkAsync(UserLinkOptions) Creates a user sharing link for a list item Declaration Task CreateUserSharingLinkAsync(UserLinkOptions userLinkOptions) Parameters UserLinkOptions userLinkOptions Returns Task < IGraphPermission > Permission that has been created GetComments(Expression>[]) Get list item comments Declaration ICommentCollection GetComments(params Expression>[] selectors) Parameters Expression < Func < IComment , Object >>[] selectors The expressions declaring the fields to select Returns ICommentCollection GetCommentsAsync(Expression>[]) Get list item comments Declaration Task GetCommentsAsync(params Expression>[] selectors) Parameters Expression < Func < IComment , Object >>[] selectors The expressions declaring the fields to select Returns Task < ICommentCollection > GetDisplayName() Gets the display name of the list item. Declaration string GetDisplayName() Returns String The display name or null . GetDisplayNameAsync() Gets the display name of the list item. Declaration Task GetDisplayNameAsync() Returns Task < String > The display name or null . GetParentFolder() Returns the IFolder that holds this item Declaration IFolder GetParentFolder() Returns IFolder The IFolder for this item is returned, if the item itself is a folder then the item is returned as IFolder . GetParentFolderAsync() Returns the IFolder that holds this item Declaration Task GetParentFolderAsync() Returns Task < IFolder > The IFolder for this item is returned, if the item itself is a folder then the item is returned as IFolder . GetUserEffectivePermissions(String) Gets the user effective permissions of a user for a listitem Declaration IBasePermissions GetUserEffectivePermissions(string userPrincipalName) Parameters String userPrincipalName Login name of the user you wish to retrieve the permissions of Returns IBasePermissions Base permissions object that contains the High and the Low permissions GetUserEffectivePermissionsAsync(String) Gets the user effective permissions of a user for a listitem Declaration Task GetUserEffectivePermissionsAsync(string userPrincipalName) Parameters String userPrincipalName Login name of the user you wish to retrieve the permissions of Returns Task < IBasePermissions > Base permissions object that contains the High and the Low permissions IsFile() Checks if this IListItem is a file Declaration bool IsFile() Returns Boolean Returns true if this IListItem is a file. IsFileAsync() Checks if this IListItem is a file Declaration Task IsFileAsync() Returns Task < Boolean > Returns true if this IListItem is a file. IsFolder() Checks if this IListItem is a folder Declaration bool IsFolder() Returns Boolean Returns true if this IListItem is a folder. IsFolderAsync() Checks if this IListItem is a folder Declaration Task IsFolderAsync() Returns Task < Boolean > Returns true if this IListItem is a folder. MoveTo(String) Moves this ListItem to another folder in this list Declaration void MoveTo(string destinationFolderUrl) Parameters String destinationFolderUrl Folder path within this list, e.g. 'subfolder1/subfolder2' MoveToAsync(String) Moves this ListItem to another folder in this list Declaration Task MoveToAsync(string destinationFolderUrl) Parameters String destinationFolderUrl Folder path within this list, e.g. 'subfolder1/subfolder2' Returns Task NewFieldLookupValue(IField, Int32) Creates a new IFieldLookupValue object Declaration IFieldLookupValue NewFieldLookupValue(IField fieldToUpdate, int lookupId) Parameters IField fieldToUpdate IField representing the field to set Int32 lookupId Id of the lookup value Returns IFieldLookupValue Configured IFieldLookupValue object NewFieldTaxonomyValue(IField, Guid, String, Int32) Creates a new IFieldTaxonomyValue object Declaration IFieldTaxonomyValue NewFieldTaxonomyValue(IField fieldToUpdate, Guid termId, string label, int wssId = null) Parameters IField fieldToUpdate IField representing the field to set Guid termId Name of the term to set String label Label of the term to set Int32 wssId Optionally provide the wssId value Returns IFieldTaxonomyValue Configured IFieldTaxonomyValue object NewFieldUrlValue(IField, String, String) Creates a new IFieldUrlValue object Declaration IFieldUrlValue NewFieldUrlValue(IField fieldToUpdate, string url, string description = null) Parameters IField fieldToUpdate IField representing the field to set String url Url value String description Optional description value Returns IFieldUrlValue Configured IFieldUrlValue object NewFieldUserValue(IField, ISharePointPrincipal) Creates a new IFieldUserValue object Declaration IFieldUserValue NewFieldUserValue(IField fieldToUpdate, ISharePointPrincipal principal) Parameters IField fieldToUpdate IField representing the field to set ISharePointPrincipal principal ISharePointUser or ISharePointGroup Returns IFieldUserValue Configured IFieldUserValue object NewFieldUserValue(IField, Int32) Creates a new IFieldUserValue object Declaration IFieldUserValue NewFieldUserValue(IField fieldToUpdate, int userId) Parameters IField fieldToUpdate IField representing the field to set Int32 userId Id of the user Returns IFieldUserValue Configured IFieldUserValue object NewFieldValueCollection(IField) Creates a new collection to hold IFieldValue objects Declaration IFieldValueCollection NewFieldValueCollection(IField fieldToUpdate) Parameters IField fieldToUpdate IField representing the field to set Returns IFieldValueCollection Recycle() Recycle the current item Declaration Guid Recycle() Returns Guid RecycleAsync() Recycle the current item Declaration Task RecycleAsync() Returns Task < Guid > RecycleBatch() Recycle the current item Declaration IBatchSingleResult> RecycleBatch() Returns IBatchSingleResult < BatchResultValue < Guid >> RecycleBatch(Batch) Recycle the current item Declaration IBatchSingleResult> RecycleBatch(Batch batch) Parameters Batch batch Batch to add the request to Returns IBatchSingleResult < BatchResultValue < Guid >> RecycleBatchAsync() Recycle the current item Declaration Task>> RecycleBatchAsync() Returns Task < IBatchSingleResult < BatchResultValue < Guid >>> RecycleBatchAsync(Batch) Recycle the current item Declaration Task>> RecycleBatchAsync(Batch batch) Parameters Batch batch Batch to add the request to Returns Task < IBatchSingleResult < BatchResultValue < Guid >>> SetCommentsDisabled(Boolean) Enable/Disable comments for this list item Declaration void SetCommentsDisabled(bool commentsDisabled) Parameters Boolean commentsDisabled Do comments need to enabled or disabled SetCommentsDisabledAsync(Boolean) Enable/Disable comments for this list item Declaration Task SetCommentsDisabledAsync(bool commentsDisabled) Parameters Boolean commentsDisabled Do comments need to enabled or disabled Returns Task SetComplianceTag(String, Boolean, Boolean, Boolean, Boolean) Sets a compliancetag / retention label for this list item Declaration void SetComplianceTag(string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock) Parameters String complianceTag The tag/label to set for this list item Boolean isTagPolicyHold Whether the tag is hold Boolean isTagPolicyRecord Whether the tag is record Boolean isEventBasedTag Whether the tag is Event based, this is not used Boolean isTagSuperLock Whether the tag is Sec 17 tag,no allow change even for site admin SetComplianceTagAsync(String, Boolean, Boolean, Boolean, Boolean) Sets a compliancetag / retention label for this list item Declaration Task SetComplianceTagAsync(string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock) Parameters String complianceTag The tag/label to set for this list item Boolean isTagPolicyHold Whether the tag is hold Boolean isTagPolicyRecord Whether the tag is record Boolean isEventBasedTag Whether the tag is Event based, this is not used Boolean isTagSuperLock Whether the tag is Sec 17 tag,no allow change even for site admin Returns Task SetComplianceTagBatch(Batch, String, Boolean, Boolean, Boolean, Boolean) Sets a compliancetag / retention label for this list item Declaration void SetComplianceTagBatch(Batch batch, string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock) Parameters Batch batch Batch to add the request to String complianceTag The tag/label to set for this list item Boolean isTagPolicyHold Whether the tag is hold Boolean isTagPolicyRecord Whether the tag is record Boolean isEventBasedTag Whether the tag is Event based, this is not used Boolean isTagSuperLock Whether the tag is Sec 17 tag,no allow change even for site admin SetComplianceTagBatch(String, Boolean, Boolean, Boolean, Boolean) Sets a compliancetag / retention label for this list item Declaration void SetComplianceTagBatch(string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock) Parameters String complianceTag The tag/label to set for this list item Boolean isTagPolicyHold Whether the tag is hold Boolean isTagPolicyRecord Whether the tag is record Boolean isEventBasedTag Whether the tag is Event based, this is not used Boolean isTagSuperLock Whether the tag is Sec 17 tag,no allow change even for site admin SetComplianceTagBatchAsync(Batch, String, Boolean, Boolean, Boolean, Boolean) Sets a compliancetag / retention label for this list item Declaration Task SetComplianceTagBatchAsync(Batch batch, string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock) Parameters Batch batch Batch to add the request to String complianceTag The tag/label to set for this list item Boolean isTagPolicyHold Whether the tag is hold Boolean isTagPolicyRecord Whether the tag is record Boolean isEventBasedTag Whether the tag is Event based, this is not used Boolean isTagSuperLock Whether the tag is Sec 17 tag,no allow change even for site admin Returns Task SetComplianceTagBatchAsync(String, Boolean, Boolean, Boolean, Boolean) Sets a compliancetag / retention label for this list item Declaration Task SetComplianceTagBatchAsync(string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock) Parameters String complianceTag The tag/label to set for this list item Boolean isTagPolicyHold Whether the tag is hold Boolean isTagPolicyRecord Whether the tag is record Boolean isEventBasedTag Whether the tag is Event based, this is not used Boolean isTagSuperLock Whether the tag is Sec 17 tag,no allow change even for site admin Returns Task SystemUpdate() Performs a system update of the list item Declaration void SystemUpdate() SystemUpdateAsync() Performs a system update of the list item Declaration Task SystemUpdateAsync() Returns Task SystemUpdateBatch() Performs a system update of the list item Declaration void SystemUpdateBatch() SystemUpdateBatch(Batch) Performs a system update of the list item Declaration void SystemUpdateBatch(Batch batch) Parameters Batch batch Batch to add the systemupdate request to SystemUpdateBatchAsync() Performs a system update of the list item Declaration Task SystemUpdateBatchAsync() Returns Task SystemUpdateBatchAsync(Batch) Performs a system update of the list item Declaration Task SystemUpdateBatchAsync(Batch batch) Parameters Batch batch Batch to add the systemupdate request to Returns Task UpdateOverwriteVersion() Performs a UpdateOverwriteVersion of the list item Declaration void UpdateOverwriteVersion() UpdateOverwriteVersionAsync() Performs a UpdateOverwriteVersion of the list item Declaration Task UpdateOverwriteVersionAsync() Returns Task UpdateOverwriteVersionBatch() Performs a UpdateOverwriteVersion of the list item Declaration void UpdateOverwriteVersionBatch() UpdateOverwriteVersionBatch(Batch) Performs a UpdateOverwriteVersion of the list item Declaration void UpdateOverwriteVersionBatch(Batch batch) Parameters Batch batch Batch to add the UpdateOverwriteVersion request to UpdateOverwriteVersionBatchAsync() Performs a UpdateOverwriteVersion of the list item Declaration Task UpdateOverwriteVersionBatchAsync() Returns Task UpdateOverwriteVersionBatchAsync(Batch) Performs a UpdateOverwriteVersion of the list item Declaration Task UpdateOverwriteVersionBatchAsync(Batch batch) Parameters Batch batch Batch to add the UpdateOverwriteVersion request to Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IListItem Public interface to define a SharePoint Online list item Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() IDataModelSupportingGetChanges.GetChangesAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChanges(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(ChangeQueryOptions) ISecurableObject.RoleAssignments ISecurableObject.HasUniqueRoleAssignments ISecurableObject.BreakRoleInheritance(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceAsync(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatch(Batch, Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatchAsync(Batch, Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatch(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatchAsync(Boolean, Boolean) ISecurableObject.ResetRoleInheritance() ISecurableObject.ResetRoleInheritanceAsync() ISecurableObject.ResetRoleInheritanceBatch(Batch) ISecurableObject.ResetRoleInheritanceBatchAsync(Batch) ISecurableObject.ResetRoleInheritanceBatch() ISecurableObject.ResetRoleInheritanceBatchAsync() ISecurableObject.GetRoleDefinitions(Int32) ISecurableObject.GetRoleDefinitionsAsync(Int32) ISecurableObject.AddRoleDefinitions(Int32, String[]) ISecurableObject.AddRoleDefinitionsAsync(Int32, String[]) ISecurableObject.AddRoleDefinition(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionAsync(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatch(Batch, Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatch(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatchAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitions(Int32, String[]) ISecurableObject.RemoveRoleDefinitionsAsync(Int32, String[]) ISecurableObject.RemoveRoleDefinition(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatch(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatchAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatch(Batch, Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition) IExpandoDataModel.Item[String] IExpandoDataModel.Values IExpandoDataModel.Count IExpandoDataModel.AsDynamic() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IListItem : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IDataModelSupportingGetChanges, ISecurableObject, IExpandoDataModel, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object AttachmentFiles Collection of attachments for this list item Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IAttachmentCollection AttachmentFiles { get; } Property Value IAttachmentCollection CommentsDisabled Determines if comments are disabled for the list item Declaration bool CommentsDisabled { get; } Property Value Boolean CommentsDisabledScope The scope for which comments are disabled Declaration CommentsDisabledScope CommentsDisabledScope { get; } Property Value CommentsDisabledScope ContentType The content type for the list item Declaration IContentType ContentType { get; } Property Value IContentType FieldValuesAsHtml All the field values for the list item as HTML Declaration IFieldStringValues FieldValuesAsHtml { get; } Property Value IFieldStringValues FieldValuesAsText All the field values for the list item as text Declaration IFieldStringValues FieldValuesAsText { get; } Property Value IFieldStringValues FieldValuesForEdit All the field values for the list item for editing Declaration IFieldStringValues FieldValuesForEdit { get; } Property Value IFieldStringValues File The file, if any, associated with the list item Declaration IFile File { get; } Property Value IFile FileSystemObjectType The FileSystemObjectType for the list item, such as Folder or File Declaration FileSystemObjectType FileSystemObjectType { get; } Property Value FileSystemObjectType Folder The folder, if any, represented by the list item Declaration IFolder Folder { get; } Property Value IFolder Id Id of the list item Declaration int Id { get; } Property Value Int32 LikedByInformation Information about the likes on this list item Declaration ILikedByInformation LikedByInformation { get; } Property Value ILikedByInformation ParentList The list for the list item Declaration IList ParentList { get; } Property Value IList Properties The properties of the list item Declaration IPropertyValues Properties { get; } Property Value IPropertyValues ServerRedirectedEmbedUri The URI used to render the WOPI (Web Application Open Platform Interface) frame Declaration string ServerRedirectedEmbedUri { get; } Property Value String ServerRedirectedEmbedUrl The URL used to render the WOPI (Web Application Open Platform Interface) frame Declaration string ServerRedirectedEmbedUrl { get; } Property Value String Title Title value of the list item Declaration string Title { get; set; } Property Value String UniqueId The unique identifier of the list item Declaration Guid UniqueId { get; } Property Value Guid Versions Gets a value that returns a collection of list item version objects that represent the versions of the list item Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IListItemVersionCollection Versions { get; } Property Value IListItemVersionCollection Methods AreCommentsDisabled() Are comments disabled for this IListItem ? Declaration bool AreCommentsDisabled() Returns Boolean True if disabled, false otherwise AreCommentsDisabledAsync() Are comments disabled for this IListItem ? Declaration Task AreCommentsDisabledAsync() Returns Task < Boolean > True if disabled, false otherwise CheckIfUserHasPermissions(String, PermissionKind) Checks if a user has a specific kind of permissions to a listitem Declaration bool CheckIfUserHasPermissions(string userPrincipalName, PermissionKind permissionKind) Parameters String userPrincipalName Login name of the user you wish to check if he has a specific permission PermissionKind permissionKind Permission kind to check Returns Boolean Boolean that says if the user has permissions or not CheckIfUserHasPermissionsAsync(String, PermissionKind) Checks if a user has a specific kind of permissions to a listitem Declaration Task CheckIfUserHasPermissionsAsync(string userPrincipalName, PermissionKind permissionKind) Parameters String userPrincipalName Login name of the user you wish to check if he has a specific permission PermissionKind permissionKind Permission kind to check Returns Task < Boolean > Boolean that says if the user has permissions or not CreateAnonymousSharingLink(AnonymousLinkOptions) Creates an anonymous sharing link for a list item Declaration IGraphPermission CreateAnonymousSharingLink(AnonymousLinkOptions anonymousLinkOptions) Parameters AnonymousLinkOptions anonymousLinkOptions Returns IGraphPermission Permission that has been created CreateAnonymousSharingLinkAsync(AnonymousLinkOptions) Creates an anonymous sharing link for a list item Declaration Task CreateAnonymousSharingLinkAsync(AnonymousLinkOptions anonymousLinkOptions) Parameters AnonymousLinkOptions anonymousLinkOptions Returns Task < IGraphPermission > Permission that has been created CreateOrganizationalSharingLink(OrganizationalLinkOptions) Creates an organization sharing link for a list item Declaration IGraphPermission CreateOrganizationalSharingLink(OrganizationalLinkOptions organizationalLinkOptions) Parameters OrganizationalLinkOptions organizationalLinkOptions Returns IGraphPermission Permission that has been created CreateOrganizationalSharingLinkAsync(OrganizationalLinkOptions) Creates an organization sharing link for a list item Declaration Task CreateOrganizationalSharingLinkAsync(OrganizationalLinkOptions organizationalLinkOptions) Parameters OrganizationalLinkOptions organizationalLinkOptions Returns Task < IGraphPermission > Permission that has been created CreateUserSharingLink(UserLinkOptions) Creates a user sharing link for a list item Declaration IGraphPermission CreateUserSharingLink(UserLinkOptions userLinkOptions) Parameters UserLinkOptions userLinkOptions Returns IGraphPermission Permission that has been created CreateUserSharingLinkAsync(UserLinkOptions) Creates a user sharing link for a list item Declaration Task CreateUserSharingLinkAsync(UserLinkOptions userLinkOptions) Parameters UserLinkOptions userLinkOptions Returns Task < IGraphPermission > Permission that has been created GetComments(Expression>[]) Get list item comments Declaration ICommentCollection GetComments(params Expression>[] selectors) Parameters Expression < Func < IComment , System.Object >>[] selectors The expressions declaring the fields to select Returns ICommentCollection GetCommentsAsync(Expression>[]) Get list item comments Declaration Task GetCommentsAsync(params Expression>[] selectors) Parameters Expression < Func < IComment , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < ICommentCollection > GetDisplayName() Gets the display name of the list item. Declaration string GetDisplayName() Returns String The display name or null . GetDisplayNameAsync() Gets the display name of the list item. Declaration Task GetDisplayNameAsync() Returns Task < String > The display name or null . GetParentFolder() Returns the IFolder that holds this item Declaration IFolder GetParentFolder() Returns IFolder The IFolder for this item is returned, if the item itself is a folder then the item is returned as IFolder . GetParentFolderAsync() Returns the IFolder that holds this item Declaration Task GetParentFolderAsync() Returns Task < IFolder > The IFolder for this item is returned, if the item itself is a folder then the item is returned as IFolder . GetUserEffectivePermissions(String) Gets the user effective permissions of a user for a listitem Declaration IBasePermissions GetUserEffectivePermissions(string userPrincipalName) Parameters String userPrincipalName Login name of the user you wish to retrieve the permissions of Returns IBasePermissions Base permissions object that contains the High and the Low permissions GetUserEffectivePermissionsAsync(String) Gets the user effective permissions of a user for a listitem Declaration Task GetUserEffectivePermissionsAsync(string userPrincipalName) Parameters String userPrincipalName Login name of the user you wish to retrieve the permissions of Returns Task < IBasePermissions > Base permissions object that contains the High and the Low permissions IsFile() Checks if this IListItem is a file Declaration bool IsFile() Returns Boolean Returns true if this IListItem is a file. IsFileAsync() Checks if this IListItem is a file Declaration Task IsFileAsync() Returns Task < Boolean > Returns true if this IListItem is a file. IsFolder() Checks if this IListItem is a folder Declaration bool IsFolder() Returns Boolean Returns true if this IListItem is a folder. IsFolderAsync() Checks if this IListItem is a folder Declaration Task IsFolderAsync() Returns Task < Boolean > Returns true if this IListItem is a folder. MoveTo(String) Moves this ListItem to another folder in this list Declaration void MoveTo(string destinationFolderUrl) Parameters String destinationFolderUrl Folder path within this list, e.g. 'subfolder1/subfolder2' MoveToAsync(String) Moves this ListItem to another folder in this list Declaration Task MoveToAsync(string destinationFolderUrl) Parameters String destinationFolderUrl Folder path within this list, e.g. 'subfolder1/subfolder2' Returns Task NewFieldLookupValue(IField, Int32) Creates a new IFieldLookupValue object Declaration IFieldLookupValue NewFieldLookupValue(IField fieldToUpdate, int lookupId) Parameters IField fieldToUpdate IField representing the field to set Int32 lookupId Id of the lookup value Returns IFieldLookupValue Configured IFieldLookupValue object NewFieldTaxonomyValue(IField, Guid, String, Int32) Creates a new IFieldTaxonomyValue object Declaration IFieldTaxonomyValue NewFieldTaxonomyValue(IField fieldToUpdate, Guid termId, string label, int wssId = null) Parameters IField fieldToUpdate IField representing the field to set Guid termId Name of the term to set String label Label of the term to set Int32 wssId Optionally provide the wssId value Returns IFieldTaxonomyValue Configured IFieldTaxonomyValue object NewFieldUrlValue(IField, String, String) Creates a new IFieldUrlValue object Declaration IFieldUrlValue NewFieldUrlValue(IField fieldToUpdate, string url, string description = null) Parameters IField fieldToUpdate IField representing the field to set String url Url value String description Optional description value Returns IFieldUrlValue Configured IFieldUrlValue object NewFieldUserValue(IField, ISharePointPrincipal) Creates a new IFieldUserValue object Declaration IFieldUserValue NewFieldUserValue(IField fieldToUpdate, ISharePointPrincipal principal) Parameters IField fieldToUpdate IField representing the field to set ISharePointPrincipal principal ISharePointUser or ISharePointGroup Returns IFieldUserValue Configured IFieldUserValue object NewFieldUserValue(IField, Int32) Creates a new IFieldUserValue object Declaration IFieldUserValue NewFieldUserValue(IField fieldToUpdate, int userId) Parameters IField fieldToUpdate IField representing the field to set Int32 userId Id of the user Returns IFieldUserValue Configured IFieldUserValue object NewFieldValueCollection(IField) Creates a new collection to hold IFieldValue objects Declaration IFieldValueCollection NewFieldValueCollection(IField fieldToUpdate) Parameters IField fieldToUpdate IField representing the field to set Returns IFieldValueCollection Recycle() Recycle the current item Declaration Guid Recycle() Returns Guid RecycleAsync() Recycle the current item Declaration Task RecycleAsync() Returns Task < Guid > RecycleBatch() Recycle the current item Declaration IBatchSingleResult> RecycleBatch() Returns IBatchSingleResult < BatchResultValue < Guid >> RecycleBatch(Batch) Recycle the current item Declaration IBatchSingleResult> RecycleBatch(Batch batch) Parameters Batch batch Batch to add the request to Returns IBatchSingleResult < BatchResultValue < Guid >> RecycleBatchAsync() Recycle the current item Declaration Task>> RecycleBatchAsync() Returns Task < IBatchSingleResult < BatchResultValue < Guid >>> RecycleBatchAsync(Batch) Recycle the current item Declaration Task>> RecycleBatchAsync(Batch batch) Parameters Batch batch Batch to add the request to Returns Task < IBatchSingleResult < BatchResultValue < Guid >>> SetCommentsDisabled(Boolean) Enable/Disable comments for this list item Declaration void SetCommentsDisabled(bool commentsDisabled) Parameters Boolean commentsDisabled Do comments need to enabled or disabled SetCommentsDisabledAsync(Boolean) Enable/Disable comments for this list item Declaration Task SetCommentsDisabledAsync(bool commentsDisabled) Parameters Boolean commentsDisabled Do comments need to enabled or disabled Returns Task SetComplianceTag(String, Boolean, Boolean, Boolean, Boolean) Sets a compliancetag / retention label for this list item Declaration void SetComplianceTag(string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock) Parameters String complianceTag The tag/label to set for this list item Boolean isTagPolicyHold Whether the tag is hold Boolean isTagPolicyRecord Whether the tag is record Boolean isEventBasedTag Whether the tag is Event based, this is not used Boolean isTagSuperLock Whether the tag is Sec 17 tag,no allow change even for site admin SetComplianceTagAsync(String, Boolean, Boolean, Boolean, Boolean) Sets a compliancetag / retention label for this list item Declaration Task SetComplianceTagAsync(string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock) Parameters String complianceTag The tag/label to set for this list item Boolean isTagPolicyHold Whether the tag is hold Boolean isTagPolicyRecord Whether the tag is record Boolean isEventBasedTag Whether the tag is Event based, this is not used Boolean isTagSuperLock Whether the tag is Sec 17 tag,no allow change even for site admin Returns Task SetComplianceTagBatch(Batch, String, Boolean, Boolean, Boolean, Boolean) Sets a compliancetag / retention label for this list item Declaration void SetComplianceTagBatch(Batch batch, string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock) Parameters Batch batch Batch to add the request to String complianceTag The tag/label to set for this list item Boolean isTagPolicyHold Whether the tag is hold Boolean isTagPolicyRecord Whether the tag is record Boolean isEventBasedTag Whether the tag is Event based, this is not used Boolean isTagSuperLock Whether the tag is Sec 17 tag,no allow change even for site admin SetComplianceTagBatch(String, Boolean, Boolean, Boolean, Boolean) Sets a compliancetag / retention label for this list item Declaration void SetComplianceTagBatch(string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock) Parameters String complianceTag The tag/label to set for this list item Boolean isTagPolicyHold Whether the tag is hold Boolean isTagPolicyRecord Whether the tag is record Boolean isEventBasedTag Whether the tag is Event based, this is not used Boolean isTagSuperLock Whether the tag is Sec 17 tag,no allow change even for site admin SetComplianceTagBatchAsync(Batch, String, Boolean, Boolean, Boolean, Boolean) Sets a compliancetag / retention label for this list item Declaration Task SetComplianceTagBatchAsync(Batch batch, string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock) Parameters Batch batch Batch to add the request to String complianceTag The tag/label to set for this list item Boolean isTagPolicyHold Whether the tag is hold Boolean isTagPolicyRecord Whether the tag is record Boolean isEventBasedTag Whether the tag is Event based, this is not used Boolean isTagSuperLock Whether the tag is Sec 17 tag,no allow change even for site admin Returns Task SetComplianceTagBatchAsync(String, Boolean, Boolean, Boolean, Boolean) Sets a compliancetag / retention label for this list item Declaration Task SetComplianceTagBatchAsync(string complianceTag, bool isTagPolicyHold, bool isTagPolicyRecord, bool isEventBasedTag, bool isTagSuperLock) Parameters String complianceTag The tag/label to set for this list item Boolean isTagPolicyHold Whether the tag is hold Boolean isTagPolicyRecord Whether the tag is record Boolean isEventBasedTag Whether the tag is Event based, this is not used Boolean isTagSuperLock Whether the tag is Sec 17 tag,no allow change even for site admin Returns Task SystemUpdate() Performs a system update of the list item Declaration void SystemUpdate() SystemUpdateAsync() Performs a system update of the list item Declaration Task SystemUpdateAsync() Returns Task SystemUpdateBatch() Performs a system update of the list item Declaration void SystemUpdateBatch() SystemUpdateBatch(Batch) Performs a system update of the list item Declaration void SystemUpdateBatch(Batch batch) Parameters Batch batch Batch to add the systemupdate request to SystemUpdateBatchAsync() Performs a system update of the list item Declaration Task SystemUpdateBatchAsync() Returns Task SystemUpdateBatchAsync(Batch) Performs a system update of the list item Declaration Task SystemUpdateBatchAsync(Batch batch) Parameters Batch batch Batch to add the systemupdate request to Returns Task UpdateOverwriteVersion() Performs a UpdateOverwriteVersion of the list item Declaration void UpdateOverwriteVersion() UpdateOverwriteVersionAsync() Performs a UpdateOverwriteVersion of the list item Declaration Task UpdateOverwriteVersionAsync() Returns Task UpdateOverwriteVersionBatch() Performs a UpdateOverwriteVersion of the list item Declaration void UpdateOverwriteVersionBatch() UpdateOverwriteVersionBatch(Batch) Performs a UpdateOverwriteVersion of the list item Declaration void UpdateOverwriteVersionBatch(Batch batch) Parameters Batch batch Batch to add the UpdateOverwriteVersion request to UpdateOverwriteVersionBatchAsync() Performs a UpdateOverwriteVersion of the list item Declaration Task UpdateOverwriteVersionBatchAsync() Returns Task UpdateOverwriteVersionBatchAsync(Batch) Performs a UpdateOverwriteVersion of the list item Declaration Task UpdateOverwriteVersionBatchAsync(Batch batch) Parameters Batch batch Batch to add the UpdateOverwriteVersion request to Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IListItemCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IListItemCollection.html", "title": "Interface IListItemCollection | PnP Core SDK", - "keywords": "Interface IListItemCollection Public interface to define a collection of ListItem objects of SharePoint Online Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() IDataModelCollectionLoad.LoadAsync(Expression>[]) IDataModelCollectionLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelCollectionDeleteByIntegerId.DeleteById(Int32) IDataModelCollectionDeleteByIntegerId.DeleteByIdAsync(Int32) IDataModelCollectionDeleteByIntegerId.DeleteByIdBatch(Int32) IDataModelCollectionDeleteByIntegerId.DeleteByIdBatchAsync(Int32) IDataModelCollectionDeleteByIntegerId.DeleteByIdBatch(Batch, Int32) IDataModelCollectionDeleteByIntegerId.DeleteByIdBatchAsync(Batch, Int32) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IListItemCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad, IDataModelCollectionDeleteByIntegerId, ISupportModules Methods Add(Dictionary, String, FileSystemObjectType) Adds a new list item Declaration IListItem Add(Dictionary values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType)) Parameters Dictionary < String , Object > values Values to add to list item String folderPath Optional folder path to add the item to. FileSystemObjectType underlyingObjectType Type of object to create. Defaults to File/ListItem Returns IListItem Newly added list item AddAsync(Dictionary, String, FileSystemObjectType) Adds a new list item Declaration Task AddAsync(Dictionary values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType)) Parameters Dictionary < String , Object > values Values to add to list item String folderPath Optional folder path to add the item to. FileSystemObjectType underlyingObjectType Type of object to create. Defaults to File/ListItem Returns Task < IListItem > Newly added list item AddBatch(Dictionary, String, FileSystemObjectType) Adds a new list item Declaration IListItem AddBatch(Dictionary values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType)) Parameters Dictionary < String , Object > values Values to add to list item String folderPath Optional folder path to add the item to. FileSystemObjectType underlyingObjectType Type of object to create. Defaults to File/ListItem Returns IListItem Newly added list item AddBatch(Batch, Dictionary, String, FileSystemObjectType) Adds a new list item Declaration IListItem AddBatch(Batch batch, Dictionary values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType)) Parameters Batch batch Batch to use Dictionary < String , Object > values Values to add to list item String folderPath Optional folder path to add the item to. FileSystemObjectType underlyingObjectType Type of object to create. Defaults to File/ListItem Returns IListItem Newly added list item AddBatchAsync(Dictionary, String, FileSystemObjectType) Adds a new list item Declaration Task AddBatchAsync(Dictionary values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType)) Parameters Dictionary < String , Object > values Values to add to list item String folderPath Optional folder path to add the item to. FileSystemObjectType underlyingObjectType Type of object to create. Defaults to File/ListItem Returns Task < IListItem > Newly added list item AddBatchAsync(Batch, Dictionary, String, FileSystemObjectType) Adds a new list item Declaration Task AddBatchAsync(Batch batch, Dictionary values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType)) Parameters Batch batch Batch to use Dictionary < String , Object > values Values to add to list item String folderPath Optional folder path to add the item to. FileSystemObjectType underlyingObjectType Type of object to create. Defaults to File/ListItem Returns Task < IListItem > Newly added list item Contains(Int32) Checks if the collection contains a listitem with a given id Declaration bool Contains(int id) Parameters Int32 id Id to check for Returns Boolean True if found, false otherwise GetById(Int32, Expression>[]) Method to select a list item by Id Declaration IListItem GetById(int id, params Expression>[] selectors) Parameters Int32 id The Id to search for Expression < Func < IListItem , Object >>[] selectors The expressions declaring the fields to select Returns IListItem The resulting list item instance, if any GetByIdAsync(Int32, Expression>[]) Method to select a list item by Id asynchronously Declaration Task GetByIdAsync(int id, params Expression>[] selectors) Parameters Int32 id The Id to search for Expression < Func < IListItem , Object >>[] selectors The expressions declaring the fields to select Returns Task < IListItem > The resulting list item instance, if any RecycleById(Int32) Recycle the list item Declaration Guid RecycleById(int id) Parameters Int32 id Id of the item to recycle Returns Guid RecycleByIdAsync(Int32) Recycle the list item Declaration Task RecycleByIdAsync(int id) Parameters Int32 id Id of the item to recycle Returns Task < Guid > RecycleByIdBatch(Batch, Int32) Recycle the list item Declaration void RecycleByIdBatch(Batch batch, int id) Parameters Batch batch Batch to add the request to Int32 id Id of the item to recycle RecycleByIdBatch(Int32) Recycle the list item Declaration void RecycleByIdBatch(int id) Parameters Int32 id Id of the item to recycle RecycleByIdBatchAsync(Batch, Int32) Recycle the list item Declaration Task RecycleByIdBatchAsync(Batch batch, int id) Parameters Batch batch Batch to add the request to Int32 id Id of the item to recycle Returns Task RecycleByIdBatchAsync(Int32) Recycle the list item Declaration Task RecycleByIdBatchAsync(int id) Parameters Int32 id Id of the item to recycle Returns Task Extension Methods DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.Load(IDataModelCollectionLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" + "keywords": "Interface IListItemCollection Public interface to define a collection of ListItem objects of SharePoint Online Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() IDataModelCollectionLoad.LoadAsync(Expression>[]) IDataModelCollectionLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelCollectionDeleteByIntegerId.DeleteById(Int32) IDataModelCollectionDeleteByIntegerId.DeleteByIdAsync(Int32) IDataModelCollectionDeleteByIntegerId.DeleteByIdBatch(Int32) IDataModelCollectionDeleteByIntegerId.DeleteByIdBatchAsync(Int32) IDataModelCollectionDeleteByIntegerId.DeleteByIdBatch(Batch, Int32) IDataModelCollectionDeleteByIntegerId.DeleteByIdBatchAsync(Batch, Int32) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IListItemCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad, IDataModelCollectionDeleteByIntegerId, ISupportModules Methods Add(Dictionary, String, FileSystemObjectType) Adds a new list item Declaration IListItem Add(Dictionary values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType)) Parameters Dictionary < String , System.Object > values Values to add to list item String folderPath Optional folder path to add the item to. FileSystemObjectType underlyingObjectType Type of object to create. Defaults to File/ListItem Returns IListItem Newly added list item AddAsync(Dictionary, String, FileSystemObjectType) Adds a new list item Declaration Task AddAsync(Dictionary values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType)) Parameters Dictionary < String , System.Object > values Values to add to list item String folderPath Optional folder path to add the item to. FileSystemObjectType underlyingObjectType Type of object to create. Defaults to File/ListItem Returns Task < IListItem > Newly added list item AddBatch(Dictionary, String, FileSystemObjectType) Adds a new list item Declaration IListItem AddBatch(Dictionary values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType)) Parameters Dictionary < String , System.Object > values Values to add to list item String folderPath Optional folder path to add the item to. FileSystemObjectType underlyingObjectType Type of object to create. Defaults to File/ListItem Returns IListItem Newly added list item AddBatch(Batch, Dictionary, String, FileSystemObjectType) Adds a new list item Declaration IListItem AddBatch(Batch batch, Dictionary values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType)) Parameters Batch batch Batch to use Dictionary < String , System.Object > values Values to add to list item String folderPath Optional folder path to add the item to. FileSystemObjectType underlyingObjectType Type of object to create. Defaults to File/ListItem Returns IListItem Newly added list item AddBatchAsync(Dictionary, String, FileSystemObjectType) Adds a new list item Declaration Task AddBatchAsync(Dictionary values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType)) Parameters Dictionary < String , System.Object > values Values to add to list item String folderPath Optional folder path to add the item to. FileSystemObjectType underlyingObjectType Type of object to create. Defaults to File/ListItem Returns Task < IListItem > Newly added list item AddBatchAsync(Batch, Dictionary, String, FileSystemObjectType) Adds a new list item Declaration Task AddBatchAsync(Batch batch, Dictionary values, string folderPath = null, FileSystemObjectType underlyingObjectType = default(FileSystemObjectType)) Parameters Batch batch Batch to use Dictionary < String , System.Object > values Values to add to list item String folderPath Optional folder path to add the item to. FileSystemObjectType underlyingObjectType Type of object to create. Defaults to File/ListItem Returns Task < IListItem > Newly added list item Contains(Int32) Checks if the collection contains a listitem with a given id Declaration bool Contains(int id) Parameters Int32 id Id to check for Returns Boolean True if found, false otherwise GetById(Int32, Expression>[]) Method to select a list item by Id Declaration IListItem GetById(int id, params Expression>[] selectors) Parameters Int32 id The Id to search for Expression < Func < IListItem , System.Object >>[] selectors The expressions declaring the fields to select Returns IListItem The resulting list item instance, if any GetByIdAsync(Int32, Expression>[]) Method to select a list item by Id asynchronously Declaration Task GetByIdAsync(int id, params Expression>[] selectors) Parameters Int32 id The Id to search for Expression < Func < IListItem , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < IListItem > The resulting list item instance, if any RecycleById(Int32) Recycle the list item Declaration Guid RecycleById(int id) Parameters Int32 id Id of the item to recycle Returns Guid RecycleByIdAsync(Int32) Recycle the list item Declaration Task RecycleByIdAsync(int id) Parameters Int32 id Id of the item to recycle Returns Task < Guid > RecycleByIdBatch(Batch, Int32) Recycle the list item Declaration void RecycleByIdBatch(Batch batch, int id) Parameters Batch batch Batch to add the request to Int32 id Id of the item to recycle RecycleByIdBatch(Int32) Recycle the list item Declaration void RecycleByIdBatch(int id) Parameters Int32 id Id of the item to recycle RecycleByIdBatchAsync(Batch, Int32) Recycle the list item Declaration Task RecycleByIdBatchAsync(Batch batch, int id) Parameters Batch batch Batch to add the request to Int32 id Id of the item to recycle Returns Task RecycleByIdBatchAsync(Int32) Recycle the list item Declaration Task RecycleByIdBatchAsync(int id) Parameters Int32 id Id of the item to recycle Returns Task Extension Methods DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.Load(IDataModelCollectionLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" }, "api/PnP.Core.Model.SharePoint.IListItemVersion.html": { "href": "api/PnP.Core.Model.SharePoint.IListItemVersion.html", "title": "Interface IListItemVersion | PnP Core SDK", - "keywords": "Interface IListItemVersion Public interface to define a ListItemVersion object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() IExpandoDataModel.Item[String] IExpandoDataModel.Values IExpandoDataModel.Count IExpandoDataModel.AsDynamic() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IListItemVersion : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelDelete, IExpandoDataModel, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object Created Gets a value that specifies the creation date and time for the list item version. Declaration DateTime Created { get; } Property Value DateTime CreatedBy The ISharePointUser that created this version. Declaration ISharePointUser CreatedBy { get; } Property Value ISharePointUser Fields Fields of this list item version. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFieldCollection Fields { get; } Property Value IFieldCollection FileVersion IFileVersion of this list item version Declaration IFileVersion FileVersion { get; } Property Value IFileVersion Id Gets the internal identifier for the list item version. SP REST property name: VersionId. Declaration int Id { get; } Property Value Int32 IsCurrentVersion Gets a value that specifies whether the list item version is the current version. Declaration bool IsCurrentVersion { get; } Property Value Boolean VersionLabel Gets a value that specifies the implementation specific identifier of the file. Declaration string VersionLabel { get; } Property Value String Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IListItemVersion Public interface to define a ListItemVersion object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() IExpandoDataModel.Item[String] IExpandoDataModel.Values IExpandoDataModel.Count IExpandoDataModel.AsDynamic() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IListItemVersion : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelDelete, IExpandoDataModel, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object Created Gets a value that specifies the creation date and time for the list item version. Declaration DateTime Created { get; } Property Value DateTime CreatedBy The ISharePointUser that created this version. Declaration ISharePointUser CreatedBy { get; } Property Value ISharePointUser Fields Fields of this list item version. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFieldCollection Fields { get; } Property Value IFieldCollection FileVersion IFileVersion of this list item version Declaration IFileVersion FileVersion { get; } Property Value IFileVersion Id Gets the internal identifier for the list item version. SP REST property name: VersionId. Declaration int Id { get; } Property Value Int32 IsCurrentVersion Gets a value that specifies whether the list item version is the current version. Declaration bool IsCurrentVersion { get; } Property Value Boolean VersionLabel Gets a value that specifies the implementation specific identifier of the file. Declaration string VersionLabel { get; } Property Value String Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IListItemVersionCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IListItemVersionCollection.html", "title": "Interface IListItemVersionCollection | PnP Core SDK", - "keywords": "Interface IListItemVersionCollection Collection of file versions Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() IDataModelCollectionLoad.LoadAsync(Expression>[]) IDataModelCollectionLoad.LoadBatchAsync(Batch, Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IListItemVersionCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad, ISupportModules Methods GetById(Int32, Expression>[]) Method to select a list item version by Id Declaration IListItemVersion GetById(int id, params Expression>[] selectors) Parameters Int32 id The Id to search for Expression < Func < IListItemVersion , Object >>[] selectors The expressions declaring the fields to select Returns IListItemVersion The resulting list item version instance, if any GetByIdAsync(Int32, Expression>[]) Method to select a list item version by Id asynchronously Declaration Task GetByIdAsync(int id, params Expression>[] selectors) Parameters Int32 id The Id to search for Expression < Func < IListItemVersion , Object >>[] selectors The expressions declaring the fields to select Returns Task < IListItemVersion > The resulting list item version instance, if any Extension Methods DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.Load(IDataModelCollectionLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" + "keywords": "Interface IListItemVersionCollection Collection of file versions Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() IDataModelCollectionLoad.LoadAsync(Expression>[]) IDataModelCollectionLoad.LoadBatchAsync(Batch, Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IListItemVersionCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad, ISupportModules Methods GetById(Int32, Expression>[]) Method to select a list item version by Id Declaration IListItemVersion GetById(int id, params Expression>[] selectors) Parameters Int32 id The Id to search for Expression < Func < IListItemVersion , System.Object >>[] selectors The expressions declaring the fields to select Returns IListItemVersion The resulting list item version instance, if any GetByIdAsync(Int32, Expression>[]) Method to select a list item version by Id asynchronously Declaration Task GetByIdAsync(int id, params Expression>[] selectors) Parameters Int32 id The Id to search for Expression < Func < IListItemVersion , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < IListItemVersion > The resulting list item version instance, if any Extension Methods DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.Load(IDataModelCollectionLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" }, "api/PnP.Core.Model.SharePoint.IListSubscription.html": { "href": "api/PnP.Core.Model.SharePoint.IListSubscription.html", @@ -2037,17 +2037,17 @@ "api/PnP.Core.Model.SharePoint.INavigation.html": { "href": "api/PnP.Core.Model.SharePoint.INavigation.html", "title": "Interface INavigation | PnP Core SDK", - "keywords": "Interface INavigation Represents the Navigation Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface INavigation : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object Id Random property. We need this for the Key property. Declaration Guid Id { get; } Property Value Guid QuickLaunch A property that will return the navigation nodes of the Quicklaunch menu of the web Declaration INavigationNodeCollection QuickLaunch { get; } Property Value INavigationNodeCollection TopNavigationBar A property that will return the navigation nodes of the TopNavigation menu of the web Declaration INavigationNodeCollection TopNavigationBar { get; } Property Value INavigationNodeCollection UseShared A property that decides whether the navigation is inherited from the site Declaration bool UseShared { get; } Property Value Boolean Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface INavigation Represents the Navigation Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface INavigation : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object Id Random property. We need this for the Key property. Declaration Guid Id { get; } Property Value Guid QuickLaunch A property that will return the navigation nodes of the Quicklaunch menu of the web Declaration INavigationNodeCollection QuickLaunch { get; } Property Value INavigationNodeCollection TopNavigationBar A property that will return the navigation nodes of the TopNavigation menu of the web Declaration INavigationNodeCollection TopNavigationBar { get; } Property Value INavigationNodeCollection UseShared A property that decides whether the navigation is inherited from the site Declaration bool UseShared { get; } Property Value Boolean Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.INavigationNode.html": { "href": "api/PnP.Core.Model.SharePoint.INavigationNode.html", "title": "Interface INavigationNode | PnP Core SDK", - "keywords": "Interface INavigationNode Represents the Navigation Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface INavigationNode : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object AudienceIds Define the up to 1O audiences for this navigation node. Note that Web.NavAudienceTargetingEnabled has to be set to true first. Declaration List AudienceIds { get; set; } Property Value PnP.Core.Model.SharePoint.List < Guid > CurrentLCID The language ID under which the navigation node is created Declaration int CurrentLCID { get; } Property Value Int32 Id The ID of the navigation node Declaration int Id { get; } Property Value Int32 IsDocLib Defines if the navigation node refers to a doc lib Declaration bool IsDocLib { get; } Property Value Boolean IsExternal Defines if the navigation node links to an external page or stays within SP Declaration bool IsExternal { get; } Property Value Boolean IsVisible Defines if the navigation node is visible or not Declaration bool IsVisible { get; set; } Property Value Boolean ListTemplateType The list template type of the navigation node Declaration ListTemplateType ListTemplateType { get; } Property Value ListTemplateType Title Title of the navigation node Declaration string Title { get; set; } Property Value String Url The link that the navigation node is referring to Declaration string Url { get; set; } Property Value String Methods GetChildNodes(Expression>[]) Method to obtain all the child nodes of a navigation node Declaration List GetChildNodes(params Expression>[] selectors) Parameters Expression < Func < INavigationNode , Object >>[] selectors Returns PnP.Core.Model.SharePoint.List < INavigationNode > GetChildNodesAsync(Expression>[]) Method to obtain all the child nodes of a navigation node Declaration Task> GetChildNodesAsync(params Expression>[] selectors) Parameters Expression < Func < INavigationNode , Object >>[] selectors Returns Task < PnP.Core.Model.SharePoint.List < INavigationNode >> Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface INavigationNode Represents the Navigation Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface INavigationNode : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object AudienceIds Define the up to 1O audiences for this navigation node. Note that Web.NavAudienceTargetingEnabled has to be set to true first. Declaration List AudienceIds { get; set; } Property Value PnP.Core.Model.SharePoint.List < Guid > CurrentLCID The language ID under which the navigation node is created Declaration int CurrentLCID { get; } Property Value Int32 Id The ID of the navigation node Declaration int Id { get; } Property Value Int32 IsDocLib Defines if the navigation node refers to a doc lib Declaration bool IsDocLib { get; } Property Value Boolean IsExternal Defines if the navigation node links to an external page or stays within SP Declaration bool IsExternal { get; } Property Value Boolean IsVisible Defines if the navigation node is visible or not Declaration bool IsVisible { get; set; } Property Value Boolean ListTemplateType The list template type of the navigation node Declaration ListTemplateType ListTemplateType { get; } Property Value ListTemplateType Title Title of the navigation node Declaration string Title { get; set; } Property Value String Url The link that the navigation node is referring to Declaration string Url { get; set; } Property Value String Methods GetChildNodes(Expression>[]) Method to obtain all the child nodes of a navigation node Declaration List GetChildNodes(params Expression>[] selectors) Parameters Expression < Func < INavigationNode , System.Object >>[] selectors Returns PnP.Core.Model.SharePoint.List < INavigationNode > GetChildNodesAsync(Expression>[]) Method to obtain all the child nodes of a navigation node Declaration Task> GetChildNodesAsync(params Expression>[] selectors) Parameters Expression < Func < INavigationNode , System.Object >>[] selectors Returns Task < PnP.Core.Model.SharePoint.List < INavigationNode >> Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.INavigationNodeCollection.html": { "href": "api/PnP.Core.Model.SharePoint.INavigationNodeCollection.html", "title": "Interface INavigationNodeCollection | PnP Core SDK", - "keywords": "Interface INavigationNodeCollection Represents the Navigation Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface INavigationNodeCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, ISupportModules Properties NavigationType This variable will define whether we will be using the top navigation or the quick launch for our API calls Declaration NavigationType NavigationType { get; } Property Value NavigationType Methods Add(NavigationNodeOptions) Method to add a Navigation Node Declaration INavigationNode Add(NavigationNodeOptions navigationNodeOptions) Parameters NavigationNodeOptions navigationNodeOptions The options for the navigation node Returns INavigationNode The navigation node AddAsync(NavigationNodeOptions) Method to add a Navigation Node Declaration Task AddAsync(NavigationNodeOptions navigationNodeOptions) Parameters NavigationNodeOptions navigationNodeOptions The options for the navigation node Returns Task < INavigationNode > The navigation node DeleteAllNodes() Method to delete all navigation nodes from a specific navigation type Declaration void DeleteAllNodes() DeleteAllNodesAsync() Method to delete all navigation nodes from a specific navigation type Declaration Task DeleteAllNodesAsync() Returns Task DeleteAllNodesBatch() Method to delete all navigation nodes from a specific navigation type in a batch Declaration void DeleteAllNodesBatch() DeleteAllNodesBatch(Batch) Method to delete all navigation nodes from a specific navigation type in a batch Declaration void DeleteAllNodesBatch(Batch batch) Parameters Batch batch The batch to add this reques to DeleteAllNodesBatchAsync() Method to delete all navigation nodes from a specific navigation type in a batch Declaration Task DeleteAllNodesBatchAsync() Returns Task DeleteAllNodesBatchAsync(Batch) Method to delete all navigation nodes from a specific navigation type in a batch Declaration Task DeleteAllNodesBatchAsync(Batch batch) Parameters Batch batch The batch to add this reques to Returns Task GetById(Int32, Expression>[]) Method to select a specific Navigation Node Declaration INavigationNode GetById(int id, params Expression>[] selectors) Parameters Int32 id The Id to search for Expression < Func < INavigationNode , Object >>[] selectors The expressions declaring the fields to select Returns INavigationNode The navigation node, if any GetByIdAsync(Int32, Expression>[]) Method to select a specific Navigation Node Declaration Task GetByIdAsync(int id, params Expression>[] selectors) Parameters Int32 id The Id to search for Expression < Func < INavigationNode , Object >>[] selectors The expressions declaring the fields to select Returns Task < INavigationNode > The navigation node, if any MoveNodeAfter(INavigationNode, INavigationNode) Function to move a node after another navigation node Declaration void MoveNodeAfter(INavigationNode nodeToMove, INavigationNode nodeToMoveAfter) Parameters INavigationNode nodeToMove INavigationNode nodeToMoveAfter MoveNodeAfterAsync(INavigationNode, INavigationNode) Function to move a node after another navigation node Declaration Task MoveNodeAfterAsync(INavigationNode nodeToMove, INavigationNode nodeToMoveAfter) Parameters INavigationNode nodeToMove INavigationNode nodeToMoveAfter Returns Task Extension Methods RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" + "keywords": "Interface INavigationNodeCollection Represents the Navigation Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface INavigationNodeCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, ISupportModules Properties NavigationType This variable will define whether we will be using the top navigation or the quick launch for our API calls Declaration NavigationType NavigationType { get; } Property Value NavigationType Methods Add(NavigationNodeOptions) Method to add a Navigation Node Declaration INavigationNode Add(NavigationNodeOptions navigationNodeOptions) Parameters NavigationNodeOptions navigationNodeOptions The options for the navigation node Returns INavigationNode The navigation node AddAsync(NavigationNodeOptions) Method to add a Navigation Node Declaration Task AddAsync(NavigationNodeOptions navigationNodeOptions) Parameters NavigationNodeOptions navigationNodeOptions The options for the navigation node Returns Task < INavigationNode > The navigation node DeleteAllNodes() Method to delete all navigation nodes from a specific navigation type Declaration void DeleteAllNodes() DeleteAllNodesAsync() Method to delete all navigation nodes from a specific navigation type Declaration Task DeleteAllNodesAsync() Returns Task DeleteAllNodesBatch() Method to delete all navigation nodes from a specific navigation type in a batch Declaration void DeleteAllNodesBatch() DeleteAllNodesBatch(Batch) Method to delete all navigation nodes from a specific navigation type in a batch Declaration void DeleteAllNodesBatch(Batch batch) Parameters Batch batch The batch to add this reques to DeleteAllNodesBatchAsync() Method to delete all navigation nodes from a specific navigation type in a batch Declaration Task DeleteAllNodesBatchAsync() Returns Task DeleteAllNodesBatchAsync(Batch) Method to delete all navigation nodes from a specific navigation type in a batch Declaration Task DeleteAllNodesBatchAsync(Batch batch) Parameters Batch batch The batch to add this reques to Returns Task GetById(Int32, Expression>[]) Method to select a specific Navigation Node Declaration INavigationNode GetById(int id, params Expression>[] selectors) Parameters Int32 id The Id to search for Expression < Func < INavigationNode , System.Object >>[] selectors The expressions declaring the fields to select Returns INavigationNode The navigation node, if any GetByIdAsync(Int32, Expression>[]) Method to select a specific Navigation Node Declaration Task GetByIdAsync(int id, params Expression>[] selectors) Parameters Int32 id The Id to search for Expression < Func < INavigationNode , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < INavigationNode > The navigation node, if any MoveNodeAfter(INavigationNode, INavigationNode) Function to move a node after another navigation node Declaration void MoveNodeAfter(INavigationNode nodeToMove, INavigationNode nodeToMoveAfter) Parameters INavigationNode nodeToMove INavigationNode nodeToMoveAfter MoveNodeAfterAsync(INavigationNode, INavigationNode) Function to move a node after another navigation node Declaration Task MoveNodeAfterAsync(INavigationNode nodeToMove, INavigationNode nodeToMoveAfter) Parameters INavigationNode nodeToMove INavigationNode nodeToMoveAfter Returns Task Extension Methods RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" }, "api/PnP.Core.Model.SharePoint.INavigationOptions.html": { "href": "api/PnP.Core.Model.SharePoint.INavigationOptions.html", @@ -2057,7 +2057,7 @@ "api/PnP.Core.Model.SharePoint.IPage.html": { "href": "api/PnP.Core.Model.SharePoint.IPage.html", "title": "Interface IPage | PnP Core SDK", - "keywords": "Interface IPage A modern SharePoint Page Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IPage Properties Controls List of control on this page Declaration List Controls { get; } Property Value PnP.Core.Model.SharePoint.List < ICanvasControl > DefaultSection The default section of the client side page Declaration ICanvasSection DefaultSection { get; } Property Value ICanvasSection EditorType Returns the editor that was used to create/update this page Declaration EditorType EditorType { get; } Property Value EditorType EntityId Entity id field for topic pages Declaration string EntityId { get; set; } Property Value String EntityRelations Entity relations field for topic pages Declaration string EntityRelations { get; set; } Property Value String EntityType Entity type field for topic pages Declaration string EntityType { get; set; } Property Value String Folder Folder the page lives in (available after saving the page) Declaration string Folder { get; } Property Value String HeaderControls List of controls on this page's header Declaration List HeaderControls { get; } Property Value PnP.Core.Model.SharePoint.List < ICanvasControl > KeepDefaultWebParts When a page of type Home is created you can opt to only keep the default client side web parts by setting this to true. This also is a way to reset your home page back the the stock one. Declaration bool KeepDefaultWebParts { get; set; } Property Value Boolean LayoutType Layout type of the client side page Declaration PageLayoutType LayoutType { get; set; } Property Value PageLayoutType Name The name of this page (available after saving the page) Declaration string Name { get; } Property Value String PageHeader Returns the page header for this page Declaration IPageHeader PageHeader { get; } Property Value IPageHeader PageId ID value of the page (only available when the page was saved) Declaration int? PageId { get; } Property Value Nullable < Int32 > PageListItem ListItem linked to this page Declaration IListItem PageListItem { get; } Property Value IListItem PagesLibrary Pages library Declaration IList PagesLibrary { get; } Property Value IList PageTitle Title of the client side page Declaration string PageTitle { get; set; } Property Value String PnPContext PnPContext to work with Declaration PnPContext PnPContext { get; } Property Value PnPContext RepostDescription Description of the repost page Declaration string RepostDescription { get; set; } Property Value String RepostSourceItemId Id of the SharePoint IListItem connected to the page being reposted Declaration Guid RepostSourceItemId { get; set; } Property Value Guid RepostSourceListId Id of the SharePoint IList containting the page being reposted Declaration Guid RepostSourceListId { get; set; } Property Value Guid RepostSourceSiteId Id of the SharePoint ISite containting the page being reposted Declaration Guid RepostSourceSiteId { get; set; } Property Value Guid RepostSourceUrl Url being reposted using the repost page Declaration string RepostSourceUrl { get; set; } Property Value String RepostSourceWebId Id of the SharePoint IWeb containting the page being reposted Declaration Guid RepostSourceWebId { get; set; } Property Value Guid ScheduledPublishDate Returns the scheduled publish data of a page (only if publish was scheduled) Declaration DateTime? ScheduledPublishDate { get; } Property Value Nullable < DateTime > Sections List of sections on this page Declaration List Sections { get; } Property Value PnP.Core.Model.SharePoint.List < ICanvasSection > SpaceContent Space content field (JSON) for spaces pages Declaration string SpaceContent { get; set; } Property Value String ThumbnailUrl Thumbnail url for the page Declaration string ThumbnailUrl { get; set; } Property Value String Methods AddControl(ICanvasControl) Adds a new control to your client side page using the default ICanvasSection Declaration void AddControl(ICanvasControl control) Parameters ICanvasControl control ICanvasControl to add AddControl(ICanvasControl, ICanvasColumn) Adds a new control to your client side page in the given section Declaration void AddControl(ICanvasControl control, ICanvasColumn column) Parameters ICanvasControl control ICanvasControl to add ICanvasColumn column ICanvasColumn that will hold the control AddControl(ICanvasControl, ICanvasColumn, Int32) Adds a new control to your client side page in the given section with a given order Declaration void AddControl(ICanvasControl control, ICanvasColumn column, int order) Parameters ICanvasControl control ICanvasControl to add ICanvasColumn column ICanvasColumn that will hold the control Int32 order Order of the control in the given section AddControl(ICanvasControl, ICanvasSection) Adds a new control to your client side page in the given section Declaration void AddControl(ICanvasControl control, ICanvasSection section) Parameters ICanvasControl control ICanvasControl to add ICanvasSection section ICanvasSection that will hold the control. Control will end up in the DefaultColumn . AddControl(ICanvasControl, ICanvasSection, Int32) Adds a new control to your client side page in the given section with a given order Declaration void AddControl(ICanvasControl control, ICanvasSection section, int order) Parameters ICanvasControl control ICanvasControl to add ICanvasSection section ICanvasSection that will hold the control. Control will end up in the DefaultColumn . Int32 order Order of the control in the given section AddControl(ICanvasControl, Int32) Adds a new control to your client side page using the default ICanvasSection using a given order Declaration void AddControl(ICanvasControl control, int order) Parameters ICanvasControl control ICanvasControl to add Int32 order Order of the control in the default section AddHeaderControl(ICanvasControl, Int32) Adds a new header control to your client side page with a given order. Used for topic page creation Declaration void AddHeaderControl(ICanvasControl control, int order) Parameters ICanvasControl control ICanvasControl to add Int32 order Order of the control in the given section AddSection(CanvasSectionTemplate, Single) Adds a new section to your client side page Declaration void AddSection(CanvasSectionTemplate sectionTemplate, float order) Parameters CanvasSectionTemplate sectionTemplate The CanvasSectionTemplate type of the section Single order Controls the order of the new section AddSection(CanvasSectionTemplate, Single, VariantThemeType, VariantThemeType) Adds a new section to your client side page Declaration void AddSection(CanvasSectionTemplate sectionTemplate, float order, VariantThemeType zoneEmphasis, VariantThemeType verticalSectionZoneEmphasis = default(VariantThemeType)) Parameters CanvasSectionTemplate sectionTemplate The CanvasSectionTemplate type of the section Single order Controls the order of the new section VariantThemeType zoneEmphasis Zone emphasis (section background) VariantThemeType verticalSectionZoneEmphasis Vertical Section Zone emphasis (section background) AddSection(CanvasSectionTemplate, Single, Int32, Nullable) Adds a new section to your client side page Declaration void AddSection(CanvasSectionTemplate sectionTemplate, float order, int zoneEmphasis, int? verticalSectionZoneEmphasis = null) Parameters CanvasSectionTemplate sectionTemplate The CanvasSectionTemplate type of the section Single order Controls the order of the new section Int32 zoneEmphasis Zone emphasis (section background) Nullable < Int32 > verticalSectionZoneEmphasis Vertical Section Zone emphasis (section background) AddSection(ICanvasSection) Adds a new section to your client side page Declaration void AddSection(ICanvasSection section) Parameters ICanvasSection section ICanvasSection object describing the section to add AddSection(ICanvasSection, Single) Adds a new section to your client side page with a given order Declaration void AddSection(ICanvasSection section, float order) Parameters ICanvasSection section ICanvasSection object describing the section to add Single order Controls the order of the new section AreCommentsDisabled() Does this page have comments disabled Declaration bool AreCommentsDisabled() Returns Boolean AreCommentsDisabledAsync() Does this page have comments disabled Declaration Task AreCommentsDisabledAsync() Returns Task < Boolean > AvailablePageComponents(String) Gets a list of available client side web parts to use, optionally filtered by a given name Declaration IEnumerable AvailablePageComponents(string name = null) Parameters String name Name of the web part to retrieve Returns IEnumerable < IPageComponent > List of available IPageComponent AvailablePageComponentsAsync(String) Gets a list of available client side web parts to use, optionally filtered by a given name Declaration Task> AvailablePageComponentsAsync(string name = null) Parameters String name Name of the web part to retrieve Returns Task < IEnumerable < IPageComponent >> List of available IPageComponent ClearPage() Clears the sections and controls from the page Declaration void ClearPage() DefaultWebPartToWebPartId(DefaultWebPart) Translates a given DefaultWebPart enum to it's corresponding web part id. Non default web parts will be returned as empty string Declaration string DefaultWebPartToWebPartId(DefaultWebPart webPart) Parameters DefaultWebPart webPart DefaultWebPart enum to translate to it's id Returns String The corresponding web part id Delete() Deletes the created page Declaration void Delete() DeleteAsync() Deletes the created page Declaration Task DeleteAsync() Returns Task DemoteNewsArticle() Demotes an client side Article news page as a regular client side page Declaration void DemoteNewsArticle() DemoteNewsArticleAsync() Demotes an client side Article news page as a regular client side page Declaration Task DemoteNewsArticleAsync() Returns Task DisableComments() Disable commenting on this page Declaration void DisableComments() DisableCommentsAsync() Disable commenting on this page Declaration Task DisableCommentsAsync() Returns Task EnableComments() Enable commenting on this page Declaration void EnableComments() EnableCommentsAsync() Enable commenting on this page Declaration Task EnableCommentsAsync() Returns Task GetComments(Expression>[]) Get list item comments Declaration ICommentCollection GetComments(params Expression>[] selectors) Parameters Expression < Func < IComment , Object >>[] selectors The expressions declaring the fields to select Returns ICommentCollection GetCommentsAsync(Expression>[]) Get list item comments Declaration Task GetCommentsAsync(params Expression>[] selectors) Parameters Expression < Func < IComment , Object >>[] selectors The expressions declaring the fields to select Returns Task < ICommentCollection > GetImageWebPart(String, PageImageOptions) Prepares an Image web part for adding to a page Declaration IPageWebPart GetImageWebPart(string serverRelativeUrl, PageImageOptions imageOptions = null) Parameters String serverRelativeUrl Server relative url of the image to show in the image web part PageImageOptions imageOptions Options to configure the image when being added Returns IPageWebPart Configured image web part which can be added to the page GetImageWebPartAsync(String, PageImageOptions) Prepares an Image web part for adding to a page Declaration Task GetImageWebPartAsync(string serverRelativeUrl, PageImageOptions imageOptions = null) Parameters String serverRelativeUrl Server relative url of the image to show in the image web part PageImageOptions imageOptions Options to configure the image when being added Returns Task < IPageWebPart > Configured image web part which can be added to the page GetInlineImage(IPageText, String, PageImageOptions) Prepares an inline image for adding to text by adding the needed image web part and returning the HTML snippet that needs to be appended to the text editor content Declaration string GetInlineImage(IPageText textEditorInstance, string serverRelativeUrl, PageImageOptions imageOptions = null) Parameters IPageText textEditorInstance Text editor instance to add the inline image to String serverRelativeUrl Server relative url of the image to add inline PageImageOptions imageOptions Options to configure the inline image when being added Returns String Html snippet to be appended to the text editor content GetInlineImageAsync(IPageText, String, PageImageOptions) Prepares an inline image for adding to text by adding the needed image web part and returning the HTML snippet that needs to be appended to the text editor content Declaration Task GetInlineImageAsync(IPageText textEditorInstance, string serverRelativeUrl, PageImageOptions imageOptions = null) Parameters IPageText textEditorInstance Text editor instance to add the inline image to, when the PnP.Core.Model.SharePoint.Page.EditorType is CK5 then this can be left null String serverRelativeUrl Server relative url of the image to add inline PageImageOptions imageOptions Options to configure the inline image when being added Returns Task < String > Html snippet to be appended to the text editor content GetLikedByInformation() Returns information about the likes on this page Declaration ILikedByInformation GetLikedByInformation() Returns ILikedByInformation GetLikedByInformationAsync() Returns information about the likes on this page Declaration Task GetLikedByInformationAsync() Returns Task < ILikedByInformation > GetPageFile(Expression>[]) Gets the file connected to this page Declaration IFile GetPageFile(params Expression>[] expressions) Parameters Expression < Func < IFile , Object >>[] expressions Properties to load for the file Returns IFile The connected IFile GetPageFileAsync(Expression>[]) Gets the file connected to this page Declaration Task GetPageFileAsync(params Expression>[] expressions) Parameters Expression < Func < IFile , Object >>[] expressions Properties to load for the file Returns Task < IFile > The connected IFile GetPageTranslations() Returns the page translation status for a given page Declaration IPageTranslationStatusCollection GetPageTranslations() Returns IPageTranslationStatusCollection IPageTranslationStatusCollection list containing information about this page's translations GetPageTranslationsAsync() Returns the page translation status for a given page Declaration Task GetPageTranslationsAsync() Returns Task < IPageTranslationStatusCollection > IPageTranslationStatusCollection list containing information about this page's translations GetTemplatesFolder() Returns the name of the templates folder, and creates if it doesn't exist. Declaration string GetTemplatesFolder() Returns String GetTemplatesFolderAsync() Returns the name of the templates folder, and creates if it doesn't exist. Declaration Task GetTemplatesFolderAsync() Returns Task < String > InstantiateDefaultWebPart(DefaultWebPart) Instantiates a new web part with default data and returns it Declaration IPageWebPart InstantiateDefaultWebPart(DefaultWebPart webPart) Parameters DefaultWebPart webPart Default web part to instantiate Returns IPageWebPart Instantiated web part InstantiateDefaultWebPartAsync(DefaultWebPart) Instantiates a new web part with default data and returns it Declaration Task InstantiateDefaultWebPartAsync(DefaultWebPart webPart) Parameters DefaultWebPart webPart Default web part to instantiate Returns Task < IPageWebPart > Instantiated web part Like() Likes a page Declaration void Like() LikeAsync() Likes a page Declaration Task LikeAsync() Returns Task NewTextPart(String) Creates a new text part which can be configured and added to the page Declaration IPageText NewTextPart(string text = null) Parameters String text Optionally provide the text for the text part Returns IPageText The created text part NewWebPart(IPageComponent) Creates a new web part Declaration IPageWebPart NewWebPart(IPageComponent clientSideComponent = null) Parameters IPageComponent clientSideComponent The base component to use for this web part Returns IPageWebPart The created web part PromoteAsHomePage() Sets the current IPage as home page for the current site Declaration void PromoteAsHomePage() PromoteAsHomePageAsync() Sets the current IPage as home page for the current site Declaration Task PromoteAsHomePageAsync() Returns Task PromoteAsNewsArticle() Promotes a regular Article client side page as a news page Declaration void PromoteAsNewsArticle() PromoteAsNewsArticleAsync() Promotes a regular Article client side page as a news page Declaration Task PromoteAsNewsArticleAsync() Returns Task Publish(String) Publishes a client side page Declaration void Publish(string comment = null) Parameters String comment Publishing comment PublishAsync(String) Publishes a client side page Declaration Task PublishAsync(string comment = null) Parameters String comment Publishing comment Returns Task RemovePageHeader() Removes the set page header Declaration void RemovePageHeader() RemoveSchedulePublish() Removes the publication schedule of a client side page Declaration void RemoveSchedulePublish() RemoveSchedulePublishAsync() Removes the publication schedule of a client side page Declaration Task RemoveSchedulePublishAsync() Returns Task Save(String) Saves the page to the pages library Declaration string Save(string pageName = null) Parameters String pageName Page name to use Returns String The name of the saved page SaveAsTemplate(String) Saves the page as a template page Declaration string SaveAsTemplate(string pageName = null) Parameters String pageName Page name to use Returns String The name of the saved page SaveAsTemplateAsync(String) Saves the page as a template page Declaration Task SaveAsTemplateAsync(string pageName = null) Parameters String pageName Page name to use Returns Task < String > The name of the saved page SaveAsync(String) Saves the page to the pages library Declaration Task SaveAsync(string pageName = null) Parameters String pageName Page name to use Returns Task < String > The name of the saved page SchedulePublish(DateTime) Schedules the publication of a client side page Declaration void SchedulePublish(DateTime publishDate) Parameters DateTime publishDate Date when the page needs to be publishing SchedulePublishAsync(DateTime) Schedules the publication of a client side page Declaration Task SchedulePublishAsync(DateTime publishDate) Parameters DateTime publishDate Date when the page needs to be publishing Returns Task SetCustomPageHeader(String, Nullable, Nullable) Sets page header with custom focal point Declaration void SetCustomPageHeader(string serverRelativeImageUrl, double? translateX = null, double? translateY = null) Parameters String serverRelativeImageUrl Server relative page header image url Nullable < Double > translateX X focal point for image Nullable < Double > translateY Y focal point for image SetDefaultPageHeader() Sets page header back to the default page header Declaration void SetDefaultPageHeader() TranslatePages() Creates page translations for all the languages defined as multi-lingual languages in the site Declaration IPageTranslationStatusCollection TranslatePages() Returns IPageTranslationStatusCollection IPageTranslationStatusCollection list containing information about this page's translations TranslatePages(PageTranslationOptions) Creates page translations for the requested languages Declaration IPageTranslationStatusCollection TranslatePages(PageTranslationOptions pageTranslationOptions) Parameters PageTranslationOptions pageTranslationOptions Options describing the languages in which a translation needs to be created Returns IPageTranslationStatusCollection IPageTranslationStatusCollection list containing information about this page's translations TranslatePagesAsync() Creates page translations for all the languages defined as multi-lingual languages in the site Declaration Task TranslatePagesAsync() Returns Task < IPageTranslationStatusCollection > IPageTranslationStatusCollection list containing information about this page's translations TranslatePagesAsync(PageTranslationOptions) Creates page translations for the requested languages Declaration Task TranslatePagesAsync(PageTranslationOptions pageTranslationOptions) Parameters PageTranslationOptions pageTranslationOptions Options describing the languages in which a translation needs to be created Returns Task < IPageTranslationStatusCollection > IPageTranslationStatusCollection list containing information about this page's translations Unlike() Unlikes a page Declaration void Unlike() UnlikeAsync() Unlikes a page Declaration Task UnlikeAsync() Returns Task WebPartIdToDefaultWebPart(String) Translated a given web part id to a DefaultWebPart enum. Non default web parts will be returned as ThirdParty Declaration DefaultWebPart WebPartIdToDefaultWebPart(string id) Parameters String id Web part id to lookup Returns DefaultWebPart Corresponding DefaultWebPart enum value" + "keywords": "Interface IPage A modern SharePoint Page Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IPage Properties Controls List of control on this page Declaration List Controls { get; } Property Value PnP.Core.Model.SharePoint.List < ICanvasControl > DefaultSection The default section of the client side page Declaration ICanvasSection DefaultSection { get; } Property Value ICanvasSection EditorType Returns the editor that was used to create/update this page Declaration EditorType EditorType { get; } Property Value EditorType EntityId Entity id field for topic pages Declaration string EntityId { get; set; } Property Value String EntityRelations Entity relations field for topic pages Declaration string EntityRelations { get; set; } Property Value String EntityType Entity type field for topic pages Declaration string EntityType { get; set; } Property Value String Folder Folder the page lives in (available after saving the page) Declaration string Folder { get; } Property Value String HeaderControls List of controls on this page's header Declaration List HeaderControls { get; } Property Value PnP.Core.Model.SharePoint.List < ICanvasControl > KeepDefaultWebParts When a page of type Home is created you can opt to only keep the default client side web parts by setting this to true. This also is a way to reset your home page back the the stock one. Declaration bool KeepDefaultWebParts { get; set; } Property Value Boolean LayoutType Layout type of the client side page Declaration PageLayoutType LayoutType { get; set; } Property Value PageLayoutType Name The name of this page (available after saving the page) Declaration string Name { get; } Property Value String PageHeader Returns the page header for this page Declaration IPageHeader PageHeader { get; } Property Value IPageHeader PageId ID value of the page (only available when the page was saved) Declaration int? PageId { get; } Property Value Nullable < Int32 > PageListItem ListItem linked to this page Declaration IListItem PageListItem { get; } Property Value IListItem PagesLibrary Pages library Declaration IList PagesLibrary { get; } Property Value IList PageTitle Title of the client side page Declaration string PageTitle { get; set; } Property Value String PnPContext PnPContext to work with Declaration PnPContext PnPContext { get; } Property Value PnPContext RepostDescription Description of the repost page Declaration string RepostDescription { get; set; } Property Value String RepostSourceItemId Id of the SharePoint IListItem connected to the page being reposted Declaration Guid RepostSourceItemId { get; set; } Property Value Guid RepostSourceListId Id of the SharePoint IList containting the page being reposted Declaration Guid RepostSourceListId { get; set; } Property Value Guid RepostSourceSiteId Id of the SharePoint ISite containting the page being reposted Declaration Guid RepostSourceSiteId { get; set; } Property Value Guid RepostSourceUrl Url being reposted using the repost page Declaration string RepostSourceUrl { get; set; } Property Value String RepostSourceWebId Id of the SharePoint IWeb containting the page being reposted Declaration Guid RepostSourceWebId { get; set; } Property Value Guid ScheduledPublishDate Returns the scheduled publish data of a page (only if publish was scheduled) Declaration DateTime? ScheduledPublishDate { get; } Property Value Nullable < DateTime > Sections List of sections on this page Declaration List Sections { get; } Property Value PnP.Core.Model.SharePoint.List < ICanvasSection > SpaceContent Space content field (JSON) for spaces pages Declaration string SpaceContent { get; set; } Property Value String ThumbnailUrl Thumbnail url for the page Declaration string ThumbnailUrl { get; set; } Property Value String Methods AddControl(ICanvasControl) Adds a new control to your client side page using the default ICanvasSection Declaration void AddControl(ICanvasControl control) Parameters ICanvasControl control ICanvasControl to add AddControl(ICanvasControl, ICanvasColumn) Adds a new control to your client side page in the given section Declaration void AddControl(ICanvasControl control, ICanvasColumn column) Parameters ICanvasControl control ICanvasControl to add ICanvasColumn column ICanvasColumn that will hold the control AddControl(ICanvasControl, ICanvasColumn, Int32) Adds a new control to your client side page in the given section with a given order Declaration void AddControl(ICanvasControl control, ICanvasColumn column, int order) Parameters ICanvasControl control ICanvasControl to add ICanvasColumn column ICanvasColumn that will hold the control Int32 order Order of the control in the given section AddControl(ICanvasControl, ICanvasSection) Adds a new control to your client side page in the given section Declaration void AddControl(ICanvasControl control, ICanvasSection section) Parameters ICanvasControl control ICanvasControl to add ICanvasSection section ICanvasSection that will hold the control. Control will end up in the DefaultColumn . AddControl(ICanvasControl, ICanvasSection, Int32) Adds a new control to your client side page in the given section with a given order Declaration void AddControl(ICanvasControl control, ICanvasSection section, int order) Parameters ICanvasControl control ICanvasControl to add ICanvasSection section ICanvasSection that will hold the control. Control will end up in the DefaultColumn . Int32 order Order of the control in the given section AddControl(ICanvasControl, Int32) Adds a new control to your client side page using the default ICanvasSection using a given order Declaration void AddControl(ICanvasControl control, int order) Parameters ICanvasControl control ICanvasControl to add Int32 order Order of the control in the default section AddHeaderControl(ICanvasControl, Int32) Adds a new header control to your client side page with a given order. Used for topic page creation Declaration void AddHeaderControl(ICanvasControl control, int order) Parameters ICanvasControl control ICanvasControl to add Int32 order Order of the control in the given section AddSection(CanvasSectionTemplate, Single) Adds a new section to your client side page Declaration void AddSection(CanvasSectionTemplate sectionTemplate, float order) Parameters CanvasSectionTemplate sectionTemplate The CanvasSectionTemplate type of the section Single order Controls the order of the new section AddSection(CanvasSectionTemplate, Single, VariantThemeType, VariantThemeType) Adds a new section to your client side page Declaration void AddSection(CanvasSectionTemplate sectionTemplate, float order, VariantThemeType zoneEmphasis, VariantThemeType verticalSectionZoneEmphasis = default(VariantThemeType)) Parameters CanvasSectionTemplate sectionTemplate The CanvasSectionTemplate type of the section Single order Controls the order of the new section VariantThemeType zoneEmphasis Zone emphasis (section background) VariantThemeType verticalSectionZoneEmphasis Vertical Section Zone emphasis (section background) AddSection(CanvasSectionTemplate, Single, Int32, Nullable) Adds a new section to your client side page Declaration void AddSection(CanvasSectionTemplate sectionTemplate, float order, int zoneEmphasis, int? verticalSectionZoneEmphasis = null) Parameters CanvasSectionTemplate sectionTemplate The CanvasSectionTemplate type of the section Single order Controls the order of the new section Int32 zoneEmphasis Zone emphasis (section background) Nullable < Int32 > verticalSectionZoneEmphasis Vertical Section Zone emphasis (section background) AddSection(ICanvasSection) Adds a new section to your client side page Declaration void AddSection(ICanvasSection section) Parameters ICanvasSection section ICanvasSection object describing the section to add AddSection(ICanvasSection, Single) Adds a new section to your client side page with a given order Declaration void AddSection(ICanvasSection section, float order) Parameters ICanvasSection section ICanvasSection object describing the section to add Single order Controls the order of the new section AreCommentsDisabled() Does this page have comments disabled Declaration bool AreCommentsDisabled() Returns Boolean AreCommentsDisabledAsync() Does this page have comments disabled Declaration Task AreCommentsDisabledAsync() Returns Task < Boolean > AvailablePageComponents(String) Gets a list of available client side web parts to use, optionally filtered by a given name Declaration IEnumerable AvailablePageComponents(string name = null) Parameters String name Name of the web part to retrieve Returns IEnumerable < IPageComponent > List of available IPageComponent AvailablePageComponentsAsync(String) Gets a list of available client side web parts to use, optionally filtered by a given name Declaration Task> AvailablePageComponentsAsync(string name = null) Parameters String name Name of the web part to retrieve Returns Task < IEnumerable < IPageComponent >> List of available IPageComponent ClearPage() Clears the sections and controls from the page Declaration void ClearPage() DefaultWebPartToWebPartId(DefaultWebPart) Translates a given DefaultWebPart enum to it's corresponding web part id. Non default web parts will be returned as empty string Declaration string DefaultWebPartToWebPartId(DefaultWebPart webPart) Parameters DefaultWebPart webPart DefaultWebPart enum to translate to it's id Returns String The corresponding web part id Delete() Deletes the created page Declaration void Delete() DeleteAsync() Deletes the created page Declaration Task DeleteAsync() Returns Task DemoteNewsArticle() Demotes an client side Article news page as a regular client side page Declaration void DemoteNewsArticle() DemoteNewsArticleAsync() Demotes an client side Article news page as a regular client side page Declaration Task DemoteNewsArticleAsync() Returns Task DisableComments() Disable commenting on this page Declaration void DisableComments() DisableCommentsAsync() Disable commenting on this page Declaration Task DisableCommentsAsync() Returns Task EnableComments() Enable commenting on this page Declaration void EnableComments() EnableCommentsAsync() Enable commenting on this page Declaration Task EnableCommentsAsync() Returns Task GetComments(Expression>[]) Get list item comments Declaration ICommentCollection GetComments(params Expression>[] selectors) Parameters Expression < Func < IComment , System.Object >>[] selectors The expressions declaring the fields to select Returns ICommentCollection GetCommentsAsync(Expression>[]) Get list item comments Declaration Task GetCommentsAsync(params Expression>[] selectors) Parameters Expression < Func < IComment , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < ICommentCollection > GetImageWebPart(String, PageImageOptions) Prepares an Image web part for adding to a page Declaration IPageWebPart GetImageWebPart(string serverRelativeUrl, PageImageOptions imageOptions = null) Parameters String serverRelativeUrl Server relative url of the image to show in the image web part PageImageOptions imageOptions Options to configure the image when being added Returns IPageWebPart Configured image web part which can be added to the page GetImageWebPartAsync(String, PageImageOptions) Prepares an Image web part for adding to a page Declaration Task GetImageWebPartAsync(string serverRelativeUrl, PageImageOptions imageOptions = null) Parameters String serverRelativeUrl Server relative url of the image to show in the image web part PageImageOptions imageOptions Options to configure the image when being added Returns Task < IPageWebPart > Configured image web part which can be added to the page GetInlineImage(IPageText, String, PageImageOptions) Prepares an inline image for adding to text by adding the needed image web part and returning the HTML snippet that needs to be appended to the text editor content Declaration string GetInlineImage(IPageText textEditorInstance, string serverRelativeUrl, PageImageOptions imageOptions = null) Parameters IPageText textEditorInstance Text editor instance to add the inline image to String serverRelativeUrl Server relative url of the image to add inline PageImageOptions imageOptions Options to configure the inline image when being added Returns String Html snippet to be appended to the text editor content GetInlineImageAsync(IPageText, String, PageImageOptions) Prepares an inline image for adding to text by adding the needed image web part and returning the HTML snippet that needs to be appended to the text editor content Declaration Task GetInlineImageAsync(IPageText textEditorInstance, string serverRelativeUrl, PageImageOptions imageOptions = null) Parameters IPageText textEditorInstance Text editor instance to add the inline image to, when the PnP.Core.Model.SharePoint.Page.EditorType is CK5 then this can be left null String serverRelativeUrl Server relative url of the image to add inline PageImageOptions imageOptions Options to configure the inline image when being added Returns Task < String > Html snippet to be appended to the text editor content GetLikedByInformation() Returns information about the likes on this page Declaration ILikedByInformation GetLikedByInformation() Returns ILikedByInformation GetLikedByInformationAsync() Returns information about the likes on this page Declaration Task GetLikedByInformationAsync() Returns Task < ILikedByInformation > GetPageFile(Expression>[]) Gets the file connected to this page Declaration IFile GetPageFile(params Expression>[] expressions) Parameters Expression < Func < IFile , System.Object >>[] expressions Properties to load for the file Returns IFile The connected IFile GetPageFileAsync(Expression>[]) Gets the file connected to this page Declaration Task GetPageFileAsync(params Expression>[] expressions) Parameters Expression < Func < IFile , System.Object >>[] expressions Properties to load for the file Returns Task < IFile > The connected IFile GetPageTranslations() Returns the page translation status for a given page Declaration IPageTranslationStatusCollection GetPageTranslations() Returns IPageTranslationStatusCollection IPageTranslationStatusCollection list containing information about this page's translations GetPageTranslationsAsync() Returns the page translation status for a given page Declaration Task GetPageTranslationsAsync() Returns Task < IPageTranslationStatusCollection > IPageTranslationStatusCollection list containing information about this page's translations GetTemplatesFolder() Returns the name of the templates folder, and creates if it doesn't exist. Declaration string GetTemplatesFolder() Returns String GetTemplatesFolderAsync() Returns the name of the templates folder, and creates if it doesn't exist. Declaration Task GetTemplatesFolderAsync() Returns Task < String > InstantiateDefaultWebPart(DefaultWebPart) Instantiates a new web part with default data and returns it Declaration IPageWebPart InstantiateDefaultWebPart(DefaultWebPart webPart) Parameters DefaultWebPart webPart Default web part to instantiate Returns IPageWebPart Instantiated web part InstantiateDefaultWebPartAsync(DefaultWebPart) Instantiates a new web part with default data and returns it Declaration Task InstantiateDefaultWebPartAsync(DefaultWebPart webPart) Parameters DefaultWebPart webPart Default web part to instantiate Returns Task < IPageWebPart > Instantiated web part Like() Likes a page Declaration void Like() LikeAsync() Likes a page Declaration Task LikeAsync() Returns Task NewTextPart(String) Creates a new text part which can be configured and added to the page Declaration IPageText NewTextPart(string text = null) Parameters String text Optionally provide the text for the text part Returns IPageText The created text part NewWebPart(IPageComponent) Creates a new web part Declaration IPageWebPart NewWebPart(IPageComponent clientSideComponent = null) Parameters IPageComponent clientSideComponent The base component to use for this web part Returns IPageWebPart The created web part PromoteAsHomePage() Sets the current IPage as home page for the current site Declaration void PromoteAsHomePage() PromoteAsHomePageAsync() Sets the current IPage as home page for the current site Declaration Task PromoteAsHomePageAsync() Returns Task PromoteAsNewsArticle() Promotes a regular Article client side page as a news page Declaration void PromoteAsNewsArticle() PromoteAsNewsArticleAsync() Promotes a regular Article client side page as a news page Declaration Task PromoteAsNewsArticleAsync() Returns Task Publish(String) Publishes a client side page Declaration void Publish(string comment = null) Parameters String comment Publishing comment PublishAsync(String) Publishes a client side page Declaration Task PublishAsync(string comment = null) Parameters String comment Publishing comment Returns Task RemovePageHeader() Removes the set page header Declaration void RemovePageHeader() RemoveSchedulePublish() Removes the publication schedule of a client side page Declaration void RemoveSchedulePublish() RemoveSchedulePublishAsync() Removes the publication schedule of a client side page Declaration Task RemoveSchedulePublishAsync() Returns Task Save(String) Saves the page to the pages library Declaration string Save(string pageName = null) Parameters String pageName Page name to use Returns String The name of the saved page SaveAsTemplate(String) Saves the page as a template page Declaration string SaveAsTemplate(string pageName = null) Parameters String pageName Page name to use Returns String The name of the saved page SaveAsTemplateAsync(String) Saves the page as a template page Declaration Task SaveAsTemplateAsync(string pageName = null) Parameters String pageName Page name to use Returns Task < String > The name of the saved page SaveAsync(String) Saves the page to the pages library Declaration Task SaveAsync(string pageName = null) Parameters String pageName Page name to use Returns Task < String > The name of the saved page SchedulePublish(DateTime) Schedules the publication of a client side page Declaration void SchedulePublish(DateTime publishDate) Parameters DateTime publishDate Date when the page needs to be publishing SchedulePublishAsync(DateTime) Schedules the publication of a client side page Declaration Task SchedulePublishAsync(DateTime publishDate) Parameters DateTime publishDate Date when the page needs to be publishing Returns Task SetCustomPageHeader(String, Nullable, Nullable) Sets page header with custom focal point Declaration void SetCustomPageHeader(string serverRelativeImageUrl, double? translateX = null, double? translateY = null) Parameters String serverRelativeImageUrl Server relative page header image url Nullable < Double > translateX X focal point for image Nullable < Double > translateY Y focal point for image SetDefaultPageHeader() Sets page header back to the default page header Declaration void SetDefaultPageHeader() TranslatePages() Creates page translations for all the languages defined as multi-lingual languages in the site Declaration IPageTranslationStatusCollection TranslatePages() Returns IPageTranslationStatusCollection IPageTranslationStatusCollection list containing information about this page's translations TranslatePages(PageTranslationOptions) Creates page translations for the requested languages Declaration IPageTranslationStatusCollection TranslatePages(PageTranslationOptions pageTranslationOptions) Parameters PageTranslationOptions pageTranslationOptions Options describing the languages in which a translation needs to be created Returns IPageTranslationStatusCollection IPageTranslationStatusCollection list containing information about this page's translations TranslatePagesAsync() Creates page translations for all the languages defined as multi-lingual languages in the site Declaration Task TranslatePagesAsync() Returns Task < IPageTranslationStatusCollection > IPageTranslationStatusCollection list containing information about this page's translations TranslatePagesAsync(PageTranslationOptions) Creates page translations for the requested languages Declaration Task TranslatePagesAsync(PageTranslationOptions pageTranslationOptions) Parameters PageTranslationOptions pageTranslationOptions Options describing the languages in which a translation needs to be created Returns Task < IPageTranslationStatusCollection > IPageTranslationStatusCollection list containing information about this page's translations Unlike() Unlikes a page Declaration void Unlike() UnlikeAsync() Unlikes a page Declaration Task UnlikeAsync() Returns Task WebPartIdToDefaultWebPart(String) Translated a given web part id to a DefaultWebPart enum. Non default web parts will be returned as ThirdParty Declaration DefaultWebPart WebPartIdToDefaultWebPart(string id) Parameters String id Web part id to lookup Returns DefaultWebPart Corresponding DefaultWebPart enum value" }, "api/PnP.Core.Model.SharePoint.IPageComponent.html": { "href": "api/PnP.Core.Model.SharePoint.IPageComponent.html", @@ -2092,7 +2092,7 @@ "api/PnP.Core.Model.SharePoint.IPersonProperties.html": { "href": "api/PnP.Core.Model.SharePoint.IPersonProperties.html", "title": "Interface IPersonProperties | PnP Core SDK", - "keywords": "Interface IPersonProperties A metadata for a person Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IPersonProperties Properties AccountName Person's account name in a form of \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Declaration string AccountName { get; set; } Property Value String DirectReports Direct reports for the current user Declaration List DirectReports { get; set; } Property Value PnP.Core.Model.SharePoint.List < String > DisplayName Persons' display name Declaration string DisplayName { get; set; } Property Value String Email Person's email Declaration string Email { get; set; } Property Value String ExtendedManagers Extended managers for the current user Declaration List ExtendedManagers { get; set; } Property Value PnP.Core.Model.SharePoint.List < String > ExtendedReports Extended reports for the current user Declaration List ExtendedReports { get; set; } Property Value PnP.Core.Model.SharePoint.List < String > IsFollowed Whether the current user is followed or not Declaration bool IsFollowed { get; set; } Property Value Boolean LatestPost Person's latest post url Declaration string LatestPost { get; set; } Property Value String Peers Current user's peers Declaration List Peers { get; set; } Property Value PnP.Core.Model.SharePoint.List < String > PersonalSiteHostUrl Person's site host url Declaration string PersonalSiteHostUrl { get; set; } Property Value String PersonalUrl Person's personal url Declaration string PersonalUrl { get; set; } Property Value String PictureUrl Profile photo url Declaration string PictureUrl { get; set; } Property Value String Title Person's title Declaration string Title { get; set; } Property Value String UserProfileProperties User profile properties key-value collection Declaration Dictionary UserProfileProperties { get; set; } Property Value Dictionary < String , Object > UserUrl User url Declaration string UserUrl { get; set; } Property Value String" + "keywords": "Interface IPersonProperties A metadata for a person Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IPersonProperties Properties AccountName Person's account name in a form of \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Declaration string AccountName { get; set; } Property Value String DirectReports Direct reports for the current user Declaration List DirectReports { get; set; } Property Value PnP.Core.Model.SharePoint.List < String > DisplayName Persons' display name Declaration string DisplayName { get; set; } Property Value String Email Person's email Declaration string Email { get; set; } Property Value String ExtendedManagers Extended managers for the current user Declaration List ExtendedManagers { get; set; } Property Value PnP.Core.Model.SharePoint.List < String > ExtendedReports Extended reports for the current user Declaration List ExtendedReports { get; set; } Property Value PnP.Core.Model.SharePoint.List < String > IsFollowed Whether the current user is followed or not Declaration bool IsFollowed { get; set; } Property Value Boolean LatestPost Person's latest post url Declaration string LatestPost { get; set; } Property Value String Peers Current user's peers Declaration List Peers { get; set; } Property Value PnP.Core.Model.SharePoint.List < String > PersonalSiteHostUrl Person's site host url Declaration string PersonalSiteHostUrl { get; set; } Property Value String PersonalUrl Person's personal url Declaration string PersonalUrl { get; set; } Property Value String PictureUrl Profile photo url Declaration string PictureUrl { get; set; } Property Value String Title Person's title Declaration string Title { get; set; } Property Value String UserProfileProperties User profile properties key-value collection Declaration Dictionary UserProfileProperties { get; set; } Property Value Dictionary < String , System.Object > UserUrl User url Declaration string UserUrl { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.IPropertyValues.html": { "href": "api/PnP.Core.Model.SharePoint.IPropertyValues.html", @@ -2102,17 +2102,17 @@ "api/PnP.Core.Model.SharePoint.IRecycleBinItem.html": { "href": "api/PnP.Core.Model.SharePoint.IRecycleBinItem.html", "title": "Interface IRecycleBinItem | PnP Core SDK", - "keywords": "Interface IRecycleBinItem Public interface to define a RecycleBinItem object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IRecycleBinItem : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object Author Gets a value that specifies the user who created the Recycle Bin item. Declaration ISharePointUser Author { get; } Property Value ISharePointUser AuthorEmail Gets the e-mail address of the user who created the recycle bin item. Declaration string AuthorEmail { get; } Property Value String AuthorName Gets the name of the user who created the recycle bin item. Declaration string AuthorName { get; } Property Value String DeletedBy Gets a value that specifies the user who deleted the Recycle Bin item. Declaration ISharePointUser DeletedBy { get; } Property Value ISharePointUser DeletedByEmail Gets the e-mail address of the user who deleted the recycle bin item. Declaration string DeletedByEmail { get; } Property Value String DeletedByName Gets the name of the user who deleted the recycle bin item. Declaration string DeletedByName { get; } Property Value String DeletedDate Gets a value that specifies when the Recycle Bin item was moved to the Recycle Bin. Declaration DateTime DeletedDate { get; } Property Value DateTime DeletedDateLocalFormatted Gets a value that specifies when the Recycle Bin item was moved to the Recycle Bin formatted in the local date. Declaration string DeletedDateLocalFormatted { get; } Property Value String DirName Gets a value that specifies the site relative URL of the list or folder that originally contained the Recycle Bin item. Declaration string DirName { get; } Property Value String Id Gets a value that specifies the identifier of the Recycle Bin item. Declaration Guid Id { get; } Property Value Guid ItemState Gets a value that specifies the Recycle Bin stage of the Recycle Bin item. Declaration RecycleBinItemState ItemState { get; } Property Value RecycleBinItemState ItemType Gets a value that specifies the type of the Recycle Bin item. Declaration RecycleBinItemType ItemType { get; } Property Value RecycleBinItemType LeafName Gets a value that specifies the leaf name of the Recycle Bin item. Declaration string LeafName { get; } Property Value String Size Gets a value that specifies the size of the Recycle Bin item in bytes. Declaration long Size { get; } Property Value Int64 Title Gets a value that specifies the title of the Recycle Bin item. Declaration string Title { get; } Property Value String Methods MoveToSecondStage() Move the recycle bin item to the second stage recycle bin Declaration void MoveToSecondStage() MoveToSecondStageAsync() Move the recycle bin item to the second stage recycle bin Declaration Task MoveToSecondStageAsync() Returns Task MoveToSecondStageBatch() Move the recycle bin item to the second stage recycle bin using the current context batch instance Declaration void MoveToSecondStageBatch() MoveToSecondStageBatch(Batch) Move the recycle bin item to the second stage recycle bin using a specific batch instance The batch instance to use. Declaration void MoveToSecondStageBatch(Batch batch) Parameters Batch batch MoveToSecondStageBatchAsync() Move the recycle bin item to the second stage recycle bin using the current context batch instance Declaration Task MoveToSecondStageBatchAsync() Returns Task MoveToSecondStageBatchAsync(Batch) Move the recycle bin item to the second stage recycle bin using a specific batch instance The batch instance to use. Declaration Task MoveToSecondStageBatchAsync(Batch batch) Parameters Batch batch Returns Task Restore() Restores the recycle bin item to its original location. Declaration void Restore() RestoreAsync() Restores the recycle bin item to its original location. Declaration Task RestoreAsync() Returns Task RestoreBatch() Restores the recycle bin item to its original location using the current context batch instance Declaration void RestoreBatch() RestoreBatch(Batch) Restores the recycle bin item to its original location using a specific batch instance The batch instance to use. Declaration void RestoreBatch(Batch batch) Parameters Batch batch RestoreBatchAsync() Restores the recycle bin item to its original location using the current context batch instance Declaration Task RestoreBatchAsync() Returns Task RestoreBatchAsync(Batch) Restores the recycle bin item to its original location using a specific batch instance The batch instance to use. Declaration Task RestoreBatchAsync(Batch batch) Parameters Batch batch Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IRecycleBinItem Public interface to define a RecycleBinItem object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IRecycleBinItem : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object Author Gets a value that specifies the user who created the Recycle Bin item. Declaration ISharePointUser Author { get; } Property Value ISharePointUser AuthorEmail Gets the e-mail address of the user who created the recycle bin item. Declaration string AuthorEmail { get; } Property Value String AuthorName Gets the name of the user who created the recycle bin item. Declaration string AuthorName { get; } Property Value String DeletedBy Gets a value that specifies the user who deleted the Recycle Bin item. Declaration ISharePointUser DeletedBy { get; } Property Value ISharePointUser DeletedByEmail Gets the e-mail address of the user who deleted the recycle bin item. Declaration string DeletedByEmail { get; } Property Value String DeletedByName Gets the name of the user who deleted the recycle bin item. Declaration string DeletedByName { get; } Property Value String DeletedDate Gets a value that specifies when the Recycle Bin item was moved to the Recycle Bin. Declaration DateTime DeletedDate { get; } Property Value DateTime DeletedDateLocalFormatted Gets a value that specifies when the Recycle Bin item was moved to the Recycle Bin formatted in the local date. Declaration string DeletedDateLocalFormatted { get; } Property Value String DirName Gets a value that specifies the site relative URL of the list or folder that originally contained the Recycle Bin item. Declaration string DirName { get; } Property Value String Id Gets a value that specifies the identifier of the Recycle Bin item. Declaration Guid Id { get; } Property Value Guid ItemState Gets a value that specifies the Recycle Bin stage of the Recycle Bin item. Declaration RecycleBinItemState ItemState { get; } Property Value RecycleBinItemState ItemType Gets a value that specifies the type of the Recycle Bin item. Declaration RecycleBinItemType ItemType { get; } Property Value RecycleBinItemType LeafName Gets a value that specifies the leaf name of the Recycle Bin item. Declaration string LeafName { get; } Property Value String Size Gets a value that specifies the size of the Recycle Bin item in bytes. Declaration long Size { get; } Property Value Int64 Title Gets a value that specifies the title of the Recycle Bin item. Declaration string Title { get; } Property Value String Methods MoveToSecondStage() Move the recycle bin item to the second stage recycle bin Declaration void MoveToSecondStage() MoveToSecondStageAsync() Move the recycle bin item to the second stage recycle bin Declaration Task MoveToSecondStageAsync() Returns Task MoveToSecondStageBatch() Move the recycle bin item to the second stage recycle bin using the current context batch instance Declaration void MoveToSecondStageBatch() MoveToSecondStageBatch(Batch) Move the recycle bin item to the second stage recycle bin using a specific batch instance The batch instance to use. Declaration void MoveToSecondStageBatch(Batch batch) Parameters Batch batch MoveToSecondStageBatchAsync() Move the recycle bin item to the second stage recycle bin using the current context batch instance Declaration Task MoveToSecondStageBatchAsync() Returns Task MoveToSecondStageBatchAsync(Batch) Move the recycle bin item to the second stage recycle bin using a specific batch instance The batch instance to use. Declaration Task MoveToSecondStageBatchAsync(Batch batch) Parameters Batch batch Returns Task Restore() Restores the recycle bin item to its original location. Declaration void Restore() RestoreAsync() Restores the recycle bin item to its original location. Declaration Task RestoreAsync() Returns Task RestoreBatch() Restores the recycle bin item to its original location using the current context batch instance Declaration void RestoreBatch() RestoreBatch(Batch) Restores the recycle bin item to its original location using a specific batch instance The batch instance to use. Declaration void RestoreBatch(Batch batch) Parameters Batch batch RestoreBatchAsync() Restores the recycle bin item to its original location using the current context batch instance Declaration Task RestoreBatchAsync() Returns Task RestoreBatchAsync(Batch) Restores the recycle bin item to its original location using a specific batch instance The batch instance to use. Declaration Task RestoreBatchAsync(Batch batch) Parameters Batch batch Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IRecycleBinItemCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IRecycleBinItemCollection.html", "title": "Interface IRecycleBinItemCollection | PnP Core SDK", - "keywords": "Interface IRecycleBinItemCollection Public interface to define a collection of RecycleBinItem objects Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() IDataModelCollectionLoad.LoadAsync(Expression>[]) IDataModelCollectionLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelCollectionDeleteByGuidId.DeleteById(Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdAsync(Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdBatch(Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdBatchAsync(Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdBatch(Batch, Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdBatchAsync(Batch, Guid) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IRecycleBinItemCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad, IDataModelCollectionDeleteByGuidId, ISupportModules Methods DeleteAll() Permanently deletes all Recycle Bin items. Declaration void DeleteAll() DeleteAllAsync() Permanently deletes all Recycle Bin items. Declaration Task DeleteAllAsync() Returns Task DeleteAllBatch() Permanently deletes all Recycle Bin items using the current context batch instance. Declaration void DeleteAllBatch() DeleteAllBatch(Batch) Permanently deletes all Recycle Bin items using a specific batch instance. Declaration void DeleteAllBatch(Batch batch) Parameters Batch batch DeleteAllBatchAsync() Permanently deletes all Recycle Bin items using the current context batch instance. Declaration Task DeleteAllBatchAsync() Returns Task DeleteAllBatchAsync(Batch) Permanently deletes all Recycle Bin items using a specific batch instance. Declaration Task DeleteAllBatchAsync(Batch batch) Parameters Batch batch Returns Task DeleteAllSecondStageItems() Permanently deletes second stage Recycle Bin items. Declaration void DeleteAllSecondStageItems() DeleteAllSecondStageItemsAsync() Permanently deletes second stage Recycle Bin items. Declaration Task DeleteAllSecondStageItemsAsync() Returns Task DeleteAllSecondStageItemsBatch() Permanently deletes all Recycle Bin items using the current context batch instance. Declaration void DeleteAllSecondStageItemsBatch() DeleteAllSecondStageItemsBatch(Batch) Permanently deletes second stage Recycle Bin items using a specific batch instance. Declaration void DeleteAllSecondStageItemsBatch(Batch batch) Parameters Batch batch DeleteAllSecondStageItemsBatchAsync() Permanently deletes second stage Recycle Bin items using the current context batch instance. Declaration Task DeleteAllSecondStageItemsBatchAsync() Returns Task DeleteAllSecondStageItemsBatchAsync(Batch) Permanently deletes second stage Recycle Bin items using a specific batch instance. Declaration Task DeleteAllSecondStageItemsBatchAsync(Batch batch) Parameters Batch batch Returns Task GetById(Guid, Expression>[]) Method to select a recycle bin item ( IRecycleBinItem ) by id Declaration IRecycleBinItem GetById(Guid id, params Expression>[] selectors) Parameters Guid id The Id to search for Expression < Func < IRecycleBinItem , Object >>[] selectors The expressions declaring the fields to select Returns IRecycleBinItem The resulting recycle bin item instance, if any GetByIdAsync(Guid, Expression>[]) Method to select a recycle bin item ( IRecycleBinItem ) by id asynchronously Declaration Task GetByIdAsync(Guid id, params Expression>[] selectors) Parameters Guid id The Id to search for Expression < Func < IRecycleBinItem , Object >>[] selectors The expressions declaring the fields to select Returns Task < IRecycleBinItem > The resulting recycle bin item instance, if any MoveAllToSecondStage() Move all Recycle Bin items to second stage. Declaration void MoveAllToSecondStage() MoveAllToSecondStageAsync() Move all Recycle Bin items to second stage. Declaration Task MoveAllToSecondStageAsync() Returns Task MoveAllToSecondStageBatch() Move all Recycle Bin items to second stage using the current context batch instance. Declaration void MoveAllToSecondStageBatch() MoveAllToSecondStageBatch(Batch) Move all Recycle Bin items to second stage using a specific batch instance. Declaration void MoveAllToSecondStageBatch(Batch batch) Parameters Batch batch MoveAllToSecondStageBatchAsync() Move all Recycle Bin items to second stage using the current context batch instance. Declaration Task MoveAllToSecondStageBatchAsync() Returns Task MoveAllToSecondStageBatchAsync(Batch) Move all Recycle Bin items to second stage using a specific batch instance. Declaration Task MoveAllToSecondStageBatchAsync(Batch batch) Parameters Batch batch Returns Task RestoreAll() Restores all Recycle Bin items to their original locations. Declaration void RestoreAll() RestoreAllAsync() Restores all Recycle Bin items to their original locations. Declaration Task RestoreAllAsync() Returns Task RestoreAllBatch() Restores all Recycle Bin items to their original locations using the current context batch instance. Declaration void RestoreAllBatch() RestoreAllBatch(Batch) Restores all Recycle Bin items to their original locations using a specific batch instance. Declaration void RestoreAllBatch(Batch batch) Parameters Batch batch RestoreAllBatchAsync() Restores all Recycle Bin items to their original locations using the current context batch instance. Declaration Task RestoreAllBatchAsync() Returns Task RestoreAllBatchAsync(Batch) Restores all Recycle Bin items to their original locations using a specific batch instance. Declaration Task RestoreAllBatchAsync(Batch batch) Parameters Batch batch Returns Task Extension Methods DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.Load(IDataModelCollectionLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" + "keywords": "Interface IRecycleBinItemCollection Public interface to define a collection of RecycleBinItem objects Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() IDataModelCollectionLoad.LoadAsync(Expression>[]) IDataModelCollectionLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelCollectionDeleteByGuidId.DeleteById(Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdAsync(Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdBatch(Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdBatchAsync(Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdBatch(Batch, Guid) IDataModelCollectionDeleteByGuidId.DeleteByIdBatchAsync(Batch, Guid) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IRecycleBinItemCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad, IDataModelCollectionDeleteByGuidId, ISupportModules Methods DeleteAll() Permanently deletes all Recycle Bin items. Declaration void DeleteAll() DeleteAllAsync() Permanently deletes all Recycle Bin items. Declaration Task DeleteAllAsync() Returns Task DeleteAllBatch() Permanently deletes all Recycle Bin items using the current context batch instance. Declaration void DeleteAllBatch() DeleteAllBatch(Batch) Permanently deletes all Recycle Bin items using a specific batch instance. Declaration void DeleteAllBatch(Batch batch) Parameters Batch batch DeleteAllBatchAsync() Permanently deletes all Recycle Bin items using the current context batch instance. Declaration Task DeleteAllBatchAsync() Returns Task DeleteAllBatchAsync(Batch) Permanently deletes all Recycle Bin items using a specific batch instance. Declaration Task DeleteAllBatchAsync(Batch batch) Parameters Batch batch Returns Task DeleteAllSecondStageItems() Permanently deletes second stage Recycle Bin items. Declaration void DeleteAllSecondStageItems() DeleteAllSecondStageItemsAsync() Permanently deletes second stage Recycle Bin items. Declaration Task DeleteAllSecondStageItemsAsync() Returns Task DeleteAllSecondStageItemsBatch() Permanently deletes all Recycle Bin items using the current context batch instance. Declaration void DeleteAllSecondStageItemsBatch() DeleteAllSecondStageItemsBatch(Batch) Permanently deletes second stage Recycle Bin items using a specific batch instance. Declaration void DeleteAllSecondStageItemsBatch(Batch batch) Parameters Batch batch DeleteAllSecondStageItemsBatchAsync() Permanently deletes second stage Recycle Bin items using the current context batch instance. Declaration Task DeleteAllSecondStageItemsBatchAsync() Returns Task DeleteAllSecondStageItemsBatchAsync(Batch) Permanently deletes second stage Recycle Bin items using a specific batch instance. Declaration Task DeleteAllSecondStageItemsBatchAsync(Batch batch) Parameters Batch batch Returns Task GetById(Guid, Expression>[]) Method to select a recycle bin item ( IRecycleBinItem ) by id Declaration IRecycleBinItem GetById(Guid id, params Expression>[] selectors) Parameters Guid id The Id to search for Expression < Func < IRecycleBinItem , System.Object >>[] selectors The expressions declaring the fields to select Returns IRecycleBinItem The resulting recycle bin item instance, if any GetByIdAsync(Guid, Expression>[]) Method to select a recycle bin item ( IRecycleBinItem ) by id asynchronously Declaration Task GetByIdAsync(Guid id, params Expression>[] selectors) Parameters Guid id The Id to search for Expression < Func < IRecycleBinItem , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < IRecycleBinItem > The resulting recycle bin item instance, if any MoveAllToSecondStage() Move all Recycle Bin items to second stage. Declaration void MoveAllToSecondStage() MoveAllToSecondStageAsync() Move all Recycle Bin items to second stage. Declaration Task MoveAllToSecondStageAsync() Returns Task MoveAllToSecondStageBatch() Move all Recycle Bin items to second stage using the current context batch instance. Declaration void MoveAllToSecondStageBatch() MoveAllToSecondStageBatch(Batch) Move all Recycle Bin items to second stage using a specific batch instance. Declaration void MoveAllToSecondStageBatch(Batch batch) Parameters Batch batch MoveAllToSecondStageBatchAsync() Move all Recycle Bin items to second stage using the current context batch instance. Declaration Task MoveAllToSecondStageBatchAsync() Returns Task MoveAllToSecondStageBatchAsync(Batch) Move all Recycle Bin items to second stage using a specific batch instance. Declaration Task MoveAllToSecondStageBatchAsync(Batch batch) Parameters Batch batch Returns Task RestoreAll() Restores all Recycle Bin items to their original locations. Declaration void RestoreAll() RestoreAllAsync() Restores all Recycle Bin items to their original locations. Declaration Task RestoreAllAsync() Returns Task RestoreAllBatch() Restores all Recycle Bin items to their original locations using the current context batch instance. Declaration void RestoreAllBatch() RestoreAllBatch(Batch) Restores all Recycle Bin items to their original locations using a specific batch instance. Declaration void RestoreAllBatch(Batch batch) Parameters Batch batch RestoreAllBatchAsync() Restores all Recycle Bin items to their original locations using the current context batch instance. Declaration Task RestoreAllBatchAsync() Returns Task RestoreAllBatchAsync(Batch) Restores all Recycle Bin items to their original locations using a specific batch instance. Declaration Task RestoreAllBatchAsync(Batch batch) Parameters Batch batch Returns Task Extension Methods DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.Load(IDataModelCollectionLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" }, "api/PnP.Core.Model.SharePoint.IRegionalSettings.html": { "href": "api/PnP.Core.Model.SharePoint.IRegionalSettings.html", "title": "Interface IRegionalSettings | PnP Core SDK", - "keywords": "Interface IRegionalSettings Public interface to define a RegionalSettings object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IRegionalSettings : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IQueryableDataModel Properties All Gets all properties of this entity Declaration object All { get; } Property Value Object AM Gets the string that is used to represent A.M.. Declaration string AM { get; } Property Value String CollationLCID Gets the locale identifier (LCID) for the collation rules that are used on the site. Declaration int CollationLCID { get; } Property Value Int32 DateFormat Gets the date format that is used. Declaration int DateFormat { get; } Property Value Int32 DateSeparator Gets the separator that is used for dates. Declaration string DateSeparator { get; } Property Value String DecimalSeparator Gets the separator that is used for decimals. Declaration string DecimalSeparator { get; } Property Value String DigitGrouping Gets the separator that is used in grouping digits. Declaration string DigitGrouping { get; } Property Value String FirstDayOfWeek Gets the first day of the week used in calendars. Declaration int FirstDayOfWeek { get; } Property Value Int32 IsEastAsia Gets a Boolean value that indicates whether the Web site locale is an East Asian locale. Declaration bool IsEastAsia { get; } Property Value Boolean IsRightToLeft Gets the separator that is used for decimals. Declaration bool IsRightToLeft { get; } Property Value Boolean IsUIRightToLeft Gets a Boolean value that indicates whether the Web site user interface (UI) uses a right-to-left language. Declaration bool IsUIRightToLeft { get; } Property Value Boolean ListSeparator Gets the separator used in lists. Declaration string ListSeparator { get; } Property Value String LocaleId Gets or sets the locale ID in use. Declaration int LocaleId { get; } Property Value Int32 NegativeSign Gets the symbol that is used to represent a negative sign. Declaration string NegativeSign { get; } Property Value String NegNumberMode Gets the negative number mode that is used for displaying negative numbers in calculated fields based on the locale of the server. Declaration int NegNumberMode { get; } Property Value Int32 PM Gets the string that is used to represent P.M.. Declaration string PM { get; } Property Value String PositiveSign Gets the symbol that is used to represent a positive sign. Declaration string PositiveSign { get; } Property Value String ShowWeeks Gets Boolean value that specifies whether to display the week number in day or week views of a calendar. Declaration bool ShowWeeks { get; } Property Value Boolean ThousandSeparator Gets the thousand separator used for numbers. Declaration string ThousandSeparator { get; } Property Value String Time24 Gets or sets a Boolean value that specifies whether to use a 24-hour time format in representing the hours of the day. Declaration bool Time24 { get; } Property Value Boolean TimeMarkerPosition Gets a value that indicates whether A.M. and P.M. appear before or after the time string. Declaration int TimeMarkerPosition { get; } Property Value Int32 TimeSeparator Gets the time separator that is used. Declaration string TimeSeparator { get; } Property Value String TimeZone Gets the time zone that is used. Declaration ITimeZone TimeZone { get; } Property Value ITimeZone TimeZones Gets the collection of time zones used in SharePoint Online. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ITimeZoneCollection TimeZones { get; } Property Value ITimeZoneCollection Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IRegionalSettings Public interface to define a RegionalSettings object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IRegionalSettings : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IQueryableDataModel Properties All Gets all properties of this entity Declaration object All { get; } Property Value System.Object AM Gets the string that is used to represent A.M.. Declaration string AM { get; } Property Value String CollationLCID Gets the locale identifier (LCID) for the collation rules that are used on the site. Declaration int CollationLCID { get; } Property Value Int32 DateFormat Gets the date format that is used. Declaration int DateFormat { get; } Property Value Int32 DateSeparator Gets the separator that is used for dates. Declaration string DateSeparator { get; } Property Value String DecimalSeparator Gets the separator that is used for decimals. Declaration string DecimalSeparator { get; } Property Value String DigitGrouping Gets the separator that is used in grouping digits. Declaration string DigitGrouping { get; } Property Value String FirstDayOfWeek Gets the first day of the week used in calendars. Declaration int FirstDayOfWeek { get; } Property Value Int32 IsEastAsia Gets a Boolean value that indicates whether the Web site locale is an East Asian locale. Declaration bool IsEastAsia { get; } Property Value Boolean IsRightToLeft Gets the separator that is used for decimals. Declaration bool IsRightToLeft { get; } Property Value Boolean IsUIRightToLeft Gets a Boolean value that indicates whether the Web site user interface (UI) uses a right-to-left language. Declaration bool IsUIRightToLeft { get; } Property Value Boolean ListSeparator Gets the separator used in lists. Declaration string ListSeparator { get; } Property Value String LocaleId Gets or sets the locale ID in use. Declaration int LocaleId { get; } Property Value Int32 NegativeSign Gets the symbol that is used to represent a negative sign. Declaration string NegativeSign { get; } Property Value String NegNumberMode Gets the negative number mode that is used for displaying negative numbers in calculated fields based on the locale of the server. Declaration int NegNumberMode { get; } Property Value Int32 PM Gets the string that is used to represent P.M.. Declaration string PM { get; } Property Value String PositiveSign Gets the symbol that is used to represent a positive sign. Declaration string PositiveSign { get; } Property Value String ShowWeeks Gets Boolean value that specifies whether to display the week number in day or week views of a calendar. Declaration bool ShowWeeks { get; } Property Value Boolean ThousandSeparator Gets the thousand separator used for numbers. Declaration string ThousandSeparator { get; } Property Value String Time24 Gets or sets a Boolean value that specifies whether to use a 24-hour time format in representing the hours of the day. Declaration bool Time24 { get; } Property Value Boolean TimeMarkerPosition Gets a value that indicates whether A.M. and P.M. appear before or after the time string. Declaration int TimeMarkerPosition { get; } Property Value Int32 TimeSeparator Gets the time separator that is used. Declaration string TimeSeparator { get; } Property Value String TimeZone Gets the time zone that is used. Declaration ITimeZone TimeZone { get; } Property Value ITimeZone TimeZones Gets the collection of time zones used in SharePoint Online. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ITimeZoneCollection TimeZones { get; } Property Value ITimeZoneCollection Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.ISearchRefinementResult.html": { "href": "api/PnP.Core.Model.SharePoint.ISearchRefinementResult.html", @@ -2122,7 +2122,7 @@ "api/PnP.Core.Model.SharePoint.ISearchResult.html": { "href": "api/PnP.Core.Model.SharePoint.ISearchResult.html", "title": "Interface ISearchResult | PnP Core SDK", - "keywords": "Interface ISearchResult Result of search query Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface ISearchResult Properties ElapsedTime Time in milliseconds the search query took server side Declaration int ElapsedTime { get; } Property Value Int32 Refinements Collection of refinement results Declaration Dictionary> Refinements { get; } Property Value Dictionary < String , PnP.Core.Model.SharePoint.List < ISearchRefinementResult >> Rows Collection of search results Declaration List> Rows { get; } Property Value PnP.Core.Model.SharePoint.List < Dictionary < String , Object >> TotalRows Total rows that match the provided query Declaration long TotalRows { get; } Property Value Int64 TotalRowsIncludingDuplicates Total rows, including duplicates, that match the provided query Declaration long TotalRowsIncludingDuplicates { get; } Property Value Int64" + "keywords": "Interface ISearchResult Result of search query Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface ISearchResult Properties ElapsedTime Time in milliseconds the search query took server side Declaration int ElapsedTime { get; } Property Value Int32 Refinements Collection of refinement results Declaration Dictionary> Refinements { get; } Property Value Dictionary < String , PnP.Core.Model.SharePoint.List < ISearchRefinementResult >> Rows Collection of search results Declaration List> Rows { get; } Property Value PnP.Core.Model.SharePoint.List < Dictionary < String , System.Object >> TotalRows Total rows that match the provided query Declaration long TotalRows { get; } Property Value Int64 TotalRowsIncludingDuplicates Total rows, including duplicates, that match the provided query Declaration long TotalRowsIncludingDuplicates { get; } Property Value Int64" }, "api/PnP.Core.Model.SharePoint.ISecurableObject.html": { "href": "api/PnP.Core.Model.SharePoint.ISecurableObject.html", @@ -2132,7 +2132,7 @@ "api/PnP.Core.Model.SharePoint.ISite.html": { "href": "api/PnP.Core.Model.SharePoint.ISite.html", "title": "Interface ISite | PnP Core SDK", - "keywords": "Interface ISite Public interface to define a Site object of SharePoint Online Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelSupportingGetChanges.GetChangesAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChanges(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(ChangeQueryOptions) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface ISite : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelSupportingGetChanges Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object AllowCreateDeclarativeWorkflow Gets or sets a value that specifies whether the creation of declarative workflows is allowed on this site collection. Declaration bool AllowCreateDeclarativeWorkflow { get; set; } Property Value Boolean AllowDesigner Gets or sets a value that specifies whether a designer can be used on this site collection. Declaration bool AllowDesigner { get; set; } Property Value Boolean AllowExternalEmbeddingWrapper Gets or sets a value that specifies whether external embedding wrapper is allowed on this site collection. 0 means \"Don't allow embedding any external domains\" 1 means \"Only allow embedding external domains from allow-embed-domains-list\" 2 means \"Allow embedding any external domains\" Declaration int AllowExternalEmbeddingWrapper { get; set; } Property Value Int32 AllowMasterPageEditing Gets or sets a value that specifies whether master page editing is allowed on this site collection. Declaration bool AllowMasterPageEditing { get; set; } Property Value Boolean AllowRevertFromTemplate Gets or sets a value that specifies whether this site collection can be reverted to its base template. Declaration bool AllowRevertFromTemplate { get; set; } Property Value Boolean AllowSaveDeclarativeWorkflowAsTemplate Gets or sets a value that specifies whether it is allowed to save declarative workflows as template on this site collection. Declaration bool AllowSaveDeclarativeWorkflowAsTemplate { get; set; } Property Value Boolean AllowSavePublishDeclarativeWorkflow Gets or sets a value that specifies whether it is allowed to save and publish declarative workflows on this site collection. Declaration bool AllowSavePublishDeclarativeWorkflow { get; set; } Property Value Boolean AllWebs Collection of sub-webs in the current Site object Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IWebCollection AllWebs { get; } Property Value IWebCollection AuditLogTrimmingRetention This is the number of days of audit log data to retain. If unset and audit trimming is enabled, the retention defaults default configured schedule for trimming Declaration int AuditLogTrimmingRetention { get; set; } Property Value Int32 CanSyncHubSitePermissions Gets or sets value if syncing hub site permissions to this associated site is allowed. Declaration bool CanSyncHubSitePermissions { get; set; } Property Value Boolean ChannelGroupId Gets the ID of the Modern Group associated with this site. Declaration Guid ChannelGroupId { get; } Property Value Guid Classification The Classification of the Site object Declaration string Classification { get; set; } Property Value String CommentsOnSitePagesDisabled Gets or sets a value that specifies whether the comments on site pages are disabled on this site collection. Declaration bool CommentsOnSitePagesDisabled { get; set; } Property Value Boolean DisableAppViews Sets whether or not to disable app views for all child webs. True means app views are disabled throughout the site collection; False otherwise. Declaration bool DisableAppViews { get; set; } Property Value Boolean DisableCompanyWideSharingLinks Sets whether or not to disable company sharing links for all child webs. True means companywide sharing links are disabled throughout the site collection, regardless of the settings on the root or child webs. False means each web can individually decide whether to turn on or off companywide sharing links. Declaration bool DisableCompanyWideSharingLinks { get; set; } Property Value Boolean DisableFlows Sets whether or not to disable Flows for all child webs. True means Flows are disabled throughout the site collection; False otherwise. Declaration bool DisableFlows { get; set; } Property Value Boolean EventReceivers Event Receivers defined in this web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IEventReceiverDefinitionCollection EventReceivers { get; } Property Value IEventReceiverDefinitionCollection ExternalSharingTipsEnabled Gets a boolean value that specifies whether users will be greeted with a notification bar telling them that the site can be shared with external users. True - notification bar is enabled; False - otherwise Declaration bool ExternalSharingTipsEnabled { get; } Property Value Boolean ExternalUserExpirationInDays Property that indicates the default number of days an external user will expire in. 0 if the policy is disabled or unavailable, otherwise the number of days Declaration int ExternalUserExpirationInDays { get; } Property Value Int32 Features Collection of features enabled for the site Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFeatureCollection Features { get; } Property Value IFeatureCollection GeoLocation returns the Geo Location hosting this site collection Declaration string GeoLocation { get; } Property Value String GroupId The unique ID of the associated Microsoft 365 Group (if any) Declaration Guid GroupId { get; } Property Value Guid HubSiteId Gets the ID of the HubSite this site is associated with. Declaration Guid HubSiteId { get; } Property Value Guid Remarks Use JoinHubSite method to change the value of this property. HubSiteSynchronizableVisitorGroup Gets the synchronizable visitor group for a hub site Declaration ISharePointGroup HubSiteSynchronizableVisitorGroup { get; } Property Value ISharePointGroup Id The Unique ID of the Site object Declaration Guid Id { get; } Property Value Guid IsHubSite Returns whether or not this site is a HubSite. Hub sites can be associated with one or more sites. Declaration bool IsHubSite { get; } Property Value Boolean LockIssue Gets the comment that is used in locking a site collection. Declaration string LockIssue { get; } Property Value String MaxItemsPerThrottledOperation Maximum items that will not be throttled per operation. Declaration int MaxItemsPerThrottledOperation { get; } Property Value Int32 ReadOnly Gets or sets a bool value that specifies whether the site collection is read-only, locked, and unavailable for write access. Declaration bool ReadOnly { get; set; } Property Value Boolean RecycleBin Gets a value that specifies the collection of Recycle Bin items for the site collection. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IRecycleBinItemCollection RecycleBin { get; } Property Value IRecycleBinItemCollection RelatedGroupId Gets the ID of the Modern Group related to this site. Declaration Guid RelatedGroupId { get; } Property Value Guid RootWeb The RootWeb of the Site object Declaration IWeb RootWeb { get; } Property Value IWeb SearchBoxInNavBar Whether suite nav search box is shown on modern and classic pages Declaration SearchBoxInNavBar SearchBoxInNavBar { get; set; } Property Value SearchBoxInNavBar SearchBoxPlaceholderText Search placeholder text for search box in navbar - overrides default placeholder text if set. Declaration string SearchBoxPlaceholderText { get; set; } Property Value String SensitivityLabel Information Protection Label Id for an individual site collection Declaration string SensitivityLabel { get; } Property Value String SensitivityLabelId Gets the Information Protection Label Id for an individual site collection. Declaration Guid SensitivityLabelId { get; } Property Value Guid ServerRelativeUrl Gets the server-relative URL of the root Web site in the site collection. Declaration string ServerRelativeUrl { get; } Property Value String ShareByEmailEnabled ShareByEmailEnabled when true means that user's will be able to grant permissions to guests for resources within the site collection Declaration bool ShareByEmailEnabled { get; set; } Property Value Boolean ShareByLinkEnabled Property that indicates whether users will be able to share links to documents that can be accessed without logging in. Declaration bool ShareByLinkEnabled { get; } Property Value Boolean ShowPeoplePickerSuggestionsForGuestUsers Gets or sets a value that specifies whether guest users should be displayed as suggestions in people picker on this site collection. Declaration bool ShowPeoplePickerSuggestionsForGuestUsers { get; set; } Property Value Boolean SocialBarOnSitePagesDisabled Defines whether social bar is disabled on Site Pages in this site collection Declaration bool SocialBarOnSitePagesDisabled { get; set; } Property Value Boolean StatusBarLink Gets or sets a value that specifies the status bar link on this site collection (sets the SiteStatusBarLink property on the root web). Declaration string StatusBarLink { get; set; } Property Value String StatusBarText Gets or sets a value that specifies the text of the status bar on this site collection (sets the SiteStatusBarText property on the root web). Declaration string StatusBarText { get; set; } Property Value String ThicketSupportDisabled Gets a value that indicates whether thicket support is disabled on this site collection. Declaration bool ThicketSupportDisabled { get; } Property Value Boolean TrimAuditLog When this flag is set for the site, the audit events are trimmed periodically. Declaration bool TrimAuditLog { get; set; } Property Value Boolean Url The URL of the Site object Declaration Uri Url { get; } Property Value Uri UserCustomActions Gets a value that specifies the collection of user custom actions for the site collection. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IUserCustomActionCollection UserCustomActions { get; } Property Value IUserCustomActionCollection Methods CreateCopyJobs(String[], String, CopyMigrationOptions, Boolean, Int32) Creates a new migration job Array of the objects to migrate (absolute url to the file / folder) Destination URI to where the objects have to be migrated Migration options Defines if we have to wait until all the migrations have finished Duration between every GetCopyJobProgress call in seconds. Defaults to 1. List of all the jobs being created (one for every exportObjectUri) Declaration IList CreateCopyJobs(string[] exportObjectUris, string destinationUri, CopyMigrationOptions options, bool waitUntilFinished = false, int waitAfterStatusCheck = 1) Parameters String [] exportObjectUris String destinationUri CopyMigrationOptions options Boolean waitUntilFinished Int32 waitAfterStatusCheck Returns PnP.Core.Model.SharePoint.IList < ICopyMigrationInfo > CreateCopyJobsAsync(String[], String, CopyMigrationOptions, Boolean, Int32) Creates a new migration job Array of the objects to migrate (absolute url to the file / folder) Destination URI to where the objects have to be migrated Migration options Defines if we have to wait until all the migrations have finished Duration between every GetCopyJobProgress call in seconds. Defaults to 1. List of all the jobs being created (one for every exportObjectUri) Declaration Task> CreateCopyJobsAsync(string[] exportObjectUris, string destinationUri, CopyMigrationOptions options, bool waitUntilFinished = false, int waitAfterStatusCheck = 1) Parameters String [] exportObjectUris String destinationUri CopyMigrationOptions options Boolean waitUntilFinished Int32 waitAfterStatusCheck Returns Task < PnP.Core.Model.SharePoint.IList < ICopyMigrationInfo >> EnsureCopyJobHasFinished(IList, Int32) Ensures that a migration job has completely run List of migration jobs to check the process of Duration between every GetCopyJobProgress call in seconds. Defaults to 1. Declaration void EnsureCopyJobHasFinished(IList copyMigrationInfos, int waitAfterStatusCheck = 1) Parameters PnP.Core.Model.SharePoint.IList < ICopyMigrationInfo > copyMigrationInfos Int32 waitAfterStatusCheck EnsureCopyJobHasFinishedAsync(IList, Int32) Ensures that a migration job has completely run List of migration jobs to check the process of Duration between every GetCopyJobProgress call in seconds. Defaults to 1. Declaration Task EnsureCopyJobHasFinishedAsync(IList copyMigrationInfos, int waitAfterStatusCheck = 1) Parameters PnP.Core.Model.SharePoint.IList < ICopyMigrationInfo > copyMigrationInfos Int32 waitAfterStatusCheck Returns Task GetAnalytics(AnalyticsOptions) Gets site analytics Declaration List GetAnalytics(AnalyticsOptions options = null) Parameters AnalyticsOptions options Defines which analytics are needed Returns PnP.Core.Model.SharePoint.List < IActivityStat > The requested analytics data GetAnalyticsAsync(AnalyticsOptions) Gets site analytics Declaration Task> GetAnalyticsAsync(AnalyticsOptions options = null) Parameters AnalyticsOptions options Defines which analytics are needed Returns Task < PnP.Core.Model.SharePoint.List < IActivityStat >> The requested analytics data GetAvailableComplianceTags() Retrieves the available compliance tags / retention labels for this site Declaration IEnumerable GetAvailableComplianceTags() Returns IEnumerable < IComplianceTag > GetAvailableComplianceTagsAsync() Retrieves the available compliance tags / retention labels for this site Declaration Task> GetAvailableComplianceTagsAsync() Returns Task < IEnumerable < IComplianceTag >> GetCopyJobProgress(ICopyMigrationInfo) Gets the progress of an existing migration info object Migration job to get the progress of Progress of the copy job Declaration ICopyJobProgress GetCopyJobProgress(ICopyMigrationInfo copyMigrationInfo) Parameters ICopyMigrationInfo copyMigrationInfo Returns ICopyJobProgress GetCopyJobProgressAsync(ICopyMigrationInfo) Gets the progress of an existing migration info object Migration job to get the progress of Progress of the copy job Declaration Task GetCopyJobProgressAsync(ICopyMigrationInfo copyMigrationInfo) Parameters ICopyMigrationInfo copyMigrationInfo Returns Task < ICopyJobProgress > GetHubSiteData(Nullable) Gets hubsite data from the current site OR another specified hub site ID Declaration IHubSite GetHubSiteData(Guid? id) Parameters Nullable < Guid > id Hub Site Guid Returns IHubSite GetHubSiteDataAsync(Nullable) Gets hubsite data from the current site OR another specified hub site ID Declaration Task GetHubSiteDataAsync(Guid? id) Parameters Nullable < Guid > id Hub Site Guid Returns Task < IHubSite > GetSearchConfigurationManagedProperties() Gets the managed properties from the search configuration of this site Declaration List GetSearchConfigurationManagedProperties() Returns PnP.Core.Model.SharePoint.List < IManagedProperty > List of managed properties GetSearchConfigurationManagedPropertiesAsync() Gets the managed properties from the search configuration of this site Declaration Task> GetSearchConfigurationManagedPropertiesAsync() Returns Task < PnP.Core.Model.SharePoint.List < IManagedProperty >> List of managed properties GetSearchConfigurationXml() Gets the search configuration of the web Declaration string GetSearchConfigurationXml() Returns String Search configuration XML GetSearchConfigurationXmlAsync() Gets the search configuration of the web Declaration Task GetSearchConfigurationXmlAsync() Returns Task < String > Search configuration XML IsHomeSite() Checks if current site is a HomeSite Declaration bool IsHomeSite() Returns Boolean IsHomeSiteAsync() Checks if current site is a HomeSite Declaration Task IsHomeSiteAsync() Returns Task < Boolean > JoinHubSite(Guid) Associates the current site to a primary hub site Declaration bool JoinHubSite(Guid hubSiteId) Parameters Guid hubSiteId Returns Boolean JoinHubSiteAsync(Guid) Associates the current site to a primary hub site Declaration Task JoinHubSiteAsync(Guid hubSiteId) Parameters Guid hubSiteId Returns Task < Boolean > RegisterHubSite() Registers the current site as a primary hub site Declaration IHubSite RegisterHubSite() Returns IHubSite RegisterHubSiteAsync() Registers the current site as a primary hub site Declaration Task RegisterHubSiteAsync() Returns Task < IHubSite > SetSearchConfigurationXml(String) Sets the search configuration for the site Declaration void SetSearchConfigurationXml(string configuration) Parameters String configuration Search configuration, obtained via GetSearchConfigurationXml() to apply SetSearchConfigurationXmlAsync(String) Sets the search configuration for the site Declaration Task SetSearchConfigurationXmlAsync(string configuration) Parameters String configuration Search configuration, obtained via GetSearchConfigurationXml() to apply Returns Task UnJoinHubSite() Disassociates current site from primary hub site Declaration bool UnJoinHubSite() Returns Boolean UnJoinHubSiteAsync() Disassociates current site from primary hub site Declaration Task UnJoinHubSiteAsync() Returns Task < Boolean > UnregisterHubSite() Unregisters the current site as a primary hub site Declaration bool UnregisterHubSite() Returns Boolean UnregisterHubSiteAsync() Unregisters the current site as a primary hub site Declaration Task UnregisterHubSiteAsync() Returns Task < Boolean > Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface ISite Public interface to define a Site object of SharePoint Online Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelSupportingGetChanges.GetChangesAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChanges(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(ChangeQueryOptions) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface ISite : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelSupportingGetChanges Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object AllowCreateDeclarativeWorkflow Gets or sets a value that specifies whether the creation of declarative workflows is allowed on this site collection. Declaration bool AllowCreateDeclarativeWorkflow { get; set; } Property Value Boolean AllowDesigner Gets or sets a value that specifies whether a designer can be used on this site collection. Declaration bool AllowDesigner { get; set; } Property Value Boolean AllowExternalEmbeddingWrapper Gets or sets a value that specifies whether external embedding wrapper is allowed on this site collection. 0 means \"Don't allow embedding any external domains\" 1 means \"Only allow embedding external domains from allow-embed-domains-list\" 2 means \"Allow embedding any external domains\" Declaration int AllowExternalEmbeddingWrapper { get; set; } Property Value Int32 AllowMasterPageEditing Gets or sets a value that specifies whether master page editing is allowed on this site collection. Declaration bool AllowMasterPageEditing { get; set; } Property Value Boolean AllowRevertFromTemplate Gets or sets a value that specifies whether this site collection can be reverted to its base template. Declaration bool AllowRevertFromTemplate { get; set; } Property Value Boolean AllowSaveDeclarativeWorkflowAsTemplate Gets or sets a value that specifies whether it is allowed to save declarative workflows as template on this site collection. Declaration bool AllowSaveDeclarativeWorkflowAsTemplate { get; set; } Property Value Boolean AllowSavePublishDeclarativeWorkflow Gets or sets a value that specifies whether it is allowed to save and publish declarative workflows on this site collection. Declaration bool AllowSavePublishDeclarativeWorkflow { get; set; } Property Value Boolean AllWebs Collection of sub-webs in the current Site object Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IWebCollection AllWebs { get; } Property Value IWebCollection AuditLogTrimmingRetention This is the number of days of audit log data to retain. If unset and audit trimming is enabled, the retention defaults default configured schedule for trimming Declaration int AuditLogTrimmingRetention { get; set; } Property Value Int32 CanSyncHubSitePermissions Gets or sets value if syncing hub site permissions to this associated site is allowed. Declaration bool CanSyncHubSitePermissions { get; set; } Property Value Boolean ChannelGroupId Gets the ID of the Modern Group associated with this site. Declaration Guid ChannelGroupId { get; } Property Value Guid Classification The Classification of the Site object Declaration string Classification { get; set; } Property Value String CommentsOnSitePagesDisabled Gets or sets a value that specifies whether the comments on site pages are disabled on this site collection. Declaration bool CommentsOnSitePagesDisabled { get; set; } Property Value Boolean DisableAppViews Sets whether or not to disable app views for all child webs. True means app views are disabled throughout the site collection; False otherwise. Declaration bool DisableAppViews { get; set; } Property Value Boolean DisableCompanyWideSharingLinks Sets whether or not to disable company sharing links for all child webs. True means companywide sharing links are disabled throughout the site collection, regardless of the settings on the root or child webs. False means each web can individually decide whether to turn on or off companywide sharing links. Declaration bool DisableCompanyWideSharingLinks { get; set; } Property Value Boolean DisableFlows Sets whether or not to disable Flows for all child webs. True means Flows are disabled throughout the site collection; False otherwise. Declaration bool DisableFlows { get; set; } Property Value Boolean EventReceivers Event Receivers defined in this web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IEventReceiverDefinitionCollection EventReceivers { get; } Property Value IEventReceiverDefinitionCollection ExternalSharingTipsEnabled Gets a boolean value that specifies whether users will be greeted with a notification bar telling them that the site can be shared with external users. True - notification bar is enabled; False - otherwise Declaration bool ExternalSharingTipsEnabled { get; } Property Value Boolean ExternalUserExpirationInDays Property that indicates the default number of days an external user will expire in. 0 if the policy is disabled or unavailable, otherwise the number of days Declaration int ExternalUserExpirationInDays { get; } Property Value Int32 Features Collection of features enabled for the site Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFeatureCollection Features { get; } Property Value IFeatureCollection GeoLocation returns the Geo Location hosting this site collection Declaration string GeoLocation { get; } Property Value String GroupId The unique ID of the associated Microsoft 365 Group (if any) Declaration Guid GroupId { get; } Property Value Guid HubSiteId Gets the ID of the HubSite this site is associated with. Declaration Guid HubSiteId { get; } Property Value Guid Remarks Use JoinHubSite method to change the value of this property. HubSiteSynchronizableVisitorGroup Gets the synchronizable visitor group for a hub site Declaration ISharePointGroup HubSiteSynchronizableVisitorGroup { get; } Property Value ISharePointGroup Id The Unique ID of the Site object Declaration Guid Id { get; } Property Value Guid IsHubSite Returns whether or not this site is a HubSite. Hub sites can be associated with one or more sites. Declaration bool IsHubSite { get; } Property Value Boolean LockIssue Gets the comment that is used in locking a site collection. Declaration string LockIssue { get; } Property Value String MaxItemsPerThrottledOperation Maximum items that will not be throttled per operation. Declaration int MaxItemsPerThrottledOperation { get; } Property Value Int32 ReadOnly Gets or sets a bool value that specifies whether the site collection is read-only, locked, and unavailable for write access. Declaration bool ReadOnly { get; set; } Property Value Boolean RecycleBin Gets a value that specifies the collection of Recycle Bin items for the site collection. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IRecycleBinItemCollection RecycleBin { get; } Property Value IRecycleBinItemCollection RelatedGroupId Gets the ID of the Modern Group related to this site. Declaration Guid RelatedGroupId { get; } Property Value Guid RootWeb The RootWeb of the Site object Declaration IWeb RootWeb { get; } Property Value IWeb SearchBoxInNavBar Whether suite nav search box is shown on modern and classic pages Declaration SearchBoxInNavBar SearchBoxInNavBar { get; set; } Property Value SearchBoxInNavBar SearchBoxPlaceholderText Search placeholder text for search box in navbar - overrides default placeholder text if set. Declaration string SearchBoxPlaceholderText { get; set; } Property Value String SensitivityLabel Information Protection Label Id for an individual site collection Declaration string SensitivityLabel { get; } Property Value String SensitivityLabelId Gets the Information Protection Label Id for an individual site collection. Declaration Guid SensitivityLabelId { get; } Property Value Guid ServerRelativeUrl Gets the server-relative URL of the root Web site in the site collection. Declaration string ServerRelativeUrl { get; } Property Value String ShareByEmailEnabled ShareByEmailEnabled when true means that user's will be able to grant permissions to guests for resources within the site collection Declaration bool ShareByEmailEnabled { get; set; } Property Value Boolean ShareByLinkEnabled Property that indicates whether users will be able to share links to documents that can be accessed without logging in. Declaration bool ShareByLinkEnabled { get; } Property Value Boolean ShowPeoplePickerSuggestionsForGuestUsers Gets or sets a value that specifies whether guest users should be displayed as suggestions in people picker on this site collection. Declaration bool ShowPeoplePickerSuggestionsForGuestUsers { get; set; } Property Value Boolean SocialBarOnSitePagesDisabled Defines whether social bar is disabled on Site Pages in this site collection Declaration bool SocialBarOnSitePagesDisabled { get; set; } Property Value Boolean StatusBarLink Gets or sets a value that specifies the status bar link on this site collection (sets the SiteStatusBarLink property on the root web). Declaration string StatusBarLink { get; set; } Property Value String StatusBarText Gets or sets a value that specifies the text of the status bar on this site collection (sets the SiteStatusBarText property on the root web). Declaration string StatusBarText { get; set; } Property Value String ThicketSupportDisabled Gets a value that indicates whether thicket support is disabled on this site collection. Declaration bool ThicketSupportDisabled { get; } Property Value Boolean TrimAuditLog When this flag is set for the site, the audit events are trimmed periodically. Declaration bool TrimAuditLog { get; set; } Property Value Boolean Url The URL of the Site object Declaration Uri Url { get; } Property Value Uri UserCustomActions Gets a value that specifies the collection of user custom actions for the site collection. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IUserCustomActionCollection UserCustomActions { get; } Property Value IUserCustomActionCollection Methods CreateCopyJobs(String[], String, CopyMigrationOptions, Boolean, Int32) Creates a new migration job Array of the objects to migrate (absolute url to the file / folder) Destination URI to where the objects have to be migrated Migration options Defines if we have to wait until all the migrations have finished Duration between every GetCopyJobProgress call in seconds. Defaults to 1. List of all the jobs being created (one for every exportObjectUri) Declaration IList CreateCopyJobs(string[] exportObjectUris, string destinationUri, CopyMigrationOptions options, bool waitUntilFinished = false, int waitAfterStatusCheck = 1) Parameters String [] exportObjectUris String destinationUri CopyMigrationOptions options Boolean waitUntilFinished Int32 waitAfterStatusCheck Returns PnP.Core.Model.SharePoint.IList < ICopyMigrationInfo > CreateCopyJobsAsync(String[], String, CopyMigrationOptions, Boolean, Int32) Creates a new migration job Array of the objects to migrate (absolute url to the file / folder) Destination URI to where the objects have to be migrated Migration options Defines if we have to wait until all the migrations have finished Duration between every GetCopyJobProgress call in seconds. Defaults to 1. List of all the jobs being created (one for every exportObjectUri) Declaration Task> CreateCopyJobsAsync(string[] exportObjectUris, string destinationUri, CopyMigrationOptions options, bool waitUntilFinished = false, int waitAfterStatusCheck = 1) Parameters String [] exportObjectUris String destinationUri CopyMigrationOptions options Boolean waitUntilFinished Int32 waitAfterStatusCheck Returns Task < PnP.Core.Model.SharePoint.IList < ICopyMigrationInfo >> EnsureCopyJobHasFinished(IList, Int32) Ensures that a migration job has completely run List of migration jobs to check the process of Duration between every GetCopyJobProgress call in seconds. Defaults to 1. Declaration void EnsureCopyJobHasFinished(IList copyMigrationInfos, int waitAfterStatusCheck = 1) Parameters PnP.Core.Model.SharePoint.IList < ICopyMigrationInfo > copyMigrationInfos Int32 waitAfterStatusCheck EnsureCopyJobHasFinishedAsync(IList, Int32) Ensures that a migration job has completely run List of migration jobs to check the process of Duration between every GetCopyJobProgress call in seconds. Defaults to 1. Declaration Task EnsureCopyJobHasFinishedAsync(IList copyMigrationInfos, int waitAfterStatusCheck = 1) Parameters PnP.Core.Model.SharePoint.IList < ICopyMigrationInfo > copyMigrationInfos Int32 waitAfterStatusCheck Returns Task GetAnalytics(AnalyticsOptions) Gets site analytics Declaration List GetAnalytics(AnalyticsOptions options = null) Parameters AnalyticsOptions options Defines which analytics are needed Returns PnP.Core.Model.SharePoint.List < IActivityStat > The requested analytics data GetAnalyticsAsync(AnalyticsOptions) Gets site analytics Declaration Task> GetAnalyticsAsync(AnalyticsOptions options = null) Parameters AnalyticsOptions options Defines which analytics are needed Returns Task < PnP.Core.Model.SharePoint.List < IActivityStat >> The requested analytics data GetAvailableComplianceTags() Retrieves the available compliance tags / retention labels for this site Declaration IEnumerable GetAvailableComplianceTags() Returns IEnumerable < IComplianceTag > GetAvailableComplianceTagsAsync() Retrieves the available compliance tags / retention labels for this site Declaration Task> GetAvailableComplianceTagsAsync() Returns Task < IEnumerable < IComplianceTag >> GetCopyJobProgress(ICopyMigrationInfo) Gets the progress of an existing migration info object Migration job to get the progress of Progress of the copy job Declaration ICopyJobProgress GetCopyJobProgress(ICopyMigrationInfo copyMigrationInfo) Parameters ICopyMigrationInfo copyMigrationInfo Returns ICopyJobProgress GetCopyJobProgressAsync(ICopyMigrationInfo) Gets the progress of an existing migration info object Migration job to get the progress of Progress of the copy job Declaration Task GetCopyJobProgressAsync(ICopyMigrationInfo copyMigrationInfo) Parameters ICopyMigrationInfo copyMigrationInfo Returns Task < ICopyJobProgress > GetHubSiteData(Nullable) Gets hubsite data from the current site OR another specified hub site ID Declaration IHubSite GetHubSiteData(Guid? id) Parameters Nullable < Guid > id Hub Site Guid Returns IHubSite GetHubSiteDataAsync(Nullable) Gets hubsite data from the current site OR another specified hub site ID Declaration Task GetHubSiteDataAsync(Guid? id) Parameters Nullable < Guid > id Hub Site Guid Returns Task < IHubSite > GetSearchConfigurationManagedProperties() Gets the managed properties from the search configuration of this site Declaration List GetSearchConfigurationManagedProperties() Returns PnP.Core.Model.SharePoint.List < IManagedProperty > List of managed properties GetSearchConfigurationManagedPropertiesAsync() Gets the managed properties from the search configuration of this site Declaration Task> GetSearchConfigurationManagedPropertiesAsync() Returns Task < PnP.Core.Model.SharePoint.List < IManagedProperty >> List of managed properties GetSearchConfigurationXml() Gets the search configuration of the web Declaration string GetSearchConfigurationXml() Returns String Search configuration XML GetSearchConfigurationXmlAsync() Gets the search configuration of the web Declaration Task GetSearchConfigurationXmlAsync() Returns Task < String > Search configuration XML IsHomeSite() Checks if current site is a HomeSite Declaration bool IsHomeSite() Returns Boolean IsHomeSiteAsync() Checks if current site is a HomeSite Declaration Task IsHomeSiteAsync() Returns Task < Boolean > JoinHubSite(Guid) Associates the current site to a primary hub site Declaration bool JoinHubSite(Guid hubSiteId) Parameters Guid hubSiteId Returns Boolean JoinHubSiteAsync(Guid) Associates the current site to a primary hub site Declaration Task JoinHubSiteAsync(Guid hubSiteId) Parameters Guid hubSiteId Returns Task < Boolean > RegisterHubSite() Registers the current site as a primary hub site Declaration IHubSite RegisterHubSite() Returns IHubSite RegisterHubSiteAsync() Registers the current site as a primary hub site Declaration Task RegisterHubSiteAsync() Returns Task < IHubSite > SetSearchConfigurationXml(String) Sets the search configuration for the site Declaration void SetSearchConfigurationXml(string configuration) Parameters String configuration Search configuration, obtained via GetSearchConfigurationXml() to apply SetSearchConfigurationXmlAsync(String) Sets the search configuration for the site Declaration Task SetSearchConfigurationXmlAsync(string configuration) Parameters String configuration Search configuration, obtained via GetSearchConfigurationXml() to apply Returns Task UnJoinHubSite() Disassociates current site from primary hub site Declaration bool UnJoinHubSite() Returns Boolean UnJoinHubSiteAsync() Disassociates current site from primary hub site Declaration Task UnJoinHubSiteAsync() Returns Task < Boolean > UnregisterHubSite() Unregisters the current site as a primary hub site Declaration bool UnregisterHubSite() Returns Boolean UnregisterHubSiteAsync() Unregisters the current site as a primary hub site Declaration Task UnregisterHubSiteAsync() Returns Task < Boolean > Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.ISocial.html": { "href": "api/PnP.Core.Model.SharePoint.ISocial.html", @@ -2147,7 +2147,7 @@ "api/PnP.Core.Model.SharePoint.IStorageMetrics.html": { "href": "api/PnP.Core.Model.SharePoint.IStorageMetrics.html", "title": "Interface IStorageMetrics | PnP Core SDK", - "keywords": "Interface IStorageMetrics Public interface to define a StorageMetrics object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IStorageMetrics : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object LastModified Gets the last modified date and time of the storage resource. Declaration DateTime LastModified { get; } Property Value DateTime TotalFileCount Gets the total count of files in the storage resource. Declaration long TotalFileCount { get; } Property Value Int64 TotalFileStreamSize Gets the total stream size of the storage resource. Declaration long TotalFileStreamSize { get; } Property Value Int64 TotalSize Gets the total size of the storage resource. Declaration long TotalSize { get; } Property Value Int64 Extension Methods RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IStorageMetrics Public interface to define a StorageMetrics object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IStorageMetrics : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object LastModified Gets the last modified date and time of the storage resource. Declaration DateTime LastModified { get; } Property Value DateTime TotalFileCount Gets the total count of files in the storage resource. Declaration long TotalFileCount { get; } Property Value Int64 TotalFileStreamSize Gets the total stream size of the storage resource. Declaration long TotalFileStreamSize { get; } Property Value Int64 TotalSize Gets the total size of the storage resource. Declaration long TotalSize { get; } Property Value Int64 Extension Methods RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.ISyntexClassifyAndExtractResult.html": { "href": "api/PnP.Core.Model.SharePoint.ISyntexClassifyAndExtractResult.html", @@ -2192,7 +2192,7 @@ "api/PnP.Core.Model.SharePoint.ITermGroupCollection.html": { "href": "api/PnP.Core.Model.SharePoint.ITermGroupCollection.html", "title": "Interface ITermGroupCollection | PnP Core SDK", - "keywords": "Interface ITermGroupCollection Collection of term groups Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() IDataModelCollectionDeleteByStringId.DeleteById(String) IDataModelCollectionDeleteByStringId.DeleteByIdAsync(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatch(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatchAsync(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatch(Batch, String) IDataModelCollectionDeleteByStringId.DeleteByIdBatchAsync(Batch, String) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface ITermGroupCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionDeleteByStringId, ISupportModules Methods Add(String, String, TermGroupScope) Adds a new term group Declaration ITermGroup Add(string name, string description = null, TermGroupScope scope = TermGroupScope.Global) Parameters String name Display name of the group String description Optional description of the group TermGroupScope scope Optional scope of the group Returns ITermGroup Newly added group AddAsync(String, String, TermGroupScope) Adds a new term group Declaration Task AddAsync(string name, string description = null, TermGroupScope scope = TermGroupScope.Global) Parameters String name Display name of the group String description Optional description of the group TermGroupScope scope Optional scope of the group Returns Task < ITermGroup > Newly added group AddBatch(Batch, String, String, TermGroupScope) Adds a new term group Declaration ITermGroup AddBatch(Batch batch, string name, string description = null, TermGroupScope scope = TermGroupScope.Global) Parameters Batch batch Batch to use String name Display name of the group String description Optional description of the group TermGroupScope scope Optional scope of the group Returns ITermGroup Newly added group AddBatch(String, String, TermGroupScope) Adds a new term group Declaration ITermGroup AddBatch(string name, string description = null, TermGroupScope scope = TermGroupScope.Global) Parameters String name Display name of the group String description Optional description of the group TermGroupScope scope Optional scope of the group Returns ITermGroup Newly added group AddBatchAsync(Batch, String, String, TermGroupScope) Adds a new term group Declaration Task AddBatchAsync(Batch batch, string name, string description = null, TermGroupScope scope = TermGroupScope.Global) Parameters Batch batch Batch to use String name Display name of the group String description Optional description of the group TermGroupScope scope Optional scope of the group Returns Task < ITermGroup > Newly added group AddBatchAsync(String, String, TermGroupScope) Adds a new term group Declaration Task AddBatchAsync(string name, string description = null, TermGroupScope scope = TermGroupScope.Global) Parameters String name Display name of the group String description Optional description of the group TermGroupScope scope Optional scope of the group Returns Task < ITermGroup > Newly added group GetById(String, Expression>[]) Method to select a term group by id Declaration ITermGroup GetById(string id, params Expression>[] selectors) Parameters String id The id to search for Expression < Func < ITermGroup , Object >>[] selectors The expressions declaring the fields to select Returns ITermGroup The resulting term group instance, if any GetByIdAsync(String, Expression>[]) Method to select a term group by id Declaration Task GetByIdAsync(string id, params Expression>[] selectors) Parameters String id The id to search for Expression < Func < ITermGroup , Object >>[] selectors The expressions declaring the fields to select Returns Task < ITermGroup > The resulting term group instance, if any GetByName(String, Expression>[]) Method to select a term group by name Declaration ITermGroup GetByName(string name, params Expression>[] selectors) Parameters String name The name to search for Expression < Func < ITermGroup , Object >>[] selectors The expressions declaring the fields to select Returns ITermGroup The resulting term group instance, if any GetByNameAsync(String, Expression>[]) Method to select a term group by name Declaration Task GetByNameAsync(string name, params Expression>[] selectors) Parameters String name The name to search for Expression < Func < ITermGroup , Object >>[] selectors The expressions declaring the fields to select Returns Task < ITermGroup > The resulting term group instance, if any Extension Methods RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" + "keywords": "Interface ITermGroupCollection Collection of term groups Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() IDataModelCollectionDeleteByStringId.DeleteById(String) IDataModelCollectionDeleteByStringId.DeleteByIdAsync(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatch(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatchAsync(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatch(Batch, String) IDataModelCollectionDeleteByStringId.DeleteByIdBatchAsync(Batch, String) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface ITermGroupCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionDeleteByStringId, ISupportModules Methods Add(String, String, TermGroupScope) Adds a new term group Declaration ITermGroup Add(string name, string description = null, TermGroupScope scope = TermGroupScope.Global) Parameters String name Display name of the group String description Optional description of the group TermGroupScope scope Optional scope of the group Returns ITermGroup Newly added group AddAsync(String, String, TermGroupScope) Adds a new term group Declaration Task AddAsync(string name, string description = null, TermGroupScope scope = TermGroupScope.Global) Parameters String name Display name of the group String description Optional description of the group TermGroupScope scope Optional scope of the group Returns Task < ITermGroup > Newly added group AddBatch(Batch, String, String, TermGroupScope) Adds a new term group Declaration ITermGroup AddBatch(Batch batch, string name, string description = null, TermGroupScope scope = TermGroupScope.Global) Parameters Batch batch Batch to use String name Display name of the group String description Optional description of the group TermGroupScope scope Optional scope of the group Returns ITermGroup Newly added group AddBatch(String, String, TermGroupScope) Adds a new term group Declaration ITermGroup AddBatch(string name, string description = null, TermGroupScope scope = TermGroupScope.Global) Parameters String name Display name of the group String description Optional description of the group TermGroupScope scope Optional scope of the group Returns ITermGroup Newly added group AddBatchAsync(Batch, String, String, TermGroupScope) Adds a new term group Declaration Task AddBatchAsync(Batch batch, string name, string description = null, TermGroupScope scope = TermGroupScope.Global) Parameters Batch batch Batch to use String name Display name of the group String description Optional description of the group TermGroupScope scope Optional scope of the group Returns Task < ITermGroup > Newly added group AddBatchAsync(String, String, TermGroupScope) Adds a new term group Declaration Task AddBatchAsync(string name, string description = null, TermGroupScope scope = TermGroupScope.Global) Parameters String name Display name of the group String description Optional description of the group TermGroupScope scope Optional scope of the group Returns Task < ITermGroup > Newly added group GetById(String, Expression>[]) Method to select a term group by id Declaration ITermGroup GetById(string id, params Expression>[] selectors) Parameters String id The id to search for Expression < Func < ITermGroup , System.Object >>[] selectors The expressions declaring the fields to select Returns ITermGroup The resulting term group instance, if any GetByIdAsync(String, Expression>[]) Method to select a term group by id Declaration Task GetByIdAsync(string id, params Expression>[] selectors) Parameters String id The id to search for Expression < Func < ITermGroup , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < ITermGroup > The resulting term group instance, if any GetByName(String, Expression>[]) Method to select a term group by name Declaration ITermGroup GetByName(string name, params Expression>[] selectors) Parameters String name The name to search for Expression < Func < ITermGroup , System.Object >>[] selectors The expressions declaring the fields to select Returns ITermGroup The resulting term group instance, if any GetByNameAsync(String, Expression>[]) Method to select a term group by name Declaration Task GetByNameAsync(string name, params Expression>[] selectors) Parameters String name The name to search for Expression < Func < ITermGroup , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < ITermGroup > The resulting term group instance, if any Extension Methods RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" }, "api/PnP.Core.Model.SharePoint.ITermLocalizedDescription.html": { "href": "api/PnP.Core.Model.SharePoint.ITermLocalizedDescription.html", @@ -2242,7 +2242,7 @@ "api/PnP.Core.Model.SharePoint.ITermSetCollection.html": { "href": "api/PnP.Core.Model.SharePoint.ITermSetCollection.html", "title": "Interface ITermSetCollection | PnP Core SDK", - "keywords": "Interface ITermSetCollection Collection of term sets Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() IDataModelCollectionDeleteByStringId.DeleteById(String) IDataModelCollectionDeleteByStringId.DeleteByIdAsync(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatch(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatchAsync(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatch(Batch, String) IDataModelCollectionDeleteByStringId.DeleteByIdBatchAsync(Batch, String) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface ITermSetCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionDeleteByStringId, ISupportModules Methods Add(String, String) Adds a new term set Declaration ITermSet Add(string name, string description = null) Parameters String name Name of the term set String description Optional description of the term set Returns ITermSet Newly added term set AddAsync(String, String) Adds a new term set Declaration Task AddAsync(string name, string description = null) Parameters String name Name of the term set String description Optional description of the term set Returns Task < ITermSet > Newly added term set AddBatch(Batch, String, String) Adds a new term set Declaration ITermSet AddBatch(Batch batch, string name, string description = null) Parameters Batch batch Batch to use String name Name of the term set String description Optional description of the term set Returns ITermSet Newly added term set AddBatch(String, String) Adds a new term set Declaration ITermSet AddBatch(string name, string description = null) Parameters String name Name of the term set String description Optional description of the term set Returns ITermSet Newly added term set AddBatchAsync(Batch, String, String) Adds a new term set Declaration Task AddBatchAsync(Batch batch, string name, string description = null) Parameters Batch batch Batch to use String name Name of the term set String description Optional description of the term set Returns Task < ITermSet > Newly added term set AddBatchAsync(String, String) Adds a new term set Declaration Task AddBatchAsync(string name, string description = null) Parameters String name Name of the term set String description Optional description of the term set Returns Task < ITermSet > Newly added term set GetById(String, Expression>[]) Extension method to select a term set by id Declaration ITermSet GetById(string id, params Expression>[] selectors) Parameters String id The id to search for Expression < Func < ITermSet , Object >>[] selectors The expressions declaring the fields to select Returns ITermSet The resulting term set instance, if any GetByIdAsync(String, Expression>[]) Extension method to select a term set by id Declaration Task GetByIdAsync(string id, params Expression>[] selectors) Parameters String id The id to search for Expression < Func < ITermSet , Object >>[] selectors The expressions declaring the fields to select Returns Task < ITermSet > The resulting term set instance, if any Extension Methods RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" + "keywords": "Interface ITermSetCollection Collection of term sets Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() IDataModelCollectionDeleteByStringId.DeleteById(String) IDataModelCollectionDeleteByStringId.DeleteByIdAsync(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatch(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatchAsync(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatch(Batch, String) IDataModelCollectionDeleteByStringId.DeleteByIdBatchAsync(Batch, String) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface ITermSetCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionDeleteByStringId, ISupportModules Methods Add(String, String) Adds a new term set Declaration ITermSet Add(string name, string description = null) Parameters String name Name of the term set String description Optional description of the term set Returns ITermSet Newly added term set AddAsync(String, String) Adds a new term set Declaration Task AddAsync(string name, string description = null) Parameters String name Name of the term set String description Optional description of the term set Returns Task < ITermSet > Newly added term set AddBatch(Batch, String, String) Adds a new term set Declaration ITermSet AddBatch(Batch batch, string name, string description = null) Parameters Batch batch Batch to use String name Name of the term set String description Optional description of the term set Returns ITermSet Newly added term set AddBatch(String, String) Adds a new term set Declaration ITermSet AddBatch(string name, string description = null) Parameters String name Name of the term set String description Optional description of the term set Returns ITermSet Newly added term set AddBatchAsync(Batch, String, String) Adds a new term set Declaration Task AddBatchAsync(Batch batch, string name, string description = null) Parameters Batch batch Batch to use String name Name of the term set String description Optional description of the term set Returns Task < ITermSet > Newly added term set AddBatchAsync(String, String) Adds a new term set Declaration Task AddBatchAsync(string name, string description = null) Parameters String name Name of the term set String description Optional description of the term set Returns Task < ITermSet > Newly added term set GetById(String, Expression>[]) Extension method to select a term set by id Declaration ITermSet GetById(string id, params Expression>[] selectors) Parameters String id The id to search for Expression < Func < ITermSet , System.Object >>[] selectors The expressions declaring the fields to select Returns ITermSet The resulting term set instance, if any GetByIdAsync(String, Expression>[]) Extension method to select a term set by id Declaration Task GetByIdAsync(string id, params Expression>[] selectors) Parameters String id The id to search for Expression < Func < ITermSet , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < ITermSet > The resulting term set instance, if any Extension Methods RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" }, "api/PnP.Core.Model.SharePoint.ITermSetLocalizedName.html": { "href": "api/PnP.Core.Model.SharePoint.ITermSetLocalizedName.html", @@ -2267,7 +2267,7 @@ "api/PnP.Core.Model.SharePoint.ITermStore.html": { "href": "api/PnP.Core.Model.SharePoint.ITermStore.html", "title": "Interface ITermStore | PnP Core SDK", - "keywords": "Interface ITermStore Microsoft 365 Term store Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface ITermStore : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate Properties DefaultLanguage Default language of the termstore. Declaration string DefaultLanguage { get; set; } Property Value String Groups Collection of term groups in this term store Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ITermGroupCollection Groups { get; } Property Value ITermGroupCollection Id The Unique ID of the Term Store Declaration string Id { get; } Property Value String Languages List of languages for the term store. Declaration List Languages { get; } Property Value PnP.Core.Model.SharePoint.List < String > Methods GetTermById(String, String, Expression>[]) Gets a term from this termstore via it's id and it's termset id Declaration ITerm GetTermById(string termSetId, string termId, params Expression>[] selectors) Parameters String termSetId Termset id of the termset containing the term String termId Term id of the term to retrieve Expression < Func < ITerm , Object >>[] selectors Properties to load for the term Returns ITerm The loaded term GetTermByIdAsync(String, String, Expression>[]) Gets a term from this termstore via it's id and it's termset id Declaration Task GetTermByIdAsync(string termSetId, string termId, params Expression>[] selectors) Parameters String termSetId Termset id of the termset containing the term String termId Term id of the term to retrieve Expression < Func < ITerm , Object >>[] selectors Properties to load for the term Returns Task < ITerm > The loaded term GetTermByIdBatch(Batch, String, String, Expression>[]) Gets a term from this termstore via it's id and it's termset id Declaration ITerm GetTermByIdBatch(Batch batch, string termSetId, string termId, params Expression>[] selectors) Parameters Batch batch Batch to add this reques to String termSetId Termset id of the termset containing the term String termId Term id of the term to retrieve Expression < Func < ITerm , Object >>[] selectors Properties to load for the term Returns ITerm The loaded term GetTermByIdBatch(String, String, Expression>[]) Gets a term from this termstore via it's id and it's termset id Declaration ITerm GetTermByIdBatch(string termSetId, string termId, params Expression>[] selectors) Parameters String termSetId Termset id of the termset containing the term String termId Term id of the term to retrieve Expression < Func < ITerm , Object >>[] selectors Properties to load for the term Returns ITerm The loaded term GetTermByIdBatchAsync(Batch, String, String, Expression>[]) Gets a term from this termstore via it's id and it's termset id Declaration Task GetTermByIdBatchAsync(Batch batch, string termSetId, string termId, params Expression>[] selectors) Parameters Batch batch Batch to add this reques to String termSetId Termset id of the termset containing the term String termId Term id of the term to retrieve Expression < Func < ITerm , Object >>[] selectors Properties to load for the term Returns Task < ITerm > The loaded term GetTermByIdBatchAsync(String, String, Expression>[]) Gets a term from this termstore via it's id and it's termset id Declaration Task GetTermByIdBatchAsync(string termSetId, string termId, params Expression>[] selectors) Parameters String termSetId Termset id of the termset containing the term String termId Term id of the term to retrieve Expression < Func < ITerm , Object >>[] selectors Properties to load for the term Returns Task < ITerm > The loaded term GetTermSetById(String, Expression>[]) Gets a termset from this termstore via it's id Declaration ITermSet GetTermSetById(string id, params Expression>[] selectors) Parameters String id Termset id to retrieve Expression < Func < ITermSet , Object >>[] selectors Properties to load for the termset Returns ITermSet The loaded termset GetTermSetByIdAsync(String, Expression>[]) Gets a termset from this termstore via it's id Declaration Task GetTermSetByIdAsync(string id, params Expression>[] selectors) Parameters String id Termset id to retrieve Expression < Func < ITermSet , Object >>[] selectors Properties to load for the termset Returns Task < ITermSet > The loaded termset GetTermSetByIdBatch(Batch, String, Expression>[]) Gets a termset from this termstore via it's id Declaration ITermSet GetTermSetByIdBatch(Batch batch, string id, params Expression>[] selectors) Parameters Batch batch Batch to add this reques to String id Termset id to retrieve Expression < Func < ITermSet , Object >>[] selectors Properties to load for the termset Returns ITermSet The loaded termset GetTermSetByIdBatch(String, Expression>[]) Gets a termset from this termstore via it's id Declaration ITermSet GetTermSetByIdBatch(string id, params Expression>[] selectors) Parameters String id Termset id to retrieve Expression < Func < ITermSet , Object >>[] selectors Properties to load for the termset Returns ITermSet The loaded termset GetTermSetByIdBatchAsync(Batch, String, Expression>[]) Gets a termset from this termstore via it's id Declaration Task GetTermSetByIdBatchAsync(Batch batch, string id, params Expression>[] selectors) Parameters Batch batch Batch to add this reques to String id Termset id to retrieve Expression < Func < ITermSet , Object >>[] selectors Properties to load for the termset Returns Task < ITermSet > The loaded termset GetTermSetByIdBatchAsync(String, Expression>[]) Gets a termset from this termstore via it's id Declaration Task GetTermSetByIdBatchAsync(string id, params Expression>[] selectors) Parameters String id Termset id to retrieve Expression < Func < ITermSet , Object >>[] selectors Properties to load for the termset Returns Task < ITermSet > The loaded termset Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface ITermStore Microsoft 365 Term store Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface ITermStore : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate Properties DefaultLanguage Default language of the termstore. Declaration string DefaultLanguage { get; set; } Property Value String Groups Collection of term groups in this term store Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ITermGroupCollection Groups { get; } Property Value ITermGroupCollection Id The Unique ID of the Term Store Declaration string Id { get; } Property Value String Languages List of languages for the term store. Declaration List Languages { get; } Property Value PnP.Core.Model.SharePoint.List < String > Methods GetTermById(String, String, Expression>[]) Gets a term from this termstore via it's id and it's termset id Declaration ITerm GetTermById(string termSetId, string termId, params Expression>[] selectors) Parameters String termSetId Termset id of the termset containing the term String termId Term id of the term to retrieve Expression < Func < ITerm , System.Object >>[] selectors Properties to load for the term Returns ITerm The loaded term GetTermByIdAsync(String, String, Expression>[]) Gets a term from this termstore via it's id and it's termset id Declaration Task GetTermByIdAsync(string termSetId, string termId, params Expression>[] selectors) Parameters String termSetId Termset id of the termset containing the term String termId Term id of the term to retrieve Expression < Func < ITerm , System.Object >>[] selectors Properties to load for the term Returns Task < ITerm > The loaded term GetTermByIdBatch(Batch, String, String, Expression>[]) Gets a term from this termstore via it's id and it's termset id Declaration ITerm GetTermByIdBatch(Batch batch, string termSetId, string termId, params Expression>[] selectors) Parameters Batch batch Batch to add this reques to String termSetId Termset id of the termset containing the term String termId Term id of the term to retrieve Expression < Func < ITerm , System.Object >>[] selectors Properties to load for the term Returns ITerm The loaded term GetTermByIdBatch(String, String, Expression>[]) Gets a term from this termstore via it's id and it's termset id Declaration ITerm GetTermByIdBatch(string termSetId, string termId, params Expression>[] selectors) Parameters String termSetId Termset id of the termset containing the term String termId Term id of the term to retrieve Expression < Func < ITerm , System.Object >>[] selectors Properties to load for the term Returns ITerm The loaded term GetTermByIdBatchAsync(Batch, String, String, Expression>[]) Gets a term from this termstore via it's id and it's termset id Declaration Task GetTermByIdBatchAsync(Batch batch, string termSetId, string termId, params Expression>[] selectors) Parameters Batch batch Batch to add this reques to String termSetId Termset id of the termset containing the term String termId Term id of the term to retrieve Expression < Func < ITerm , System.Object >>[] selectors Properties to load for the term Returns Task < ITerm > The loaded term GetTermByIdBatchAsync(String, String, Expression>[]) Gets a term from this termstore via it's id and it's termset id Declaration Task GetTermByIdBatchAsync(string termSetId, string termId, params Expression>[] selectors) Parameters String termSetId Termset id of the termset containing the term String termId Term id of the term to retrieve Expression < Func < ITerm , System.Object >>[] selectors Properties to load for the term Returns Task < ITerm > The loaded term GetTermSetById(String, Expression>[]) Gets a termset from this termstore via it's id Declaration ITermSet GetTermSetById(string id, params Expression>[] selectors) Parameters String id Termset id to retrieve Expression < Func < ITermSet , System.Object >>[] selectors Properties to load for the termset Returns ITermSet The loaded termset GetTermSetByIdAsync(String, Expression>[]) Gets a termset from this termstore via it's id Declaration Task GetTermSetByIdAsync(string id, params Expression>[] selectors) Parameters String id Termset id to retrieve Expression < Func < ITermSet , System.Object >>[] selectors Properties to load for the termset Returns Task < ITermSet > The loaded termset GetTermSetByIdBatch(Batch, String, Expression>[]) Gets a termset from this termstore via it's id Declaration ITermSet GetTermSetByIdBatch(Batch batch, string id, params Expression>[] selectors) Parameters Batch batch Batch to add this reques to String id Termset id to retrieve Expression < Func < ITermSet , System.Object >>[] selectors Properties to load for the termset Returns ITermSet The loaded termset GetTermSetByIdBatch(String, Expression>[]) Gets a termset from this termstore via it's id Declaration ITermSet GetTermSetByIdBatch(string id, params Expression>[] selectors) Parameters String id Termset id to retrieve Expression < Func < ITermSet , System.Object >>[] selectors Properties to load for the termset Returns ITermSet The loaded termset GetTermSetByIdBatchAsync(Batch, String, Expression>[]) Gets a termset from this termstore via it's id Declaration Task GetTermSetByIdBatchAsync(Batch batch, string id, params Expression>[] selectors) Parameters Batch batch Batch to add this reques to String id Termset id to retrieve Expression < Func < ITermSet , System.Object >>[] selectors Properties to load for the termset Returns Task < ITermSet > The loaded termset GetTermSetByIdBatchAsync(String, Expression>[]) Gets a termset from this termstore via it's id Declaration Task GetTermSetByIdBatchAsync(string id, params Expression>[] selectors) Parameters String id Termset id to retrieve Expression < Func < ITermSet , System.Object >>[] selectors Properties to load for the termset Returns Task < ITermSet > The loaded termset Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.ITheme.html": { "href": "api/PnP.Core.Model.SharePoint.ITheme.html", @@ -2282,7 +2282,7 @@ "api/PnP.Core.Model.SharePoint.ITimeZone.html": { "href": "api/PnP.Core.Model.SharePoint.ITimeZone.html", "title": "Interface ITimeZone | PnP Core SDK", - "keywords": "Interface ITimeZone Public interface to define a TimeZone object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface ITimeZone : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object Bias Bias (additional minutes to get to UTC time) for this time zone Declaration int Bias { get; } Property Value Int32 DaylightBias Bias (additional minutes to get to UTC time) for this time zone when in daylight saving Declaration int DaylightBias { get; } Property Value Int32 Description Time zone description Declaration string Description { get; } Property Value String Id Id of the time zone Declaration int Id { get; } Property Value Int32 StandardBias Bias (additional minutes to get to UTC time) for this time zone when not in daylight saving Declaration int StandardBias { get; } Property Value Int32 Methods GetTimeZoneInfo() Returns the current SharePoint timezone information as a Windows TimeZoneInfo object Declaration TimeZoneInfo GetTimeZoneInfo() Returns TimeZoneInfo LocalTimeToUtc(DateTime) Converts the specified DateTime value from local time to Coordinated Universal Time (UTC). Declaration DateTime LocalTimeToUtc(DateTime dateTime) Parameters DateTime dateTime A object that represents the local date and time value to convert. Returns DateTime A object that contains the date converted to UTC. UtcToLocalTime(DateTime) Converts the specified DateTime value from Coordinated Universal Time (UTC) to local time. Declaration DateTime UtcToLocalTime(DateTime dateTime) Parameters DateTime dateTime A object that represents the UTC date and time value to convert. Returns DateTime A structure that contains the date and time converted to their local values. Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface ITimeZone Public interface to define a TimeZone object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface ITimeZone : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object Bias Bias (additional minutes to get to UTC time) for this time zone Declaration int Bias { get; } Property Value Int32 DaylightBias Bias (additional minutes to get to UTC time) for this time zone when in daylight saving Declaration int DaylightBias { get; } Property Value Int32 Description Time zone description Declaration string Description { get; } Property Value String Id Id of the time zone Declaration int Id { get; } Property Value Int32 StandardBias Bias (additional minutes to get to UTC time) for this time zone when not in daylight saving Declaration int StandardBias { get; } Property Value Int32 Methods GetTimeZoneInfo() Returns the current SharePoint timezone information as a Windows TimeZoneInfo object Declaration TimeZoneInfo GetTimeZoneInfo() Returns TimeZoneInfo LocalTimeToUtc(DateTime) Converts the specified DateTime value from local time to Coordinated Universal Time (UTC). Declaration DateTime LocalTimeToUtc(DateTime dateTime) Parameters DateTime dateTime A object that represents the local date and time value to convert. Returns DateTime A object that contains the date converted to UTC. UtcToLocalTime(DateTime) Converts the specified DateTime value from Coordinated Universal Time (UTC) to local time. Declaration DateTime UtcToLocalTime(DateTime dateTime) Parameters DateTime dateTime A object that represents the UTC date and time value to convert. Returns DateTime A structure that contains the date and time converted to their local values. Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.ITimeZoneCollection.html": { "href": "api/PnP.Core.Model.SharePoint.ITimeZoneCollection.html", @@ -2297,7 +2297,7 @@ "api/PnP.Core.Model.SharePoint.IUserCustomAction.html": { "href": "api/PnP.Core.Model.SharePoint.IUserCustomAction.html", "title": "Interface IUserCustomAction | PnP Core SDK", - "keywords": "Interface IUserCustomAction Public interface to define a UserCustomAction object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IUserCustomAction : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object ClientSideComponentId Gets or sets the unique identifier of the associated client side component. Declaration Guid ClientSideComponentId { get; set; } Property Value Guid ClientSideComponentProperties Gets or sets the JSON formatted properties of the associated client side component. Declaration string ClientSideComponentProperties { get; set; } Property Value String CommandUIExtension Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action. Declaration string CommandUIExtension { get; set; } Property Value String Description Gets or sets the description of the custom action. Declaration string Description { get; set; } Property Value String Group Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page. Declaration string Group { get; set; } Property Value String HostProperties This property is only used when an application customizer is created and preallocated placeholders are specified. It is optional. If non-empty, the string must contain a JSON object with one or two properties for the height amount needed to be preallocated. Declaration string HostProperties { get; set; } Property Value String Id Gets a value that specifies the identifier of the custom action. Declaration Guid Id { get; } Property Value Guid ImageUrl Gets or sets the URL of the image associated with the custom action. Declaration string ImageUrl { get; set; } Property Value String Location Gets or sets the location of the custom action. Declaration string Location { get; set; } Property Value String Name Gets or sets the name of the custom action. Declaration string Name { get; set; } Property Value String RegistrationId Gets or sets the value that specifies the identifier of the object associated with the custom action. Declaration string RegistrationId { get; set; } Property Value String RegistrationType Gets or sets the value that specifies the type of object associated with the custom action. Declaration UserCustomActionRegistrationType RegistrationType { get; set; } Property Value UserCustomActionRegistrationType Rights Get or sets the base permissions of the action. Declaration IBasePermissions Rights { get; set; } Property Value IBasePermissions Scope Gets a value that specifies the scope of the custom action. Declaration UserCustomActionScope Scope { get; } Property Value UserCustomActionScope ScriptBlock Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed. Declaration string ScriptBlock { get; set; } Property Value String ScriptSrc Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page. Declaration string ScriptSrc { get; set; } Property Value String Sequence Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page. Declaration int Sequence { get; set; } Property Value Int32 Title Gets or sets the display title of the custom action. Declaration string Title { get; set; } Property Value String Url Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action. Declaration string Url { get; set; } Property Value String VersionOfUserCustomAction Returns the version of the user custom action. Declaration string VersionOfUserCustomAction { get; } Property Value String Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IUserCustomAction Public interface to define a UserCustomAction object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IUserCustomAction : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object ClientSideComponentId Gets or sets the unique identifier of the associated client side component. Declaration Guid ClientSideComponentId { get; set; } Property Value Guid ClientSideComponentProperties Gets or sets the JSON formatted properties of the associated client side component. Declaration string ClientSideComponentProperties { get; set; } Property Value String CommandUIExtension Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action. Declaration string CommandUIExtension { get; set; } Property Value String Description Gets or sets the description of the custom action. Declaration string Description { get; set; } Property Value String Group Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page. Declaration string Group { get; set; } Property Value String HostProperties This property is only used when an application customizer is created and preallocated placeholders are specified. It is optional. If non-empty, the string must contain a JSON object with one or two properties for the height amount needed to be preallocated. Declaration string HostProperties { get; set; } Property Value String Id Gets a value that specifies the identifier of the custom action. Declaration Guid Id { get; } Property Value Guid ImageUrl Gets or sets the URL of the image associated with the custom action. Declaration string ImageUrl { get; set; } Property Value String Location Gets or sets the location of the custom action. Declaration string Location { get; set; } Property Value String Name Gets or sets the name of the custom action. Declaration string Name { get; set; } Property Value String RegistrationId Gets or sets the value that specifies the identifier of the object associated with the custom action. Declaration string RegistrationId { get; set; } Property Value String RegistrationType Gets or sets the value that specifies the type of object associated with the custom action. Declaration UserCustomActionRegistrationType RegistrationType { get; set; } Property Value UserCustomActionRegistrationType Rights Get or sets the base permissions of the action. Declaration IBasePermissions Rights { get; set; } Property Value IBasePermissions Scope Gets a value that specifies the scope of the custom action. Declaration UserCustomActionScope Scope { get; } Property Value UserCustomActionScope ScriptBlock Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed. Declaration string ScriptBlock { get; set; } Property Value String ScriptSrc Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page. Declaration string ScriptSrc { get; set; } Property Value String Sequence Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page. Declaration int Sequence { get; set; } Property Value Int32 Title Gets or sets the display title of the custom action. Declaration string Title { get; set; } Property Value String Url Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action. Declaration string Url { get; set; } Property Value String VersionOfUserCustomAction Returns the version of the user custom action. Declaration string VersionOfUserCustomAction { get; } Property Value String Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IUserCustomActionCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IUserCustomActionCollection.html", @@ -2307,12 +2307,12 @@ "api/PnP.Core.Model.SharePoint.IUserProfile.html": { "href": "api/PnP.Core.Model.SharePoint.IUserProfile.html", "title": "Interface IUserProfile | PnP Core SDK", - "keywords": "Interface IUserProfile An entry point for the user profile APIs Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IUserProfile : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad Properties EditProfileLink The link to edit the current user's profile Declaration string EditProfileLink { get; } Property Value String IsMyPeopleListPublic A Boolean value that indicates whether the current user's People I'm Following list is public. Declaration bool IsMyPeopleListPublic { get; } Property Value Boolean Methods GetMyProperties(Expression>[]) Gets user properties for the current user. Declaration IPersonProperties GetMyProperties(params Expression>[] selectors) Parameters Expression < Func < IPersonProperties , Object >>[] selectors Specific properties to return Returns IPersonProperties An instance of IPersonProperties GetMyPropertiesAsync(Expression>[]) Gets user properties for the current user. Declaration Task GetMyPropertiesAsync(params Expression>[] selectors) Parameters Expression < Func < IPersonProperties , Object >>[] selectors Specific properties to return Returns Task < IPersonProperties > An instance of IPersonProperties GetPropertiesFor(String, Expression>[]) Gets user properties for the specified user. Declaration IPersonProperties GetPropertiesFor(string accountName, params Expression>[] selectors) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Expression < Func < IPersonProperties , Object >>[] selectors Specific properties to return Returns IPersonProperties An instance of IPersonProperties GetPropertiesForAsync(String, Expression>[]) Gets user properties for the specified user. Declaration Task GetPropertiesForAsync(string accountName, params Expression>[] selectors) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Expression < Func < IPersonProperties , Object >>[] selectors Specific properties to return Returns Task < IPersonProperties > An instance of IPersonProperties GetPropertyFor(String, String) Gets the specified user profile property for the specified user. Declaration string GetPropertyFor(string accountName, string propertyName) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" String propertyName The case-sensitive name of the property to get. Returns String The specified profile property for the specified user. GetPropertyForAsync(String, String) Gets the specified user profile property for the specified user. Declaration Task GetPropertyForAsync(string accountName, string propertyName) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" String propertyName The case-sensitive name of the property to get. Returns Task < String > The specified profile property for the specified user. GetUserOneDriveQuotaMax(String) Gets the user's onedrive max quota Declaration long GetUserOneDriveQuotaMax(string accountName) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Returns Int64 The max quota value GetUserOneDriveQuotaMaxAsync(String) Gets the user's onedrive max quota Declaration Task GetUserOneDriveQuotaMaxAsync(string accountName) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Returns Task < Int64 > The max quota value ResetUserOneDriveQuotaToDefault(String) Resets the user's onedrive quota to the default value Declaration string ResetUserOneDriveQuotaToDefault(string accountName) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Returns String The string outcome ResetUserOneDriveQuotaToDefaultAsync(String) Resets the user's onedrive quota to the default value Declaration Task ResetUserOneDriveQuotaToDefaultAsync(string accountName) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Returns Task < String > The string outcome SetMultiValuedProfileProperty(String, String, IList) Sets the user's multi value profile property. Declaration void SetMultiValuedProfileProperty(string accountName, string propertyName, IList propertyValues) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" String propertyName The case-sensitive name of the property to get. PnP.Core.Model.SharePoint.IList < String > propertyValues The property values SetMultiValuedProfilePropertyAsync(String, String, IList) Sets the user's multi value profile property. Declaration Task SetMultiValuedProfilePropertyAsync(string accountName, string propertyName, IList propertyValues) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" String propertyName The case-sensitive name of the property to get. PnP.Core.Model.SharePoint.IList < String > propertyValues The property values Returns Task SetMyProfilePicture(Byte[]) Uploads and sets the user profile picture. Users can upload a picture to their own profile only. Declaration void SetMyProfilePicture(byte[] fileBytes) Parameters Byte [] fileBytes A byte array representing the file SetMyProfilePictureAsync(Byte[]) Uploads and sets the user profile picture. Users can upload a picture to their own profile only. Declaration Task SetMyProfilePictureAsync(byte[] fileBytes) Parameters Byte [] fileBytes A byte array representing the file Returns Task SetSingleValueProfileProperty(String, String, String) Sets the user's profile property. Declaration void SetSingleValueProfileProperty(string accountName, string propertyName, string propertyValue) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" String propertyName The case-sensitive name of the property to get. String propertyValue The property value SetSingleValueProfilePropertyAsync(String, String, String) Sets the user's profile property. Declaration Task SetSingleValueProfilePropertyAsync(string accountName, string propertyName, string propertyValue) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" String propertyName The case-sensitive name of the property to get. String propertyValue The property value Returns Task SetUserOneDriveQuota(String, Int64, Int64) Sets the user's onedrive quota Declaration string SetUserOneDriveQuota(string accountName, long newQuota, long newQuotaWarning) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Int64 newQuota New quota value Int64 newQuotaWarning Quota warning value Returns String The string outcome SetUserOneDriveQuotaAsync(String, Int64, Int64) Sets the user's onedrive quota Declaration Task SetUserOneDriveQuotaAsync(string accountName, long newQuota, long newQuotaWarning) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Int64 newQuota New quota value Int64 newQuotaWarning Quota warning value Returns Task < String > The string outcome Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IUserProfile An entry point for the user profile APIs Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IUserProfile : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad Properties EditProfileLink The link to edit the current user's profile Declaration string EditProfileLink { get; } Property Value String IsMyPeopleListPublic A Boolean value that indicates whether the current user's People I'm Following list is public. Declaration bool IsMyPeopleListPublic { get; } Property Value Boolean Methods GetMyProperties(Expression>[]) Gets user properties for the current user. Declaration IPersonProperties GetMyProperties(params Expression>[] selectors) Parameters Expression < Func < IPersonProperties , System.Object >>[] selectors Specific properties to return Returns IPersonProperties An instance of IPersonProperties GetMyPropertiesAsync(Expression>[]) Gets user properties for the current user. Declaration Task GetMyPropertiesAsync(params Expression>[] selectors) Parameters Expression < Func < IPersonProperties , System.Object >>[] selectors Specific properties to return Returns Task < IPersonProperties > An instance of IPersonProperties GetPropertiesFor(String, Expression>[]) Gets user properties for the specified user. Declaration IPersonProperties GetPropertiesFor(string accountName, params Expression>[] selectors) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Expression < Func < IPersonProperties , System.Object >>[] selectors Specific properties to return Returns IPersonProperties An instance of IPersonProperties GetPropertiesForAsync(String, Expression>[]) Gets user properties for the specified user. Declaration Task GetPropertiesForAsync(string accountName, params Expression>[] selectors) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Expression < Func < IPersonProperties , System.Object >>[] selectors Specific properties to return Returns Task < IPersonProperties > An instance of IPersonProperties GetPropertyFor(String, String) Gets the specified user profile property for the specified user. Declaration string GetPropertyFor(string accountName, string propertyName) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" String propertyName The case-sensitive name of the property to get. Returns String The specified profile property for the specified user. GetPropertyForAsync(String, String) Gets the specified user profile property for the specified user. Declaration Task GetPropertyForAsync(string accountName, string propertyName) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" String propertyName The case-sensitive name of the property to get. Returns Task < String > The specified profile property for the specified user. GetUserOneDriveQuotaMax(String) Gets the user's onedrive max quota Declaration long GetUserOneDriveQuotaMax(string accountName) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Returns Int64 The max quota value GetUserOneDriveQuotaMaxAsync(String) Gets the user's onedrive max quota Declaration Task GetUserOneDriveQuotaMaxAsync(string accountName) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Returns Task < Int64 > The max quota value ResetUserOneDriveQuotaToDefault(String) Resets the user's onedrive quota to the default value Declaration string ResetUserOneDriveQuotaToDefault(string accountName) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Returns String The string outcome ResetUserOneDriveQuotaToDefaultAsync(String) Resets the user's onedrive quota to the default value Declaration Task ResetUserOneDriveQuotaToDefaultAsync(string accountName) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Returns Task < String > The string outcome SetMultiValuedProfileProperty(String, String, IList) Sets the user's multi value profile property. Declaration void SetMultiValuedProfileProperty(string accountName, string propertyName, IList propertyValues) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" String propertyName The case-sensitive name of the property to get. PnP.Core.Model.SharePoint.IList < String > propertyValues The property values SetMultiValuedProfilePropertyAsync(String, String, IList) Sets the user's multi value profile property. Declaration Task SetMultiValuedProfilePropertyAsync(string accountName, string propertyName, IList propertyValues) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" String propertyName The case-sensitive name of the property to get. PnP.Core.Model.SharePoint.IList < String > propertyValues The property values Returns Task SetMyProfilePicture(Byte[]) Uploads and sets the user profile picture. Users can upload a picture to their own profile only. Declaration void SetMyProfilePicture(byte[] fileBytes) Parameters Byte [] fileBytes A byte array representing the file SetMyProfilePictureAsync(Byte[]) Uploads and sets the user profile picture. Users can upload a picture to their own profile only. Declaration Task SetMyProfilePictureAsync(byte[] fileBytes) Parameters Byte [] fileBytes A byte array representing the file Returns Task SetSingleValueProfileProperty(String, String, String) Sets the user's profile property. Declaration void SetSingleValueProfileProperty(string accountName, string propertyName, string propertyValue) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" String propertyName The case-sensitive name of the property to get. String propertyValue The property value SetSingleValueProfilePropertyAsync(String, String, String) Sets the user's profile property. Declaration Task SetSingleValueProfilePropertyAsync(string accountName, string propertyName, string propertyValue) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" String propertyName The case-sensitive name of the property to get. String propertyValue The property value Returns Task SetUserOneDriveQuota(String, Int64, Int64) Sets the user's onedrive quota Declaration string SetUserOneDriveQuota(string accountName, long newQuota, long newQuotaWarning) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Int64 newQuota New quota value Int64 newQuotaWarning Quota warning value Returns String The string outcome SetUserOneDriveQuotaAsync(String, Int64, Int64) Sets the user's onedrive quota Declaration Task SetUserOneDriveQuotaAsync(string accountName, long newQuota, long newQuotaWarning) Parameters String accountName The account name, i.e. \"i:0#.f|membership|admin@m365x790252.onmicrosoft.com" Int64 newQuota New quota value Int64 newQuotaWarning Quota warning value Returns Task < String > The string outcome Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IView.html": { "href": "api/PnP.Core.Model.SharePoint.IView.html", "title": "Interface IView | PnP Core SDK", - "keywords": "Interface IView Public interface to define a View object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IView : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties Aggregations Specifies the aggregations displayed by the list view. The Aggregations property contains a CAML string. Declaration string Aggregations { get; set; } Property Value String AggregationsStatus Specifies whether the aggregations are shown in the list view Declaration string AggregationsStatus { get; set; } Property Value String All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object AssociatedContentTypeId Gets or sets Associated Content Type Id Declaration string AssociatedContentTypeId { get; set; } Property Value String BaseViewId Specifies the base view identifier of the list view Declaration string BaseViewId { get; } Property Value String CalendarViewStyles Gets or sets Calendar View Styles Declaration string CalendarViewStyles { get; set; } Property Value String ColumnWidth Gets or sets Column Width Declaration string ColumnWidth { get; set; } Property Value String CustomFormatter Gets or sets Custom Formatter Declaration string CustomFormatter { get; set; } Property Value String DefaultView Gets or sets a Boolean value that specifies whether the view is the default view Declaration bool DefaultView { get; set; } Property Value Boolean DefaultViewForContentType Gets or sets a Boolean value that specifies whether the view is the default view for the associated content type Declaration bool DefaultViewForContentType { get; set; } Property Value Boolean EditorModified Gets a Boolean value that indicates whether the view was modified in an HTML editor Declaration bool EditorModified { get; set; } Property Value Boolean Formats Specifies the definitions for column and row formatting that are used in a datasheet view Declaration string Formats { get; set; } Property Value String GridLayout An attribute of the view, specifies the quick edit layout Declaration string GridLayout { get; set; } Property Value String Hidden Gets or sets Hidden Declaration bool Hidden { get; set; } Property Value Boolean HtmlSchemaXml Gets the Html Schema Xml Declaration string HtmlSchemaXml { get; } Property Value String Id Gets the Id Declaration Guid Id { get; } Property Value Guid ImageUrl Specifies the server relative or absolute URL of the Image for the List View Declaration string ImageUrl { get; } Property Value String IncludeRootFolder Specifies if the Root Folder is included in the List View Declaration bool IncludeRootFolder { get; set; } Property Value Boolean JSLink An attribute of the view, specifies the Javascript files used for the view. Declaration string JSLink { get; set; } Property Value String ListViewXml Gets or sets List View Xml Declaration string ListViewXml { get; set; } Property Value String Method Specifies the view method for the list view Declaration string Method { get; set; } Property Value String MobileDefaultView Specifies whether the list view is the default for a mobile device Declaration bool MobileDefaultView { get; set; } Property Value Boolean MobileView Specifies whether the list view applies to a mobile device Declaration bool MobileView { get; set; } Property Value Boolean ModerationType Specifies the content approval type for the list view. A string that indicates the Content Approval type, which can be one of the following values: HideUnapproved -- Unapproved draft items are hidden from users who only have permission to read items. Contributor -- Pending and rejected items for the current user are displayed. Moderator -- Pending and rejected items for all users are displayed to users who have managed list permissions. Declaration string ModerationType { get; } Property Value String NewDocumentTemplates An attribute of the view, indicates what documents/templates are visible in \"New\" menu of a document library Declaration string NewDocumentTemplates { get; set; } Property Value String OrderedView Specifies whether users can reorder items through the user interface Declaration bool OrderedView { get; } Property Value Boolean Paged Specifies whether the list view supports displaying items across multiple pages Declaration bool Paged { get; set; } Property Value Boolean PageRenderType Gets the reason why the page is rendered in classic UX, or Modern if the page is in Modern UX Declaration ListPageRenderType PageRenderType { get; } Property Value ListPageRenderType PersonalView Specifies whether the view is a personal view or a public view Declaration bool PersonalView { get; } Property Value Boolean ReadOnlyView Specifies if the view is read-only Declaration bool ReadOnlyView { get; } Property Value Boolean RequiresClientIntegration Specifies whether this view requires client integration Declaration bool RequiresClientIntegration { get; } Property Value Boolean RowLimit Specifies the limit for the number of items that the list view will return per page Declaration int RowLimit { get; set; } Property Value Int32 Scope Specifies the recursive scope for the list view of a document library Declaration ViewScope Scope { get; set; } Property Value ViewScope ServerRelativeUrl Specifies the server relative URL of the list view page Declaration string ServerRelativeUrl { get; } Property Value String StyleId Specifies the identifier of the view style for the list view Declaration string StyleId { get; } Property Value String TabularView Gets or sets the TabularView attribute in the View Schema XML Declaration bool TabularView { get; set; } Property Value Boolean Threaded Gets a Boolean value that indicates whether the view is threaded Declaration bool Threaded { get; } Property Value Boolean Title Specifies the Display Name of the List View Declaration string Title { get; set; } Property Value String Toolbar Specifies the toolbar (CAML) for the list view Declaration string Toolbar { get; set; } Property Value String ToolbarTemplateName Specifies the name of the toolbar template that is used for the list view toolbar Declaration string ToolbarTemplateName { get; } Property Value String ViewData Specifies the view data for the list view Declaration string ViewData { get; set; } Property Value String ViewFields Gets or sets View Fields Declaration IViewFieldCollection ViewFields { get; } Property Value IViewFieldCollection ViewJoins Specifies the list joins that will be used by the list view Declaration string ViewJoins { get; set; } Property Value String ViewProjectedFields Specifies the projected fields that will be used by the list view Declaration string ViewProjectedFields { get; set; } Property Value String ViewQuery Specifies the CAML query that will be used by the list view Declaration string ViewQuery { get; set; } Property Value String ViewType Specifies the type of the view Declaration ViewType ViewType { get; } Property Value ViewType ViewType2 Gets or sets the ViewType2 Declaration ViewType2 ViewType2 { get; set; } Property Value ViewType2 Methods AddViewField(String) Adds a field to the current view Declaration void AddViewField(string internalFieldName) Parameters String internalFieldName Internal name of the field to add AddViewFieldAsync(String) Adds a field to the current view Declaration Task AddViewFieldAsync(string internalFieldName) Parameters String internalFieldName Internal name of the field to add Returns Task MoveViewFieldTo(String, Int32) Moves a view field to a new position in the view Declaration void MoveViewFieldTo(string internalFieldName, int newOrder) Parameters String internalFieldName Internal name of the view field to move Int32 newOrder New position MoveViewFieldToAsync(String, Int32) Moves a view field to a new position in the view Declaration Task MoveViewFieldToAsync(string internalFieldName, int newOrder) Parameters String internalFieldName Internal name of the view field to move Int32 newOrder New position Returns Task RemoveViewField(String) Removes a field from the current view Declaration void RemoveViewField(string internalFieldName) Parameters String internalFieldName Internal name of the field to remove RemoveViewFieldAsync(String) Removes a field from the current view Declaration Task RemoveViewFieldAsync(string internalFieldName) Parameters String internalFieldName Internal name of the field to remove Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IView Public interface to define a View object Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IView : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties Aggregations Specifies the aggregations displayed by the list view. The Aggregations property contains a CAML string. Declaration string Aggregations { get; set; } Property Value String AggregationsStatus Specifies whether the aggregations are shown in the list view Declaration string AggregationsStatus { get; set; } Property Value String All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object AssociatedContentTypeId Gets or sets Associated Content Type Id Declaration string AssociatedContentTypeId { get; set; } Property Value String BaseViewId Specifies the base view identifier of the list view Declaration string BaseViewId { get; } Property Value String CalendarViewStyles Gets or sets Calendar View Styles Declaration string CalendarViewStyles { get; set; } Property Value String ColumnWidth Gets or sets Column Width Declaration string ColumnWidth { get; set; } Property Value String CustomFormatter Gets or sets Custom Formatter Declaration string CustomFormatter { get; set; } Property Value String DefaultView Gets or sets a Boolean value that specifies whether the view is the default view Declaration bool DefaultView { get; set; } Property Value Boolean DefaultViewForContentType Gets or sets a Boolean value that specifies whether the view is the default view for the associated content type Declaration bool DefaultViewForContentType { get; set; } Property Value Boolean EditorModified Gets a Boolean value that indicates whether the view was modified in an HTML editor Declaration bool EditorModified { get; set; } Property Value Boolean Formats Specifies the definitions for column and row formatting that are used in a datasheet view Declaration string Formats { get; set; } Property Value String GridLayout An attribute of the view, specifies the quick edit layout Declaration string GridLayout { get; set; } Property Value String Hidden Gets or sets Hidden Declaration bool Hidden { get; set; } Property Value Boolean HtmlSchemaXml Gets the Html Schema Xml Declaration string HtmlSchemaXml { get; } Property Value String Id Gets the Id Declaration Guid Id { get; } Property Value Guid ImageUrl Specifies the server relative or absolute URL of the Image for the List View Declaration string ImageUrl { get; } Property Value String IncludeRootFolder Specifies if the Root Folder is included in the List View Declaration bool IncludeRootFolder { get; set; } Property Value Boolean JSLink An attribute of the view, specifies the Javascript files used for the view. Declaration string JSLink { get; set; } Property Value String ListViewXml Gets or sets List View Xml Declaration string ListViewXml { get; set; } Property Value String Method Specifies the view method for the list view Declaration string Method { get; set; } Property Value String MobileDefaultView Specifies whether the list view is the default for a mobile device Declaration bool MobileDefaultView { get; set; } Property Value Boolean MobileView Specifies whether the list view applies to a mobile device Declaration bool MobileView { get; set; } Property Value Boolean ModerationType Specifies the content approval type for the list view. A string that indicates the Content Approval type, which can be one of the following values: HideUnapproved -- Unapproved draft items are hidden from users who only have permission to read items. Contributor -- Pending and rejected items for the current user are displayed. Moderator -- Pending and rejected items for all users are displayed to users who have managed list permissions. Declaration string ModerationType { get; } Property Value String NewDocumentTemplates An attribute of the view, indicates what documents/templates are visible in \"New\" menu of a document library Declaration string NewDocumentTemplates { get; set; } Property Value String OrderedView Specifies whether users can reorder items through the user interface Declaration bool OrderedView { get; } Property Value Boolean Paged Specifies whether the list view supports displaying items across multiple pages Declaration bool Paged { get; set; } Property Value Boolean PageRenderType Gets the reason why the page is rendered in classic UX, or Modern if the page is in Modern UX Declaration ListPageRenderType PageRenderType { get; } Property Value ListPageRenderType PersonalView Specifies whether the view is a personal view or a public view Declaration bool PersonalView { get; } Property Value Boolean ReadOnlyView Specifies if the view is read-only Declaration bool ReadOnlyView { get; } Property Value Boolean RequiresClientIntegration Specifies whether this view requires client integration Declaration bool RequiresClientIntegration { get; } Property Value Boolean RowLimit Specifies the limit for the number of items that the list view will return per page Declaration int RowLimit { get; set; } Property Value Int32 Scope Specifies the recursive scope for the list view of a document library Declaration ViewScope Scope { get; set; } Property Value ViewScope ServerRelativeUrl Specifies the server relative URL of the list view page Declaration string ServerRelativeUrl { get; } Property Value String StyleId Specifies the identifier of the view style for the list view Declaration string StyleId { get; } Property Value String TabularView Gets or sets the TabularView attribute in the View Schema XML Declaration bool TabularView { get; set; } Property Value Boolean Threaded Gets a Boolean value that indicates whether the view is threaded Declaration bool Threaded { get; } Property Value Boolean Title Specifies the Display Name of the List View Declaration string Title { get; set; } Property Value String Toolbar Specifies the toolbar (CAML) for the list view Declaration string Toolbar { get; set; } Property Value String ToolbarTemplateName Specifies the name of the toolbar template that is used for the list view toolbar Declaration string ToolbarTemplateName { get; } Property Value String ViewData Specifies the view data for the list view Declaration string ViewData { get; set; } Property Value String ViewFields Gets or sets View Fields Declaration IViewFieldCollection ViewFields { get; } Property Value IViewFieldCollection ViewJoins Specifies the list joins that will be used by the list view Declaration string ViewJoins { get; set; } Property Value String ViewProjectedFields Specifies the projected fields that will be used by the list view Declaration string ViewProjectedFields { get; set; } Property Value String ViewQuery Specifies the CAML query that will be used by the list view Declaration string ViewQuery { get; set; } Property Value String ViewType Specifies the type of the view Declaration ViewType ViewType { get; } Property Value ViewType ViewType2 Gets or sets the ViewType2 Declaration ViewType2 ViewType2 { get; set; } Property Value ViewType2 Methods AddViewField(String) Adds a field to the current view Declaration void AddViewField(string internalFieldName) Parameters String internalFieldName Internal name of the field to add AddViewFieldAsync(String) Adds a field to the current view Declaration Task AddViewFieldAsync(string internalFieldName) Parameters String internalFieldName Internal name of the field to add Returns Task MoveViewFieldTo(String, Int32) Moves a view field to a new position in the view Declaration void MoveViewFieldTo(string internalFieldName, int newOrder) Parameters String internalFieldName Internal name of the view field to move Int32 newOrder New position MoveViewFieldToAsync(String, Int32) Moves a view field to a new position in the view Declaration Task MoveViewFieldToAsync(string internalFieldName, int newOrder) Parameters String internalFieldName Internal name of the view field to move Int32 newOrder New position Returns Task RemoveViewField(String) Removes a field from the current view Declaration void RemoveViewField(string internalFieldName) Parameters String internalFieldName Internal name of the field to remove RemoveViewFieldAsync(String) Removes a field from the current view Declaration Task RemoveViewFieldAsync(string internalFieldName) Parameters String internalFieldName Internal name of the field to remove Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IViewCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IViewCollection.html", @@ -2332,7 +2332,7 @@ "api/PnP.Core.Model.SharePoint.IWeb.html": { "href": "api/PnP.Core.Model.SharePoint.IWeb.html", "title": "Interface IWeb | PnP Core SDK", - "keywords": "Interface IWeb Public interface to define a Web object of SharePoint Online Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() IDataModelSupportingGetChanges.GetChangesAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChanges(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(ChangeQueryOptions) ISecurableObject.RoleAssignments ISecurableObject.HasUniqueRoleAssignments ISecurableObject.BreakRoleInheritance(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceAsync(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatch(Batch, Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatchAsync(Batch, Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatch(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatchAsync(Boolean, Boolean) ISecurableObject.ResetRoleInheritance() ISecurableObject.ResetRoleInheritanceAsync() ISecurableObject.ResetRoleInheritanceBatch(Batch) ISecurableObject.ResetRoleInheritanceBatchAsync(Batch) ISecurableObject.ResetRoleInheritanceBatch() ISecurableObject.ResetRoleInheritanceBatchAsync() ISecurableObject.GetRoleDefinitions(Int32) ISecurableObject.GetRoleDefinitionsAsync(Int32) ISecurableObject.AddRoleDefinitions(Int32, String[]) ISecurableObject.AddRoleDefinitionsAsync(Int32, String[]) ISecurableObject.AddRoleDefinition(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionAsync(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatch(Batch, Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatch(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatchAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitions(Int32, String[]) ISecurableObject.RemoveRoleDefinitionsAsync(Int32, String[]) ISecurableObject.RemoveRoleDefinition(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatch(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatchAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatch(Batch, Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IWeb : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IDataModelSupportingGetChanges, ISecurableObject, IQueryableDataModel Properties AccessRequestListUrl Gets the URL of the access request list to the current site. Declaration string AccessRequestListUrl { get; } Property Value String AccessRequestSiteDescription Gets or sets the description of the access request to this site. Declaration string AccessRequestSiteDescription { get; set; } Property Value String All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object AllowAutomaticASPXPageIndexing Gets a value that specifies whether the automatic ASPX page indexed is allowed. Declaration bool AllowAutomaticASPXPageIndexing { get; set; } Property Value Boolean AllowCreateDeclarativeWorkflowForCurrentUser Gets a value that specifies whether the current user is allowed to create declarative workflow on this site. Declaration bool AllowCreateDeclarativeWorkflowForCurrentUser { get; set; } Property Value Boolean AllowDesignerForCurrentUser Gets a value that specifies whether the current user is allowed to use a designer application to customize this site. Declaration bool AllowDesignerForCurrentUser { get; set; } Property Value Boolean AllowMasterPageEditingForCurrentUser Gets a value that specifies whether the current user is allowed to edit the master page. Declaration bool AllowMasterPageEditingForCurrentUser { get; } Property Value Boolean AllowRevertFromTemplateForCurrentUser Gets a value that specifies whether the current user is allowed to revert the site to a default site template. Declaration bool AllowRevertFromTemplateForCurrentUser { get; } Property Value Boolean AllowRssFeeds Gets a value that specifies whether the site allows RSS feeds. Declaration bool AllowRssFeeds { get; } Property Value Boolean AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser Gets a value that specifies whether the current user is allowed to save declarative workflows as template. Declaration bool AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser { get; } Property Value Boolean AllowSavePublishDeclarativeWorkflowForCurrentUser Gets a value that specifies whether the current user is allowed to publish a declarative workflow. Declaration bool AllowSavePublishDeclarativeWorkflowForCurrentUser { get; } Property Value Boolean AllProperties Gets a collection of metadata for the Web site. Declaration IPropertyValues AllProperties { get; } Property Value IPropertyValues AlternateCssUrl The AlternateCSS of the Site, optional attribute. Declaration string AlternateCssUrl { get; set; } Property Value String AppInstanceId The instance Id of the App Instance that this website represents. Declaration Guid AppInstanceId { get; } Property Value Guid AssociatedMemberGroup Associated SharePoint Member group Declaration ISharePointGroup AssociatedMemberGroup { get; } Property Value ISharePointGroup AssociatedOwnerGroup Associated SharePoint owner group Declaration ISharePointGroup AssociatedOwnerGroup { get; } Property Value ISharePointGroup AssociatedVisitorGroup Associated SharePoint Visitor group Declaration ISharePointGroup AssociatedVisitorGroup { get; } Property Value ISharePointGroup Author Gets the web's author Declaration ISharePointUser Author { get; } Property Value ISharePointUser AvailableContentTypes Gets the collection of all content types that apply to the current scope, including those of the current Web site, as well as any parent Web sites. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IContentTypeCollection AvailableContentTypes { get; } Property Value IContentTypeCollection AvailableFields Gets a value that specifies the collection of all fields available for the current scope, including those of the current site, as well as any parent sites. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFieldCollection AvailableFields { get; } Property Value IFieldCollection CommentsOnSitePagesDisabled Defines whether the comments on site pages are disabled or not Declaration bool CommentsOnSitePagesDisabled { get; set; } Property Value Boolean ContainsConfidentialInfo Gets a boolean value that specifies whether the site contains highly confidential information. If the tenant settings don't allow tagging sites as confidential, this property will always return false. Declaration bool ContainsConfidentialInfo { get; set; } Property Value Boolean ContentTypes Collection of content types in the current Web object Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IContentTypeCollection ContentTypes { get; } Property Value IContentTypeCollection Created Gets a value that specifies when the site was created. Declaration DateTime Created { get; } Property Value DateTime CurrentUser Gets the current user in the current context Declaration ISharePointUser CurrentUser { get; } Property Value ISharePointUser CustomMasterUrl The Custom MasterPage Url of the Site, optional attribute. Declaration string CustomMasterUrl { get; set; } Property Value String DefaultNewPageTemplateId The id of the default new page template. Use SetDefaultNewPageTemplateId to set the value. Declaration Guid DefaultNewPageTemplateId { get; set; } Property Value Guid Description The Description of the Site, optional attribute. Declaration string Description { get; set; } Property Value String DesignPackageId Gets or sets the design package Id of this site. Declaration Guid DesignPackageId { get; set; } Property Value Guid DisableAppViews Defines whether disable PowerApps for the current web Declaration bool DisableAppViews { get; set; } Property Value Boolean DisableFlows Defines whether disable flows for the current web Declaration bool DisableFlows { get; set; } Property Value Boolean DisableRecommendedItems Gets or sets whether the recommended items are disabled on this site. Declaration bool DisableRecommendedItems { get; set; } Property Value Boolean DocumentLibraryCalloutOfficeWebAppPreviewersDisabled Determines if the Document Library Callout's WAC previewers are enabled or not. Declaration bool DocumentLibraryCalloutOfficeWebAppPreviewersDisabled { get; } Property Value Boolean EffectiveBasePermissions Get's the permission levels set on this web Declaration IBasePermissions EffectiveBasePermissions { get; } Property Value IBasePermissions EnableMinimalDownload Gets or sets a Boolean value that specifies whether the Web site should use Minimal Download Strategy. Declaration bool EnableMinimalDownload { get; set; } Property Value Boolean EventReceivers Event Receivers defined in this web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IEventReceiverDefinitionCollection EventReceivers { get; } Property Value IEventReceiverDefinitionCollection ExcludeFromOfflineClient Defines whether to exclude the web from offline client Declaration bool ExcludeFromOfflineClient { get; set; } Property Value Boolean Features Collection of features enabled for the web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFeatureCollection Features { get; } Property Value IFeatureCollection Fields Collection of fields in the current Web object Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFieldCollection Fields { get; } Property Value IFieldCollection Folders Collection of folders in the current Web object Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFolderCollection Folders { get; } Property Value IFolderCollection FooterEmphasis Gets or sets the value of the footer emphasis. Declaration FooterVariantThemeType FooterEmphasis { get; set; } Property Value FooterVariantThemeType FooterEnabled Gets or sets a value that specifies whether the footer is enabled on the site. Declaration bool FooterEnabled { get; set; } Property Value Boolean FooterLayout Gets or sets the value of the footer layout. Declaration FooterLayoutType FooterLayout { get; set; } Property Value FooterLayoutType HeaderEmphasis Gets or sets the value of the header emphasis. Declaration VariantThemeType HeaderEmphasis { get; set; } Property Value VariantThemeType HeaderLayout Gets or sets the value of the header layout. Declaration HeaderLayoutType HeaderLayout { get; set; } Property Value HeaderLayoutType HideTitleInHeader Gets or sets a value that specifies whether the title in header is hidden on the site. Declaration bool HideTitleInHeader { get; set; } Property Value Boolean HorizontalQuickLaunch Defines whether to enable the Horizontal QuickLaunch for the current web Declaration bool HorizontalQuickLaunch { get; set; } Property Value Boolean Id The Unique ID of the Web object Declaration Guid Id { get; } Property Value Guid IsHomepageModernized Gets a value that indicates whether the homepage is modernized. Declaration bool IsHomepageModernized { get; } Property Value Boolean IsMultilingual Defines whether to enable Multilingual capabilities for the current web Declaration bool IsMultilingual { get; set; } Property Value Boolean IsProvisioningComplete Gets a value that indicates whether the provisioning is complete. Declaration bool IsProvisioningComplete { get; } Property Value Boolean IsRevertHomepageLinkHidden Gets or sets a value that specifies whether the link to revert homepage is hidden. Declaration bool IsRevertHomepageLinkHidden { get; set; } Property Value Boolean Language Gets a value that specifies the LCID for the language that is used on the site. Declaration int Language { get; } Property Value Int32 LastItemModifiedDate Gets a value that specifies when an item was last modified in the site. Declaration DateTime LastItemModifiedDate { get; } Property Value DateTime LastItemUserModifiedDate Gets a value that specifies when an item was last modified by user in the site. Declaration DateTime LastItemUserModifiedDate { get; } Property Value DateTime Lists Collection of lists in the current Web object. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IListCollection Lists { get; } Property Value IListCollection LogoAlignment Gets or sets the logo alignment of the site. Declaration LogoAlignment LogoAlignment { get; set; } Property Value LogoAlignment MasterUrl Gets or sets the URL of the master page that is used for the website. Declaration string MasterUrl { get; set; } Property Value String MegaMenuEnabled Gets or sets a value that specifies whether the megamenu is enabled on the site. Declaration bool MegaMenuEnabled { get; set; } Property Value Boolean MembersCanShare Defines whether members can share content from the current web Declaration bool MembersCanShare { get; set; } Property Value Boolean NavAudienceTargetingEnabled Gets or sets a value that specifies whether the audience targeting is enabled on the navigation of the site. Declaration bool NavAudienceTargetingEnabled { get; set; } Property Value Boolean Navigation Navigation on the Web Declaration INavigation Navigation { get; } Property Value INavigation NextStepsFirstRunEnabled Gets or sets a value that specifies if the Next steps pane should open automatically as a first run experience when someone visits the site. You can only enable the experience for sites created on or after January 1, 2020 Declaration bool NextStepsFirstRunEnabled { get; set; } Property Value Boolean NoCrawl Defines whether the site has to be crawled or not Declaration bool NoCrawl { get; set; } Property Value Boolean NotificationsInOneDriveForBusinessEnabled Returns if true if the tenant allowed to send push notifications in OneDrive for Business. Declaration bool NotificationsInOneDriveForBusinessEnabled { get; } Property Value Boolean NotificationsInSharePointEnabled Returns if true if the tenant allowed to send push notifications in SharePoint. Declaration bool NotificationsInSharePointEnabled { get; } Property Value Boolean ObjectCacheEnabled Gets or sets a value that specifies whether the object cache is enabled on the site. Declaration bool ObjectCacheEnabled { get; set; } Property Value Boolean OverwriteTranslationsOnChange Defines whether to OverwriteTranslationsOnChange on change for the current web Declaration bool OverwriteTranslationsOnChange { get; set; } Property Value Boolean PreviewFeaturesEnabled Indicates whether the tenant administrator has chosen to disable the Preview Features. Default is true. Declaration bool PreviewFeaturesEnabled { get; } Property Value Boolean PrimaryColor Gets or sets the primary color of the site. Declaration string PrimaryColor { get; } Property Value String QuickLaunchEnabled Enables or disables the QuickLaunch for the site Declaration bool QuickLaunchEnabled { get; set; } Property Value Boolean RecycleBin Gets the recycle bin of the website. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IRecycleBinItemCollection RecycleBin { get; } Property Value IRecycleBinItemCollection RecycleBinEnabled Gets or sets a value that specifies whether the Recycle Bin is enabled. Declaration bool RecycleBinEnabled { get; set; } Property Value Boolean RegionalSettings Regional settings configured for this web Declaration IRegionalSettings RegionalSettings { get; } Property Value IRegionalSettings RequestAccessEmail The email address to which any access request will be sent Declaration string RequestAccessEmail { get; set; } Property Value String RoleDefinitions Role Definitions defined in this web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IRoleDefinitionCollection RoleDefinitions { get; } Property Value IRoleDefinitionCollection RootFolder Gets the root folder for the website. Declaration IFolder RootFolder { get; } Property Value IFolder SaveSiteAsTemplateEnabled Gets or sets a Boolean value that specifies whether the Web site can be saved as a site template. Declaration bool SaveSiteAsTemplateEnabled { get; set; } Property Value Boolean SearchBoxInNavBar Define if the suitebar search box should show or not Declaration SearchBoxInNavBar SearchBoxInNavBar { get; set; } Property Value SearchBoxInNavBar SearchBoxPlaceholderText Search placeholder text for search box in navbar - overrides default placeholder text if set, returns null if not set. Declaration string SearchBoxPlaceholderText { get; set; } Property Value String SearchScope Defines the SearchScope for the site Declaration SearchScope SearchScope { get; set; } Property Value SearchScope ServerRelativeUrl Gets the server relative URL of the current site. Declaration string ServerRelativeUrl { get; } Property Value String SiteGroups Gets the collection of all groups that belong to the site collection. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ISharePointGroupCollection SiteGroups { get; } Property Value ISharePointGroupCollection SiteLogoDescription Gets or sets the description of the Web site logo. Declaration string SiteLogoDescription { get; set; } Property Value String SiteLogoUrl Gets or sets the server-relative URL of the Web site logo. This can also contain an absolute URL to the logo. Declaration string SiteLogoUrl { get; set; } Property Value String SiteUserInfoList Gets the UserInfo list of the site collection that contains the website. Declaration IList SiteUserInfoList { get; } Property Value IList SiteUsers Gets the collection of all users that belong to the site collection. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ISharePointUserCollection SiteUsers { get; } Property Value ISharePointUserCollection SupportedUILanguageIds List of languages (expressed via their id) that this site supports Declaration List SupportedUILanguageIds { get; } Property Value PnP.Core.Model.SharePoint.List < Int32 > SyndicationEnabled Gets or sets a value that specifies whether the RSS feeds are enabled on the site. Declaration bool SyndicationEnabled { get; set; } Property Value Boolean TenantAdminMembersCanShare Gets or sets a value that specifies how the tenant admin members can share. Declaration SharingState TenantAdminMembersCanShare { get; } Property Value SharingState ThemeData Get JSON serialized ThemeData for the current web. Declaration string ThemeData { get; } Property Value String ThirdPartyMdmEnabled Gets a value that indicates whether third party MDM (Mobile Device Management) is enabled on the site. Declaration bool ThirdPartyMdmEnabled { get; } Property Value Boolean Title The Title of the Site, optional attribute. Declaration string Title { get; set; } Property Value String TreeViewEnabled Gets or sets value that specifies whether the tree view is enabled on the site. Declaration bool TreeViewEnabled { get; set; } Property Value Boolean Url The URL of the Web object Declaration Uri Url { get; } Property Value Uri UseAccessRequestDefault Determines if we need to use the default access request If this value is True we send access requests to owner/owner's group If this value is False we send access requests to the configured AccessRequestEmail Declaration bool UseAccessRequestDefault { get; } Property Value Boolean UserCustomActions Gets a value that specifies the collection of user custom actions for the site. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IUserCustomActionCollection UserCustomActions { get; } Property Value IUserCustomActionCollection Webs Collection of webs in this current web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IWebCollection Webs { get; } Property Value IWebCollection WebTemplate Gets the name of the site definition or site template that was used to create the site. Declaration string WebTemplate { get; } Property Value String WebTemplateConfiguration Gets the web template configuration of the site. Declaration string WebTemplateConfiguration { get; } Property Value String WebTemplatesGalleryFirstRunEnabled Gets or sets a value that specifies if the web templates experience should open automatically as a first run experience after the site was created Declaration bool WebTemplatesGalleryFirstRunEnabled { get; set; } Property Value Boolean WelcomePage Specifies a string that contains the site-relative URL to which users are redirected when web is browsed (typically the site's home page). Declaration string WelcomePage { get; } Property Value String Methods AddIndexedProperty(String) Adds a web property as an indexed property Declaration bool AddIndexedProperty(string propertyName) Parameters String propertyName The property name Returns Boolean True if it was successfully added or if it is already exists otherwise false Remarks The property must already exist as metadata of the Web AddIndexedPropertyAsync(String) Adds a web property as an indexed property Declaration Task AddIndexedPropertyAsync(string propertyName) Parameters String propertyName The property name Returns Task < Boolean > True if it was successfully added or if it is already exists otherwise false Remarks The property must already exist as metadata of the Web AsSyntexContentCenter() Returns the current web as ISyntexContentCenter if the web is a Syntex Content Center, null is returned otherwise Declaration ISyntexContentCenter AsSyntexContentCenter() Returns ISyntexContentCenter The current web as ISyntexContentCenter AsSyntexContentCenterAsync() Returns the current web as ISyntexContentCenter if the web is a Syntex Content Center, null is returned otherwise Declaration Task AsSyntexContentCenterAsync() Returns Task < ISyntexContentCenter > The current web as ISyntexContentCenter CheckIfUserHasPermissions(String, PermissionKind) Checks if a user has a specific kind of permissions to a web Declaration bool CheckIfUserHasPermissions(string userPrincipalName, PermissionKind permissionKind) Parameters String userPrincipalName Login name of the user you wish to check if he has a specific permission PermissionKind permissionKind Permission kind to check Returns Boolean Boolean that says if the user has permissions or not CheckIfUserHasPermissionsAsync(String, PermissionKind) Checks if a user has a specific kind of permissions to a web Declaration Task CheckIfUserHasPermissionsAsync(string userPrincipalName, PermissionKind permissionKind) Parameters String userPrincipalName Login name of the user you wish to check if he has a specific permission PermissionKind permissionKind Permission kind to check Returns Task < Boolean > Boolean that says if the user has permissions or not EnsureEveryoneExceptExternalUsers() Retrieves everyone except external users and ensures the user in the current web Declaration ISharePointUser EnsureEveryoneExceptExternalUsers() Returns ISharePointUser The ensured ISharePointUser EnsureEveryoneExceptExternalUsersAsync() Retrieves everyone except external users and ensures the user in the current web Declaration Task EnsureEveryoneExceptExternalUsersAsync() Returns Task < ISharePointUser > The ensured ISharePointUser EnsureMultilingual(List) Ensure a site can support multilingual (pages) for the passed along languages Declaration void EnsureMultilingual(List requiredLanguageIds) Parameters PnP.Core.Model.SharePoint.List < Int32 > requiredLanguageIds List of langauges to support for multilingual on this site. See https://capacreative.co.uk/resources/reference-sharepoint-online-languages-ids/ for information on the language ids EnsureMultilingualAsync(List) Ensure a site can support multilingual (pages) for the passed along languages Declaration Task EnsureMultilingualAsync(List requiredLanguageIds) Parameters PnP.Core.Model.SharePoint.List < Int32 > requiredLanguageIds List of langauges to support for multilingual on this site. See https://capacreative.co.uk/resources/reference-sharepoint-online-languages-ids/ for information on the language ids Returns Task EnsurePageScheduling() Ensures that page publishing can work for this site. Page scheduling only works for the root web of a site collection Declaration void EnsurePageScheduling() EnsurePageSchedulingAsync() Ensures that page publishing can work for this site. Page scheduling only works for the root web of a site collection Declaration Task EnsurePageSchedulingAsync() Returns Task EnsureUser(String) Ensures the given users exists Declaration ISharePointUser EnsureUser(string userPrincipalName) Parameters String userPrincipalName UserPrincipalName value of the user to verify Returns ISharePointUser The ensured ISharePointUser EnsureUserAsync(String) Ensures the given users exists Declaration Task EnsureUserAsync(string userPrincipalName) Parameters String userPrincipalName UserPrincipalName value of the user to verify Returns Task < ISharePointUser > The ensured ISharePointUser EnsureUserBatch(Batch, String) Ensures the given users exists Declaration ISharePointUser EnsureUserBatch(Batch batch, string userPrincipalName) Parameters Batch batch Batch to add this request to String userPrincipalName UserPrincipalName value of the user to verify Returns ISharePointUser The ensured ISharePointUser EnsureUserBatch(String) Ensures the given users exists Declaration ISharePointUser EnsureUserBatch(string userPrincipalName) Parameters String userPrincipalName UserPrincipalName value of the user to verify Returns ISharePointUser The ensured ISharePointUser EnsureUserBatchAsync(Batch, String) Ensures the given users exists Declaration Task EnsureUserBatchAsync(Batch batch, string userPrincipalName) Parameters Batch batch Batch to add this request to String userPrincipalName UserPrincipalName value of the user to verify Returns Task < ISharePointUser > The ensured ISharePointUser EnsureUserBatchAsync(String) Ensures the given users exists Declaration Task EnsureUserBatchAsync(string userPrincipalName) Parameters String userPrincipalName UserPrincipalName value of the user to verify Returns Task < ISharePointUser > The ensured ISharePointUser GetBrandingManager() Returns the branding manager which can be used to change the look of the web Declaration IBrandingManager GetBrandingManager() Returns IBrandingManager An IBrandingManager instance GetCurrentUser() Get's the current logged on user making the request to SharePoint Declaration ISharePointUser GetCurrentUser() Returns ISharePointUser The current ISharePointUser GetCurrentUserAsync() Get's the current logged on user making the request to SharePoint Declaration Task GetCurrentUserAsync() Returns Task < ISharePointUser > The current ISharePointUser GetCurrentUserBatch() Get's the current logged on user making the request to SharePoint Declaration ISharePointUser GetCurrentUserBatch() Returns ISharePointUser The current ISharePointUser GetCurrentUserBatch(Batch) Get's the current logged on user making the request to SharePoint Declaration ISharePointUser GetCurrentUserBatch(Batch batch) Parameters Batch batch Batch to add this request to Returns ISharePointUser The current ISharePointUser GetCurrentUserBatchAsync() Get's the current logged on user making the request to SharePoint Declaration Task GetCurrentUserBatchAsync() Returns Task < ISharePointUser > The current ISharePointUser GetCurrentUserBatchAsync(Batch) Get's the current logged on user making the request to SharePoint Declaration Task GetCurrentUserBatchAsync(Batch batch) Parameters Batch batch Batch to add this request to Returns Task < ISharePointUser > The current ISharePointUser GetFileById(Guid, Expression>[]) Get a file in the current web from its unique id. Declaration IFile GetFileById(Guid uniqueFileId, params Expression>[] expressions) Parameters Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByIdAsync(Guid, Expression>[]) Get a file in the current web from its unique id. Declaration Task GetFileByIdAsync(Guid uniqueFileId, params Expression>[] expressions) Parameters Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByIdBatch(Guid, Expression>[]) Get a file in the current web from its unique id via batch. Declaration IFile GetFileByIdBatch(Guid uniqueFileId, params Expression>[] expressions) Parameters Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByIdBatch(Batch, Guid, Expression>[]) Get a file in the current web from its unique id via batch. Declaration IFile GetFileByIdBatch(Batch batch, Guid uniqueFileId, params Expression>[] expressions) Parameters Batch batch Batch to add this request to Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByIdBatchAsync(Guid, Expression>[]) Get a file in the current web from its unique id via batch. Declaration Task GetFileByIdBatchAsync(Guid uniqueFileId, params Expression>[] expressions) Parameters Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByIdBatchAsync(Batch, Guid, Expression>[]) Get a file in the current web from its unique id via batch. Declaration Task GetFileByIdBatchAsync(Batch batch, Guid uniqueFileId, params Expression>[] expressions) Parameters Batch batch Batch to add this request to Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByLink(String, Expression>[]) Get's a file from a given link (sharing link, path to file) Declaration IFile GetFileByLink(string link, params Expression>[] expressions) Parameters String link Link pointing to a file Expression < Func < IFile , Object >>[] expressions Properties to load for the requested IFile Returns IFile IFile reference when the file could be found, exception otherwise GetFileByLinkAsync(String, Expression>[]) Get's a file from a given link (sharing link, path to file) Declaration Task GetFileByLinkAsync(string link, params Expression>[] expressions) Parameters String link Link pointing to a file Expression < Func < IFile , Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > IFile reference when the file could be found, exception otherwise GetFileByServerRelativeUrl(String, Expression>[]) Get a file in the current web from its server relative URL. Declaration IFile GetFileByServerRelativeUrl(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByServerRelativeUrlAsync(String, Expression>[]) Get a file in the current web from its server relative URL. Declaration Task GetFileByServerRelativeUrlAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByServerRelativeUrlBatch(Batch, String, Expression>[]) Get a file in the current web from its server relative URL via batch. Declaration IFile GetFileByServerRelativeUrlBatch(Batch batch, string serverRelativeUrl, params Expression>[] expressions) Parameters Batch batch Batch to add this request to String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByServerRelativeUrlBatch(String, Expression>[]) Get a file in the current web from its server relative URL via batch. Declaration IFile GetFileByServerRelativeUrlBatch(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByServerRelativeUrlBatchAsync(Batch, String, Expression>[]) Get a file in the current web from its server relative URL via batch. Declaration Task GetFileByServerRelativeUrlBatchAsync(Batch batch, string serverRelativeUrl, params Expression>[] expressions) Parameters Batch batch Batch to add this request to String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByServerRelativeUrlBatchAsync(String, Expression>[]) Get a file in the current web from its server relative URL via batch. Declaration Task GetFileByServerRelativeUrlBatchAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByServerRelativeUrlOrDefault(String, Expression>[]) Get a file in the current web from its server relative URL, it not available null will be returned Declaration IFile GetFileByServerRelativeUrlOrDefault(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get or null if the file was not available GetFileByServerRelativeUrlOrDefaultAsync(String, Expression>[]) Get a file in the current web from its server relative URL, it not available null will be returned Declaration Task GetFileByServerRelativeUrlOrDefaultAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get or null if the file was not available GetFolderById(Guid, Expression>[]) Get a folder in the current web from its id. Declaration IFolder GetFolderById(Guid folderId, params Expression>[] expressions) Parameters Guid folderId The id of the folder to get. Expression < Func < IFolder , Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByIdAsync(Guid, Expression>[]) Get a folder in the current web from its id. Declaration Task GetFolderByIdAsync(Guid folderId, params Expression>[] expressions) Parameters Guid folderId The id of the folder to get. Expression < Func < IFolder , Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByIdBatch(Guid, Expression>[]) Get a folder in the current web from its id via batch. Declaration IFolder GetFolderByIdBatch(Guid folderId, params Expression>[] expressions) Parameters Guid folderId The id of the folder to get. Expression < Func < IFolder , Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByIdBatch(Batch, Guid, Expression>[]) Get a folder in the current web from its id via batch. Declaration IFolder GetFolderByIdBatch(Batch batch, Guid folderId, params Expression>[] expressions) Parameters Batch batch Batch to add this request to Guid folderId The id of the folder to get. Expression < Func < IFolder , Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByIdBatchAsync(Guid, Expression>[]) Get a folder in the current web from its id via batch. Declaration Task GetFolderByIdBatchAsync(Guid folderId, params Expression>[] expressions) Parameters Guid folderId The id of the folder to get. Expression < Func < IFolder , Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByIdBatchAsync(Batch, Guid, Expression>[]) Get a folder in the current web from its id via batch. Declaration Task GetFolderByIdBatchAsync(Batch batch, Guid folderId, params Expression>[] expressions) Parameters Batch batch Batch to add this request to Guid folderId The id of the folder to get. Expression < Func < IFolder , Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByServerRelativeUrl(String, Expression>[]) Get a folder in the current web from its server relative URL. Declaration IFolder GetFolderByServerRelativeUrl(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByServerRelativeUrlAsync(String, Expression>[]) Get a folder in the current web from its server relative URL. Declaration Task GetFolderByServerRelativeUrlAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByServerRelativeUrlBatch(Batch, String, Expression>[]) Get a folder in the current web from its server relative URL via batch. Declaration IFolder GetFolderByServerRelativeUrlBatch(Batch batch, string serverRelativeUrl, params Expression>[] expressions) Parameters Batch batch Batch to add this request to String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByServerRelativeUrlBatch(String, Expression>[]) Get a folder in the current web from its server relative URL via batch. Declaration IFolder GetFolderByServerRelativeUrlBatch(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByServerRelativeUrlBatchAsync(Batch, String, Expression>[]) Get a folder in the current web from its server relative URL via batch. Declaration Task GetFolderByServerRelativeUrlBatchAsync(Batch batch, string serverRelativeUrl, params Expression>[] expressions) Parameters Batch batch Batch to add this request to String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByServerRelativeUrlBatchAsync(String, Expression>[]) Get a folder in the current web from its server relative URL via batch. Declaration Task GetFolderByServerRelativeUrlBatchAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetPages(String) Gets the modern pages of this site, optionally scoped down via a filter Declaration List GetPages(string pageName = null) Parameters String pageName Page name to filter on, uses a \"starts with\" filter Returns PnP.Core.Model.SharePoint.List < IPage > One of more modern pages GetPagesAsync(String) Gets the modern pages of this site, optionally scoped down via a filter Declaration Task> GetPagesAsync(string pageName = null) Parameters String pageName Page name to filter on, uses a \"starts with\" filter Returns Task < PnP.Core.Model.SharePoint.List < IPage >> One of more modern pages GetRecycleBinItemsByQuery(RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration IRecycleBinItemCollection GetRecycleBinItemsByQuery(RecycleBinQueryOptions options) Parameters RecycleBinQueryOptions options Recycle bin search criteria Returns IRecycleBinItemCollection A list containing zero or more recycle bin items GetRecycleBinItemsByQueryAsync(RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration Task GetRecycleBinItemsByQueryAsync(RecycleBinQueryOptions options) Parameters RecycleBinQueryOptions options Recycle bin search criteria Returns Task < IRecycleBinItemCollection > A list containing zero or more recycle bin items GetRecycleBinItemsByQueryBatch(RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration IRecycleBinItemCollection GetRecycleBinItemsByQueryBatch(RecycleBinQueryOptions options) Parameters RecycleBinQueryOptions options Recycle bin search criteria Returns IRecycleBinItemCollection A list containing zero or more recycle bin items GetRecycleBinItemsByQueryBatch(Batch, RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration IRecycleBinItemCollection GetRecycleBinItemsByQueryBatch(Batch batch, RecycleBinQueryOptions options) Parameters Batch batch Batch to add this request to RecycleBinQueryOptions options Recycle bin search criteria Returns IRecycleBinItemCollection A list containing zero or more recycle bin items GetRecycleBinItemsByQueryBatchAsync(RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration Task GetRecycleBinItemsByQueryBatchAsync(RecycleBinQueryOptions options) Parameters RecycleBinQueryOptions options Recycle bin search criteria Returns Task < IRecycleBinItemCollection > A list containing zero or more recycle bin items GetRecycleBinItemsByQueryBatchAsync(Batch, RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration Task GetRecycleBinItemsByQueryBatchAsync(Batch batch, RecycleBinQueryOptions options) Parameters Batch batch Batch to add this request to RecycleBinQueryOptions options Recycle bin search criteria Returns Task < IRecycleBinItemCollection > A list containing zero or more recycle bin items GetSearchConfigurationManagedProperties() Gets the managed properties from the search configuration of this web Declaration List GetSearchConfigurationManagedProperties() Returns PnP.Core.Model.SharePoint.List < IManagedProperty > List of managed properties GetSearchConfigurationManagedPropertiesAsync() Gets the managed properties from the search configuration of this web Declaration Task> GetSearchConfigurationManagedPropertiesAsync() Returns Task < PnP.Core.Model.SharePoint.List < IManagedProperty >> List of managed properties GetSearchConfigurationXml() Gets the search configuration of the web Declaration string GetSearchConfigurationXml() Returns String Search configuration XML GetSearchConfigurationXmlAsync() Gets the search configuration of the web Declaration Task GetSearchConfigurationXmlAsync() Returns Task < String > Search configuration XML GetUserById(Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUser(String) if you want to create the user if it does not yet exist Declaration ISharePointUser GetUserById(int userId) Parameters Int32 userId Id of the user to get Returns ISharePointUser The found user as ISharePointPrincipal GetUserByIdAsync(Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserAsync(String) if you want to create the user if it does not yet exist Declaration Task GetUserByIdAsync(int userId) Parameters Int32 userId Id of the user to get Returns Task < ISharePointUser > The found user as ISharePointPrincipal GetUserByIdBatch(Batch, Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserBatch(String) if you want to create the user if it does not yet exist Declaration ISharePointUser GetUserByIdBatch(Batch batch, int userId) Parameters Batch batch Batch to add this request to Int32 userId Id of the user to get Returns ISharePointUser The found user as ISharePointPrincipal GetUserByIdBatch(Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserBatch(String) if you want to create the user if it does not yet exist Declaration ISharePointUser GetUserByIdBatch(int userId) Parameters Int32 userId Id of the user to get Returns ISharePointUser The found user as ISharePointPrincipal GetUserByIdBatchAsync(Batch, Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserBatchAsync(String) if you want to create the user if it does not yet exist Declaration Task GetUserByIdBatchAsync(Batch batch, int userId) Parameters Batch batch Batch to add this request to Int32 userId Id of the user to get Returns Task < ISharePointUser > The found user as ISharePointPrincipal GetUserByIdBatchAsync(Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserBatchAsync(String) if you want to create the user if it does not yet exist Declaration Task GetUserByIdBatchAsync(int userId) Parameters Int32 userId Id of the user to get Returns Task < ISharePointUser > The found user as ISharePointPrincipal GetUserEffectivePermissions(String) Gets the user effective permissions of a user for a web Declaration IBasePermissions GetUserEffectivePermissions(string userPrincipalName) Parameters String userPrincipalName Login name of the user you wish to retrieve the permissions of Returns IBasePermissions Base permissions object that contains the High and the Low permissions GetUserEffectivePermissionsAsync(String) Gets the user effective permissions of a user for a web Declaration Task GetUserEffectivePermissionsAsync(string userPrincipalName) Parameters String userPrincipalName Login name of the user you wish to retrieve the permissions of Returns Task < IBasePermissions > Base permissions object that contains the High and the Low permissions GetVivaDashboard() Gets Viva Connections dashboard. If there is no dashboard configured, returns null Declaration IVivaDashboard GetVivaDashboard() Returns IVivaDashboard Viva Dashboard or null GetVivaDashboardAsync() Gets Viva Connections dashboard. If there is no dashboard configured, returns null Declaration Task GetVivaDashboardAsync() Returns Task < IVivaDashboard > Viva Dashboard or null GetWebTemplateByName(String, Int32, Boolean) Return a specific web template based by a name Declaration IWebTemplate GetWebTemplateByName(string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters String name Name of the template to retrieve Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IWebTemplate The template with the specified name, if available GetWebTemplateByNameAsync(String, Int32, Boolean) Return a specific web template based by a name Declaration Task GetWebTemplateByNameAsync(string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters String name Name of the template to retrieve Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IWebTemplate > The template with the specified name, if available GetWebTemplateByNameBatch(Batch, String, Int32, Boolean) Return a specific web template based by a name Declaration IBatchSingleResult GetWebTemplateByNameBatch(Batch batch, string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters Batch batch Batch to add this request to String name Name of the template to retrieve Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IBatchSingleResult < IWebTemplate > The template with the specified name, if available GetWebTemplateByNameBatch(String, Int32, Boolean) Return a specific web template based by a name Declaration IBatchSingleResult GetWebTemplateByNameBatch(string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters String name Name of the template to retrieve Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IBatchSingleResult < IWebTemplate > The template with the specified name, if available GetWebTemplateByNameBatchAsync(Batch, String, Int32, Boolean) Return a specific web template based by a name Declaration Task> GetWebTemplateByNameBatchAsync(Batch batch, string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters Batch batch Batch to add this request to String name Name of the template to retrieve Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IBatchSingleResult < IWebTemplate >> The template with the specified name, if available GetWebTemplateByNameBatchAsync(String, Int32, Boolean) Return a specific web template based by a name Declaration Task> GetWebTemplateByNameBatchAsync(string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters String name Name of the template to retrieve Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IBatchSingleResult < IWebTemplate >> The list of webtemplates available on the current web GetWebTemplates(Int32, Boolean) Returns a collection of site templates available for the site. Declaration List GetWebTemplates(int lcid = 1033, bool includeCrossLanguage = false) Parameters Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns PnP.Core.Model.SharePoint.List < IWebTemplate > The list of webtemplates available on the current web GetWebTemplatesAsync(Int32, Boolean) Returns a collection of site templates available for the site. Declaration Task> GetWebTemplatesAsync(int lcid = 1033, bool includeCrossLanguage = false) Parameters Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < PnP.Core.Model.SharePoint.List < IWebTemplate >> The list of webtemplates available on the current web GetWebTemplatesBatch(Batch, Int32, Boolean) Returns a collection of site templates available for the site. Declaration IEnumerableBatchResult GetWebTemplatesBatch(Batch batch, int lcid = 1033, bool includeCrossLanguage = false) Parameters Batch batch Batch to add this request to Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IEnumerableBatchResult < IWebTemplate > The list of webtemplates available on the current web GetWebTemplatesBatch(Int32, Boolean) Returns a collection of site templates available for the site. Declaration IEnumerableBatchResult GetWebTemplatesBatch(int lcid = 1033, bool includeCrossLanguage = false) Parameters Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IEnumerableBatchResult < IWebTemplate > The list of webtemplates available on the current web GetWebTemplatesBatchAsync(Batch, Int32, Boolean) Returns a collection of site templates available for the site. Declaration Task> GetWebTemplatesBatchAsync(Batch batch, int lcid = 1033, bool includeCrossLanguage = false) Parameters Batch batch Batch to add this request to Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IEnumerableBatchResult < IWebTemplate >> The list of webtemplates available on the current web GetWebTemplatesBatchAsync(Int32, Boolean) Returns a collection of site templates available for the site. Declaration Task> GetWebTemplatesBatchAsync(int lcid = 1033, bool includeCrossLanguage = false) Parameters Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IEnumerableBatchResult < IWebTemplate >> The list of webtemplates available on the current web GetWssIdForTerm(String) Returns the Id for a term if present in the TaxonomyHiddenList. Otherwise returns -1; Declaration int GetWssIdForTerm(string termId) Parameters String termId Id of the term to lookup Returns Int32 Id of the term in the taxonomy hidden list, otherwise -1 GetWssIdForTermAsync(String) Returns the Id for a term if present in the TaxonomyHiddenList. Otherwise returns -1; Declaration Task GetWssIdForTermAsync(string termId) Parameters String termId Id of the term to lookup Returns Task < Int32 > Id of the term in the taxonomy hidden list, otherwise -1 HasCommunicationSiteFeatures() Does this web have the communication site features enabled? Declaration bool HasCommunicationSiteFeatures() Returns Boolean True if enabled, false otherwise HasCommunicationSiteFeaturesAsync() Does this web have the communication site features enabled? Declaration Task HasCommunicationSiteFeaturesAsync() Returns Task < Boolean > True if enabled, false otherwise IsNoScriptSite() Checks if this web is configured for NoScript Declaration bool IsNoScriptSite() Returns Boolean True if set to NoScript, false otherwise IsNoScriptSiteAsync() Checks if this web is configured for NoScript Declaration Task IsNoScriptSiteAsync() Returns Task < Boolean > True if set to NoScript, false otherwise IsSubSite() Checks if this web is a sub site Declaration bool IsSubSite() Returns Boolean True if the web is a sub site IsSubSiteAsync() Checks if this web is a sub site Declaration Task IsSubSiteAsync() Returns Task < Boolean > True if the web is a sub site IsSyntexContentCenter() Is this web a Syntex Content Center Declaration bool IsSyntexContentCenter() Returns Boolean True if this web is a Syntex Content Center, false otherwise IsSyntexContentCenterAsync() Is this web a Syntex Content Center Declaration Task IsSyntexContentCenterAsync() Returns Task < Boolean > True if this web is a Syntex Content Center, false otherwise IsSyntexEnabled() Is the tenant enabled for SharePoint Syntex Declaration bool IsSyntexEnabled() Returns Boolean True if SharePoint Syntex is enabled, false otherwise IsSyntexEnabledAsync() Is the tenant enabled for SharePoint Syntex Declaration Task IsSyntexEnabledAsync() Returns Task < Boolean > True if SharePoint Syntex is enabled, false otherwise IsSyntexEnabledForCurrentUser() Is SharePoint Syntex enabled for the current user Declaration bool IsSyntexEnabledForCurrentUser() Returns Boolean True if SharePoint Syntex is enabled for the current user, false otherwise IsSyntexEnabledForCurrentUserAsync() Is SharePoint Syntex enabled for the current user Declaration Task IsSyntexEnabledForCurrentUserAsync() Returns Task < Boolean > True if SharePoint Syntex is enabled for the current user, false otherwise NewPage(PageLayoutType) Creates a new modern page Declaration IPage NewPage(PageLayoutType pageLayoutType = default(PageLayoutType)) Parameters PageLayoutType pageLayoutType Optionally specify the page type, defaults to Article Returns IPage Created modern page NewPageAsync(PageLayoutType) Creates a new modern page Declaration Task NewPageAsync(PageLayoutType pageLayoutType = default(PageLayoutType)) Parameters PageLayoutType pageLayoutType Optionally specify the page type, defaults to Article Returns Task < IPage > Created modern page ReIndex() Reindexes this web Declaration void ReIndex() ReIndexAsync() Reindexes this web Declaration Task ReIndexAsync() Returns Task RemoveIndexedProperty(String) Removes a web propetry from the indexed properties Declaration bool RemoveIndexedProperty(string propertyName) Parameters String propertyName The property name Returns Boolean True if it was successfully removed otherwise false RemoveIndexedPropertyAsync(String) Removes a web propetry from the indexed properties Declaration Task RemoveIndexedPropertyAsync(string propertyName) Parameters String propertyName The property name Returns Task < Boolean > True if it was successfully removed otherwise false Search(SearchOptions) Performs a search query Declaration ISearchResult Search(SearchOptions query) Parameters SearchOptions query Search query to run Returns ISearchResult The results of the search query SearchAsync(SearchOptions) Performs a search query Declaration Task SearchAsync(SearchOptions query) Parameters SearchOptions query Search query to run Returns Task < ISearchResult > The results of the search query SearchBatch(SearchOptions) Performs a search query Declaration IBatchSingleResult SearchBatch(SearchOptions query) Parameters SearchOptions query Search query to run Returns IBatchSingleResult < ISearchResult > The results of the search query SearchBatch(Batch, SearchOptions) Performs a search query Declaration IBatchSingleResult SearchBatch(Batch batch, SearchOptions query) Parameters Batch batch Batch to add this request to SearchOptions query Search query to run Returns IBatchSingleResult < ISearchResult > The results of the search query SearchBatchAsync(SearchOptions) Performs a search query Declaration Task> SearchBatchAsync(SearchOptions query) Parameters SearchOptions query Search query to run Returns Task < IBatchSingleResult < ISearchResult >> The results of the search query SearchBatchAsync(Batch, SearchOptions) Performs a search query Declaration Task> SearchBatchAsync(Batch batch, SearchOptions query) Parameters Batch batch Batch to add this request to SearchOptions query Search query to run Returns Task < IBatchSingleResult < ISearchResult >> The results of the search query SetAccessRequest(AccessRequestOption, String) Applies the access request settings Declaration Task SetAccessRequest(AccessRequestOption operation, string email = null) Parameters AccessRequestOption operation The operation to be performed String email Applies the email address for the 'SpecificMail' operation Returns Task SetAccessRequestAsync(AccessRequestOption, String) Applies the access request settings Declaration Task SetAccessRequestAsync(AccessRequestOption operation, string email = null) Parameters AccessRequestOption operation The operation to be performed String email Applies the email address for the 'SpecificMail' operation Returns Task SetSearchConfigurationXml(String) Sets the search configuration for the web Declaration void SetSearchConfigurationXml(string configuration) Parameters String configuration Search configuration, obtained via GetSearchConfigurationXml() to apply SetSearchConfigurationXmlAsync(String) Sets the search configuration for the web Declaration Task SetSearchConfigurationXmlAsync(string configuration) Parameters String configuration Search configuration, obtained via GetSearchConfigurationXml() to apply Returns Task SyncHubSiteThemeAsync() Sync the hub site theme from parent hub site Declaration Task SyncHubSiteThemeAsync() Returns Task UnfurlLink(String, UnfurlOptions) Takes in a sharing or regular SharePoint link and tries to provide relavant information about the resource behind the passed in link Declaration IUnfurledResource UnfurlLink(string link, UnfurlOptions unfurlOptions = null) Parameters String link Link to resource to get information for UnfurlOptions unfurlOptions Options to control the unfurling data gathering Returns IUnfurledResource Data about the unfurled resource UnfurlLinkAsync(String, UnfurlOptions) Takes in a sharing or regular SharePoint link and tries to provide relavant information about the resource behind the passed in link Declaration Task UnfurlLinkAsync(string link, UnfurlOptions unfurlOptions = null) Parameters String link Link to resource to get information for UnfurlOptions unfurlOptions Options to control the unfurling data gathering Returns Task < IUnfurledResource > Data about the unfurled resource ValidateAndEnsureUsers(IList) Checks if the provided list of user UPN's are valid users in Azure AD and returns the 'ensured' SharePoint user Declaration IList ValidateAndEnsureUsers(IList userList) Parameters PnP.Core.Model.SharePoint.IList < String > userList List of user UPN's to validate in Azure AD Returns PnP.Core.Model.SharePoint.IList < ISharePointUser > The list of ISharePointUser that exist ValidateAndEnsureUsersAsync(IList) Checks if the provided list of user UPN's are valid users in Azure AD and returns the 'ensured' SharePoint user Declaration Task> ValidateAndEnsureUsersAsync(IList userList) Parameters PnP.Core.Model.SharePoint.IList < String > userList List of user UPN's to validate in Azure AD Returns Task < PnP.Core.Model.SharePoint.IList < ISharePointUser >> The list of ISharePointUser that exist ValidateUsers(IList) Checks if the provided list of user UPN's are valid users in Azure AD Declaration IList ValidateUsers(IList userList) Parameters PnP.Core.Model.SharePoint.IList < String > userList List of user UPN's to validate in Azure AD Returns PnP.Core.Model.SharePoint.IList < String > A list of users that were not found in Azure AD ValidateUsersAsync(IList) Checks if the provided list of user UPN's are valid users in Azure AD Declaration Task> ValidateUsersAsync(IList userList) Parameters PnP.Core.Model.SharePoint.IList < String > userList List of user UPN's to validate in Azure AD Returns Task < PnP.Core.Model.SharePoint.IList < String >> A list of users that were not found in Azure AD Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IWeb Public interface to define a Web object of SharePoint Online Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() IDataModelSupportingGetChanges.GetChangesAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChanges(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(Batch, ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatchAsync(ChangeQueryOptions) IDataModelSupportingGetChanges.GetChangesBatch(ChangeQueryOptions) ISecurableObject.RoleAssignments ISecurableObject.HasUniqueRoleAssignments ISecurableObject.BreakRoleInheritance(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceAsync(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatch(Batch, Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatchAsync(Batch, Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatch(Boolean, Boolean) ISecurableObject.BreakRoleInheritanceBatchAsync(Boolean, Boolean) ISecurableObject.ResetRoleInheritance() ISecurableObject.ResetRoleInheritanceAsync() ISecurableObject.ResetRoleInheritanceBatch(Batch) ISecurableObject.ResetRoleInheritanceBatchAsync(Batch) ISecurableObject.ResetRoleInheritanceBatch() ISecurableObject.ResetRoleInheritanceBatchAsync() ISecurableObject.GetRoleDefinitions(Int32) ISecurableObject.GetRoleDefinitionsAsync(Int32) ISecurableObject.AddRoleDefinitions(Int32, String[]) ISecurableObject.AddRoleDefinitionsAsync(Int32, String[]) ISecurableObject.AddRoleDefinition(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionAsync(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatch(Batch, Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatch(Int32, IRoleDefinition) ISecurableObject.AddRoleDefinitionBatchAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitions(Int32, String[]) ISecurableObject.RemoveRoleDefinitionsAsync(Int32, String[]) ISecurableObject.RemoveRoleDefinition(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatch(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatchAsync(Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatch(Batch, Int32, IRoleDefinition) ISecurableObject.RemoveRoleDefinitionBatchAsync(Batch, Int32, IRoleDefinition) Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IWeb : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IDataModelSupportingGetChanges, ISecurableObject, IQueryableDataModel Properties AccessRequestListUrl Gets the URL of the access request list to the current site. Declaration string AccessRequestListUrl { get; } Property Value String AccessRequestSiteDescription Gets or sets the description of the access request to this site. Declaration string AccessRequestSiteDescription { get; set; } Property Value String All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value System.Object AllowAutomaticASPXPageIndexing Gets a value that specifies whether the automatic ASPX page indexed is allowed. Declaration bool AllowAutomaticASPXPageIndexing { get; set; } Property Value Boolean AllowCreateDeclarativeWorkflowForCurrentUser Gets a value that specifies whether the current user is allowed to create declarative workflow on this site. Declaration bool AllowCreateDeclarativeWorkflowForCurrentUser { get; set; } Property Value Boolean AllowDesignerForCurrentUser Gets a value that specifies whether the current user is allowed to use a designer application to customize this site. Declaration bool AllowDesignerForCurrentUser { get; set; } Property Value Boolean AllowMasterPageEditingForCurrentUser Gets a value that specifies whether the current user is allowed to edit the master page. Declaration bool AllowMasterPageEditingForCurrentUser { get; } Property Value Boolean AllowRevertFromTemplateForCurrentUser Gets a value that specifies whether the current user is allowed to revert the site to a default site template. Declaration bool AllowRevertFromTemplateForCurrentUser { get; } Property Value Boolean AllowRssFeeds Gets a value that specifies whether the site allows RSS feeds. Declaration bool AllowRssFeeds { get; } Property Value Boolean AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser Gets a value that specifies whether the current user is allowed to save declarative workflows as template. Declaration bool AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser { get; } Property Value Boolean AllowSavePublishDeclarativeWorkflowForCurrentUser Gets a value that specifies whether the current user is allowed to publish a declarative workflow. Declaration bool AllowSavePublishDeclarativeWorkflowForCurrentUser { get; } Property Value Boolean AllProperties Gets a collection of metadata for the Web site. Declaration IPropertyValues AllProperties { get; } Property Value IPropertyValues AlternateCssUrl The AlternateCSS of the Site, optional attribute. Declaration string AlternateCssUrl { get; set; } Property Value String AppInstanceId The instance Id of the App Instance that this website represents. Declaration Guid AppInstanceId { get; } Property Value Guid AssociatedMemberGroup Associated SharePoint Member group Declaration ISharePointGroup AssociatedMemberGroup { get; } Property Value ISharePointGroup AssociatedOwnerGroup Associated SharePoint owner group Declaration ISharePointGroup AssociatedOwnerGroup { get; } Property Value ISharePointGroup AssociatedVisitorGroup Associated SharePoint Visitor group Declaration ISharePointGroup AssociatedVisitorGroup { get; } Property Value ISharePointGroup Author Gets the web's author Declaration ISharePointUser Author { get; } Property Value ISharePointUser AvailableContentTypes Gets the collection of all content types that apply to the current scope, including those of the current Web site, as well as any parent Web sites. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IContentTypeCollection AvailableContentTypes { get; } Property Value IContentTypeCollection AvailableFields Gets a value that specifies the collection of all fields available for the current scope, including those of the current site, as well as any parent sites. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFieldCollection AvailableFields { get; } Property Value IFieldCollection CommentsOnSitePagesDisabled Defines whether the comments on site pages are disabled or not Declaration bool CommentsOnSitePagesDisabled { get; set; } Property Value Boolean ContainsConfidentialInfo Gets a boolean value that specifies whether the site contains highly confidential information. If the tenant settings don't allow tagging sites as confidential, this property will always return false. Declaration bool ContainsConfidentialInfo { get; set; } Property Value Boolean ContentTypes Collection of content types in the current Web object Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IContentTypeCollection ContentTypes { get; } Property Value IContentTypeCollection Created Gets a value that specifies when the site was created. Declaration DateTime Created { get; } Property Value DateTime CurrentUser Gets the current user in the current context Declaration ISharePointUser CurrentUser { get; } Property Value ISharePointUser CustomMasterUrl The Custom MasterPage Url of the Site, optional attribute. Declaration string CustomMasterUrl { get; set; } Property Value String DefaultNewPageTemplateId The id of the default new page template. Use SetDefaultNewPageTemplateId to set the value. Declaration Guid DefaultNewPageTemplateId { get; set; } Property Value Guid Description The Description of the Site, optional attribute. Declaration string Description { get; set; } Property Value String DesignPackageId Gets or sets the design package Id of this site. Declaration Guid DesignPackageId { get; set; } Property Value Guid DisableAppViews Defines whether disable PowerApps for the current web Declaration bool DisableAppViews { get; set; } Property Value Boolean DisableFlows Defines whether disable flows for the current web Declaration bool DisableFlows { get; set; } Property Value Boolean DisableRecommendedItems Gets or sets whether the recommended items are disabled on this site. Declaration bool DisableRecommendedItems { get; set; } Property Value Boolean DocumentLibraryCalloutOfficeWebAppPreviewersDisabled Determines if the Document Library Callout's WAC previewers are enabled or not. Declaration bool DocumentLibraryCalloutOfficeWebAppPreviewersDisabled { get; } Property Value Boolean EffectiveBasePermissions Get's the permission levels set on this web Declaration IBasePermissions EffectiveBasePermissions { get; } Property Value IBasePermissions EnableMinimalDownload Gets or sets a Boolean value that specifies whether the Web site should use Minimal Download Strategy. Declaration bool EnableMinimalDownload { get; set; } Property Value Boolean EventReceivers Event Receivers defined in this web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IEventReceiverDefinitionCollection EventReceivers { get; } Property Value IEventReceiverDefinitionCollection ExcludeFromOfflineClient Defines whether to exclude the web from offline client Declaration bool ExcludeFromOfflineClient { get; set; } Property Value Boolean Features Collection of features enabled for the web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFeatureCollection Features { get; } Property Value IFeatureCollection Fields Collection of fields in the current Web object Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFieldCollection Fields { get; } Property Value IFieldCollection Folders Collection of folders in the current Web object Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IFolderCollection Folders { get; } Property Value IFolderCollection FooterEmphasis Gets or sets the value of the footer emphasis. Declaration FooterVariantThemeType FooterEmphasis { get; set; } Property Value FooterVariantThemeType FooterEnabled Gets or sets a value that specifies whether the footer is enabled on the site. Declaration bool FooterEnabled { get; set; } Property Value Boolean FooterLayout Gets or sets the value of the footer layout. Declaration FooterLayoutType FooterLayout { get; set; } Property Value FooterLayoutType HeaderEmphasis Gets or sets the value of the header emphasis. Declaration VariantThemeType HeaderEmphasis { get; set; } Property Value VariantThemeType HeaderLayout Gets or sets the value of the header layout. Declaration HeaderLayoutType HeaderLayout { get; set; } Property Value HeaderLayoutType HideTitleInHeader Gets or sets a value that specifies whether the title in header is hidden on the site. Declaration bool HideTitleInHeader { get; set; } Property Value Boolean HorizontalQuickLaunch Defines whether to enable the Horizontal QuickLaunch for the current web Declaration bool HorizontalQuickLaunch { get; set; } Property Value Boolean Id The Unique ID of the Web object Declaration Guid Id { get; } Property Value Guid IsHomepageModernized Gets a value that indicates whether the homepage is modernized. Declaration bool IsHomepageModernized { get; } Property Value Boolean IsMultilingual Defines whether to enable Multilingual capabilities for the current web Declaration bool IsMultilingual { get; set; } Property Value Boolean IsProvisioningComplete Gets a value that indicates whether the provisioning is complete. Declaration bool IsProvisioningComplete { get; } Property Value Boolean IsRevertHomepageLinkHidden Gets or sets a value that specifies whether the link to revert homepage is hidden. Declaration bool IsRevertHomepageLinkHidden { get; set; } Property Value Boolean Language Gets a value that specifies the LCID for the language that is used on the site. Declaration int Language { get; } Property Value Int32 LastItemModifiedDate Gets a value that specifies when an item was last modified in the site. Declaration DateTime LastItemModifiedDate { get; } Property Value DateTime LastItemUserModifiedDate Gets a value that specifies when an item was last modified by user in the site. Declaration DateTime LastItemUserModifiedDate { get; } Property Value DateTime Lists Collection of lists in the current Web object. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IListCollection Lists { get; } Property Value IListCollection LogoAlignment Gets or sets the logo alignment of the site. Declaration LogoAlignment LogoAlignment { get; set; } Property Value LogoAlignment MasterUrl Gets or sets the URL of the master page that is used for the website. Declaration string MasterUrl { get; set; } Property Value String MegaMenuEnabled Gets or sets a value that specifies whether the megamenu is enabled on the site. Declaration bool MegaMenuEnabled { get; set; } Property Value Boolean MembersCanShare Defines whether members can share content from the current web Declaration bool MembersCanShare { get; set; } Property Value Boolean NavAudienceTargetingEnabled Gets or sets a value that specifies whether the audience targeting is enabled on the navigation of the site. Declaration bool NavAudienceTargetingEnabled { get; set; } Property Value Boolean Navigation Navigation on the Web Declaration INavigation Navigation { get; } Property Value INavigation NextStepsFirstRunEnabled Gets or sets a value that specifies if the Next steps pane should open automatically as a first run experience when someone visits the site. You can only enable the experience for sites created on or after January 1, 2020 Declaration bool NextStepsFirstRunEnabled { get; set; } Property Value Boolean NoCrawl Defines whether the site has to be crawled or not Declaration bool NoCrawl { get; set; } Property Value Boolean NotificationsInOneDriveForBusinessEnabled Returns if true if the tenant allowed to send push notifications in OneDrive for Business. Declaration bool NotificationsInOneDriveForBusinessEnabled { get; } Property Value Boolean NotificationsInSharePointEnabled Returns if true if the tenant allowed to send push notifications in SharePoint. Declaration bool NotificationsInSharePointEnabled { get; } Property Value Boolean ObjectCacheEnabled Gets or sets a value that specifies whether the object cache is enabled on the site. Declaration bool ObjectCacheEnabled { get; set; } Property Value Boolean OverwriteTranslationsOnChange Defines whether to OverwriteTranslationsOnChange on change for the current web Declaration bool OverwriteTranslationsOnChange { get; set; } Property Value Boolean PreviewFeaturesEnabled Indicates whether the tenant administrator has chosen to disable the Preview Features. Default is true. Declaration bool PreviewFeaturesEnabled { get; } Property Value Boolean PrimaryColor Gets or sets the primary color of the site. Declaration string PrimaryColor { get; } Property Value String QuickLaunchEnabled Enables or disables the QuickLaunch for the site Declaration bool QuickLaunchEnabled { get; set; } Property Value Boolean RecycleBin Gets the recycle bin of the website. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IRecycleBinItemCollection RecycleBin { get; } Property Value IRecycleBinItemCollection RecycleBinEnabled Gets or sets a value that specifies whether the Recycle Bin is enabled. Declaration bool RecycleBinEnabled { get; set; } Property Value Boolean RegionalSettings Regional settings configured for this web Declaration IRegionalSettings RegionalSettings { get; } Property Value IRegionalSettings RequestAccessEmail The email address to which any access request will be sent Declaration string RequestAccessEmail { get; set; } Property Value String RoleDefinitions Role Definitions defined in this web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IRoleDefinitionCollection RoleDefinitions { get; } Property Value IRoleDefinitionCollection RootFolder Gets the root folder for the website. Declaration IFolder RootFolder { get; } Property Value IFolder SaveSiteAsTemplateEnabled Gets or sets a Boolean value that specifies whether the Web site can be saved as a site template. Declaration bool SaveSiteAsTemplateEnabled { get; set; } Property Value Boolean SearchBoxInNavBar Define if the suitebar search box should show or not Declaration SearchBoxInNavBar SearchBoxInNavBar { get; set; } Property Value SearchBoxInNavBar SearchBoxPlaceholderText Search placeholder text for search box in navbar - overrides default placeholder text if set, returns null if not set. Declaration string SearchBoxPlaceholderText { get; set; } Property Value String SearchScope Defines the SearchScope for the site Declaration SearchScope SearchScope { get; set; } Property Value SearchScope ServerRelativeUrl Gets the server relative URL of the current site. Declaration string ServerRelativeUrl { get; } Property Value String SiteGroups Gets the collection of all groups that belong to the site collection. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ISharePointGroupCollection SiteGroups { get; } Property Value ISharePointGroupCollection SiteLogoDescription Gets or sets the description of the Web site logo. Declaration string SiteLogoDescription { get; set; } Property Value String SiteLogoUrl Gets or sets the server-relative URL of the Web site logo. This can also contain an absolute URL to the logo. Declaration string SiteLogoUrl { get; set; } Property Value String SiteUserInfoList Gets the UserInfo list of the site collection that contains the website. Declaration IList SiteUserInfoList { get; } Property Value IList SiteUsers Gets the collection of all users that belong to the site collection. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ISharePointUserCollection SiteUsers { get; } Property Value ISharePointUserCollection SupportedUILanguageIds List of languages (expressed via their id) that this site supports Declaration List SupportedUILanguageIds { get; } Property Value PnP.Core.Model.SharePoint.List < Int32 > SyndicationEnabled Gets or sets a value that specifies whether the RSS feeds are enabled on the site. Declaration bool SyndicationEnabled { get; set; } Property Value Boolean TenantAdminMembersCanShare Gets or sets a value that specifies how the tenant admin members can share. Declaration SharingState TenantAdminMembersCanShare { get; } Property Value SharingState ThemeData Get JSON serialized ThemeData for the current web. Declaration string ThemeData { get; } Property Value String ThirdPartyMdmEnabled Gets a value that indicates whether third party MDM (Mobile Device Management) is enabled on the site. Declaration bool ThirdPartyMdmEnabled { get; } Property Value Boolean Title The Title of the Site, optional attribute. Declaration string Title { get; set; } Property Value String TreeViewEnabled Gets or sets value that specifies whether the tree view is enabled on the site. Declaration bool TreeViewEnabled { get; set; } Property Value Boolean Url The URL of the Web object Declaration Uri Url { get; } Property Value Uri UseAccessRequestDefault Determines if we need to use the default access request If this value is True we send access requests to owner/owner's group If this value is False we send access requests to the configured AccessRequestEmail Declaration bool UseAccessRequestDefault { get; } Property Value Boolean UserCustomActions Gets a value that specifies the collection of user custom actions for the site. Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IUserCustomActionCollection UserCustomActions { get; } Property Value IUserCustomActionCollection Webs Collection of webs in this current web Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration IWebCollection Webs { get; } Property Value IWebCollection WebTemplate Gets the name of the site definition or site template that was used to create the site. Declaration string WebTemplate { get; } Property Value String WebTemplateConfiguration Gets the web template configuration of the site. Declaration string WebTemplateConfiguration { get; } Property Value String WebTemplatesGalleryFirstRunEnabled Gets or sets a value that specifies if the web templates experience should open automatically as a first run experience after the site was created Declaration bool WebTemplatesGalleryFirstRunEnabled { get; set; } Property Value Boolean WelcomePage Specifies a string that contains the site-relative URL to which users are redirected when web is browsed (typically the site's home page). Declaration string WelcomePage { get; } Property Value String Methods AddIndexedProperty(String) Adds a web property as an indexed property Declaration bool AddIndexedProperty(string propertyName) Parameters String propertyName The property name Returns Boolean True if it was successfully added or if it is already exists otherwise false Remarks The property must already exist as metadata of the Web AddIndexedPropertyAsync(String) Adds a web property as an indexed property Declaration Task AddIndexedPropertyAsync(string propertyName) Parameters String propertyName The property name Returns Task < Boolean > True if it was successfully added or if it is already exists otherwise false Remarks The property must already exist as metadata of the Web AsSyntexContentCenter() Returns the current web as ISyntexContentCenter if the web is a Syntex Content Center, null is returned otherwise Declaration ISyntexContentCenter AsSyntexContentCenter() Returns ISyntexContentCenter The current web as ISyntexContentCenter AsSyntexContentCenterAsync() Returns the current web as ISyntexContentCenter if the web is a Syntex Content Center, null is returned otherwise Declaration Task AsSyntexContentCenterAsync() Returns Task < ISyntexContentCenter > The current web as ISyntexContentCenter CheckIfUserHasPermissions(String, PermissionKind) Checks if a user has a specific kind of permissions to a web Declaration bool CheckIfUserHasPermissions(string userPrincipalName, PermissionKind permissionKind) Parameters String userPrincipalName Login name of the user you wish to check if he has a specific permission PermissionKind permissionKind Permission kind to check Returns Boolean Boolean that says if the user has permissions or not CheckIfUserHasPermissionsAsync(String, PermissionKind) Checks if a user has a specific kind of permissions to a web Declaration Task CheckIfUserHasPermissionsAsync(string userPrincipalName, PermissionKind permissionKind) Parameters String userPrincipalName Login name of the user you wish to check if he has a specific permission PermissionKind permissionKind Permission kind to check Returns Task < Boolean > Boolean that says if the user has permissions or not EnsureEveryoneExceptExternalUsers() Retrieves everyone except external users and ensures the user in the current web Declaration ISharePointUser EnsureEveryoneExceptExternalUsers() Returns ISharePointUser The ensured ISharePointUser EnsureEveryoneExceptExternalUsersAsync() Retrieves everyone except external users and ensures the user in the current web Declaration Task EnsureEveryoneExceptExternalUsersAsync() Returns Task < ISharePointUser > The ensured ISharePointUser EnsureMultilingual(List) Ensure a site can support multilingual (pages) for the passed along languages Declaration void EnsureMultilingual(List requiredLanguageIds) Parameters PnP.Core.Model.SharePoint.List < Int32 > requiredLanguageIds List of langauges to support for multilingual on this site. See https://capacreative.co.uk/resources/reference-sharepoint-online-languages-ids/ for information on the language ids EnsureMultilingualAsync(List) Ensure a site can support multilingual (pages) for the passed along languages Declaration Task EnsureMultilingualAsync(List requiredLanguageIds) Parameters PnP.Core.Model.SharePoint.List < Int32 > requiredLanguageIds List of langauges to support for multilingual on this site. See https://capacreative.co.uk/resources/reference-sharepoint-online-languages-ids/ for information on the language ids Returns Task EnsurePageScheduling() Ensures that page publishing can work for this site. Page scheduling only works for the root web of a site collection Declaration void EnsurePageScheduling() EnsurePageSchedulingAsync() Ensures that page publishing can work for this site. Page scheduling only works for the root web of a site collection Declaration Task EnsurePageSchedulingAsync() Returns Task EnsureUser(String) Ensures the given users exists Declaration ISharePointUser EnsureUser(string userPrincipalName) Parameters String userPrincipalName UserPrincipalName value of the user to verify Returns ISharePointUser The ensured ISharePointUser EnsureUserAsync(String) Ensures the given users exists Declaration Task EnsureUserAsync(string userPrincipalName) Parameters String userPrincipalName UserPrincipalName value of the user to verify Returns Task < ISharePointUser > The ensured ISharePointUser EnsureUserBatch(Batch, String) Ensures the given users exists Declaration ISharePointUser EnsureUserBatch(Batch batch, string userPrincipalName) Parameters Batch batch Batch to add this request to String userPrincipalName UserPrincipalName value of the user to verify Returns ISharePointUser The ensured ISharePointUser EnsureUserBatch(String) Ensures the given users exists Declaration ISharePointUser EnsureUserBatch(string userPrincipalName) Parameters String userPrincipalName UserPrincipalName value of the user to verify Returns ISharePointUser The ensured ISharePointUser EnsureUserBatchAsync(Batch, String) Ensures the given users exists Declaration Task EnsureUserBatchAsync(Batch batch, string userPrincipalName) Parameters Batch batch Batch to add this request to String userPrincipalName UserPrincipalName value of the user to verify Returns Task < ISharePointUser > The ensured ISharePointUser EnsureUserBatchAsync(String) Ensures the given users exists Declaration Task EnsureUserBatchAsync(string userPrincipalName) Parameters String userPrincipalName UserPrincipalName value of the user to verify Returns Task < ISharePointUser > The ensured ISharePointUser GetBrandingManager() Returns the branding manager which can be used to change the look of the web Declaration IBrandingManager GetBrandingManager() Returns IBrandingManager An IBrandingManager instance GetCurrentUser() Get's the current logged on user making the request to SharePoint Declaration ISharePointUser GetCurrentUser() Returns ISharePointUser The current ISharePointUser GetCurrentUserAsync() Get's the current logged on user making the request to SharePoint Declaration Task GetCurrentUserAsync() Returns Task < ISharePointUser > The current ISharePointUser GetCurrentUserBatch() Get's the current logged on user making the request to SharePoint Declaration ISharePointUser GetCurrentUserBatch() Returns ISharePointUser The current ISharePointUser GetCurrentUserBatch(Batch) Get's the current logged on user making the request to SharePoint Declaration ISharePointUser GetCurrentUserBatch(Batch batch) Parameters Batch batch Batch to add this request to Returns ISharePointUser The current ISharePointUser GetCurrentUserBatchAsync() Get's the current logged on user making the request to SharePoint Declaration Task GetCurrentUserBatchAsync() Returns Task < ISharePointUser > The current ISharePointUser GetCurrentUserBatchAsync(Batch) Get's the current logged on user making the request to SharePoint Declaration Task GetCurrentUserBatchAsync(Batch batch) Parameters Batch batch Batch to add this request to Returns Task < ISharePointUser > The current ISharePointUser GetFileById(Guid, Expression>[]) Get a file in the current web from its unique id. Declaration IFile GetFileById(Guid uniqueFileId, params Expression>[] expressions) Parameters Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByIdAsync(Guid, Expression>[]) Get a file in the current web from its unique id. Declaration Task GetFileByIdAsync(Guid uniqueFileId, params Expression>[] expressions) Parameters Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByIdBatch(Guid, Expression>[]) Get a file in the current web from its unique id via batch. Declaration IFile GetFileByIdBatch(Guid uniqueFileId, params Expression>[] expressions) Parameters Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByIdBatch(Batch, Guid, Expression>[]) Get a file in the current web from its unique id via batch. Declaration IFile GetFileByIdBatch(Batch batch, Guid uniqueFileId, params Expression>[] expressions) Parameters Batch batch Batch to add this request to Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByIdBatchAsync(Guid, Expression>[]) Get a file in the current web from its unique id via batch. Declaration Task GetFileByIdBatchAsync(Guid uniqueFileId, params Expression>[] expressions) Parameters Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByIdBatchAsync(Batch, Guid, Expression>[]) Get a file in the current web from its unique id via batch. Declaration Task GetFileByIdBatchAsync(Batch batch, Guid uniqueFileId, params Expression>[] expressions) Parameters Batch batch Batch to add this request to Guid uniqueFileId The unique id of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByLink(String, Expression>[]) Get's a file from a given link (sharing link, path to file) Declaration IFile GetFileByLink(string link, params Expression>[] expressions) Parameters String link Link pointing to a file Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile IFile reference when the file could be found, exception otherwise GetFileByLinkAsync(String, Expression>[]) Get's a file from a given link (sharing link, path to file) Declaration Task GetFileByLinkAsync(string link, params Expression>[] expressions) Parameters String link Link pointing to a file Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > IFile reference when the file could be found, exception otherwise GetFileByServerRelativeUrl(String, Expression>[]) Get a file in the current web from its server relative URL. Declaration IFile GetFileByServerRelativeUrl(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByServerRelativeUrlAsync(String, Expression>[]) Get a file in the current web from its server relative URL. Declaration Task GetFileByServerRelativeUrlAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByServerRelativeUrlBatch(Batch, String, Expression>[]) Get a file in the current web from its server relative URL via batch. Declaration IFile GetFileByServerRelativeUrlBatch(Batch batch, string serverRelativeUrl, params Expression>[] expressions) Parameters Batch batch Batch to add this request to String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByServerRelativeUrlBatch(String, Expression>[]) Get a file in the current web from its server relative URL via batch. Declaration IFile GetFileByServerRelativeUrlBatch(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get GetFileByServerRelativeUrlBatchAsync(Batch, String, Expression>[]) Get a file in the current web from its server relative URL via batch. Declaration Task GetFileByServerRelativeUrlBatchAsync(Batch batch, string serverRelativeUrl, params Expression>[] expressions) Parameters Batch batch Batch to add this request to String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByServerRelativeUrlBatchAsync(String, Expression>[]) Get a file in the current web from its server relative URL via batch. Declaration Task GetFileByServerRelativeUrlBatchAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get GetFileByServerRelativeUrlOrDefault(String, Expression>[]) Get a file in the current web from its server relative URL, it not available null will be returned Declaration IFile GetFileByServerRelativeUrlOrDefault(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns IFile The file to get or null if the file was not available GetFileByServerRelativeUrlOrDefaultAsync(String, Expression>[]) Get a file in the current web from its server relative URL, it not available null will be returned Declaration Task GetFileByServerRelativeUrlOrDefaultAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the file to get. Expression < Func < IFile , System.Object >>[] expressions Properties to load for the requested IFile Returns Task < IFile > The file to get or null if the file was not available GetFolderById(Guid, Expression>[]) Get a folder in the current web from its id. Declaration IFolder GetFolderById(Guid folderId, params Expression>[] expressions) Parameters Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByIdAsync(Guid, Expression>[]) Get a folder in the current web from its id. Declaration Task GetFolderByIdAsync(Guid folderId, params Expression>[] expressions) Parameters Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByIdBatch(Guid, Expression>[]) Get a folder in the current web from its id via batch. Declaration IFolder GetFolderByIdBatch(Guid folderId, params Expression>[] expressions) Parameters Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByIdBatch(Batch, Guid, Expression>[]) Get a folder in the current web from its id via batch. Declaration IFolder GetFolderByIdBatch(Batch batch, Guid folderId, params Expression>[] expressions) Parameters Batch batch Batch to add this request to Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByIdBatchAsync(Guid, Expression>[]) Get a folder in the current web from its id via batch. Declaration Task GetFolderByIdBatchAsync(Guid folderId, params Expression>[] expressions) Parameters Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByIdBatchAsync(Batch, Guid, Expression>[]) Get a folder in the current web from its id via batch. Declaration Task GetFolderByIdBatchAsync(Batch batch, Guid folderId, params Expression>[] expressions) Parameters Batch batch Batch to add this request to Guid folderId The id of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByServerRelativeUrl(String, Expression>[]) Get a folder in the current web from its server relative URL. Declaration IFolder GetFolderByServerRelativeUrl(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByServerRelativeUrlAsync(String, Expression>[]) Get a folder in the current web from its server relative URL. Declaration Task GetFolderByServerRelativeUrlAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByServerRelativeUrlBatch(Batch, String, Expression>[]) Get a folder in the current web from its server relative URL via batch. Declaration IFolder GetFolderByServerRelativeUrlBatch(Batch batch, string serverRelativeUrl, params Expression>[] expressions) Parameters Batch batch Batch to add this request to String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByServerRelativeUrlBatch(String, Expression>[]) Get a folder in the current web from its server relative URL via batch. Declaration IFolder GetFolderByServerRelativeUrlBatch(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns IFolder The folder to get GetFolderByServerRelativeUrlBatchAsync(Batch, String, Expression>[]) Get a folder in the current web from its server relative URL via batch. Declaration Task GetFolderByServerRelativeUrlBatchAsync(Batch batch, string serverRelativeUrl, params Expression>[] expressions) Parameters Batch batch Batch to add this request to String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetFolderByServerRelativeUrlBatchAsync(String, Expression>[]) Get a folder in the current web from its server relative URL via batch. Declaration Task GetFolderByServerRelativeUrlBatchAsync(string serverRelativeUrl, params Expression>[] expressions) Parameters String serverRelativeUrl The server relative URL of the folder to get. Expression < Func < IFolder , System.Object >>[] expressions Expressions needed to create the request Returns Task < IFolder > The folder to get GetPages(String) Gets the modern pages of this site, optionally scoped down via a filter Declaration List GetPages(string pageName = null) Parameters String pageName Page name to filter on, uses a \"starts with\" filter Returns PnP.Core.Model.SharePoint.List < IPage > One of more modern pages GetPagesAsync(String) Gets the modern pages of this site, optionally scoped down via a filter Declaration Task> GetPagesAsync(string pageName = null) Parameters String pageName Page name to filter on, uses a \"starts with\" filter Returns Task < PnP.Core.Model.SharePoint.List < IPage >> One of more modern pages GetRecycleBinItemsByQuery(RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration IRecycleBinItemCollection GetRecycleBinItemsByQuery(RecycleBinQueryOptions options) Parameters RecycleBinQueryOptions options Recycle bin search criteria Returns IRecycleBinItemCollection A list containing zero or more recycle bin items GetRecycleBinItemsByQueryAsync(RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration Task GetRecycleBinItemsByQueryAsync(RecycleBinQueryOptions options) Parameters RecycleBinQueryOptions options Recycle bin search criteria Returns Task < IRecycleBinItemCollection > A list containing zero or more recycle bin items GetRecycleBinItemsByQueryBatch(RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration IRecycleBinItemCollection GetRecycleBinItemsByQueryBatch(RecycleBinQueryOptions options) Parameters RecycleBinQueryOptions options Recycle bin search criteria Returns IRecycleBinItemCollection A list containing zero or more recycle bin items GetRecycleBinItemsByQueryBatch(Batch, RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration IRecycleBinItemCollection GetRecycleBinItemsByQueryBatch(Batch batch, RecycleBinQueryOptions options) Parameters Batch batch Batch to add this request to RecycleBinQueryOptions options Recycle bin search criteria Returns IRecycleBinItemCollection A list containing zero or more recycle bin items GetRecycleBinItemsByQueryBatchAsync(RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration Task GetRecycleBinItemsByQueryBatchAsync(RecycleBinQueryOptions options) Parameters RecycleBinQueryOptions options Recycle bin search criteria Returns Task < IRecycleBinItemCollection > A list containing zero or more recycle bin items GetRecycleBinItemsByQueryBatchAsync(Batch, RecycleBinQueryOptions) Searches the recyclebin returning items based upon the passed search criteria Declaration Task GetRecycleBinItemsByQueryBatchAsync(Batch batch, RecycleBinQueryOptions options) Parameters Batch batch Batch to add this request to RecycleBinQueryOptions options Recycle bin search criteria Returns Task < IRecycleBinItemCollection > A list containing zero or more recycle bin items GetSearchConfigurationManagedProperties() Gets the managed properties from the search configuration of this web Declaration List GetSearchConfigurationManagedProperties() Returns PnP.Core.Model.SharePoint.List < IManagedProperty > List of managed properties GetSearchConfigurationManagedPropertiesAsync() Gets the managed properties from the search configuration of this web Declaration Task> GetSearchConfigurationManagedPropertiesAsync() Returns Task < PnP.Core.Model.SharePoint.List < IManagedProperty >> List of managed properties GetSearchConfigurationXml() Gets the search configuration of the web Declaration string GetSearchConfigurationXml() Returns String Search configuration XML GetSearchConfigurationXmlAsync() Gets the search configuration of the web Declaration Task GetSearchConfigurationXmlAsync() Returns Task < String > Search configuration XML GetUserById(Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUser(String) if you want to create the user if it does not yet exist Declaration ISharePointUser GetUserById(int userId) Parameters Int32 userId Id of the user to get Returns ISharePointUser The found user as ISharePointPrincipal GetUserByIdAsync(Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserAsync(String) if you want to create the user if it does not yet exist Declaration Task GetUserByIdAsync(int userId) Parameters Int32 userId Id of the user to get Returns Task < ISharePointUser > The found user as ISharePointPrincipal GetUserByIdBatch(Batch, Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserBatch(String) if you want to create the user if it does not yet exist Declaration ISharePointUser GetUserByIdBatch(Batch batch, int userId) Parameters Batch batch Batch to add this request to Int32 userId Id of the user to get Returns ISharePointUser The found user as ISharePointPrincipal GetUserByIdBatch(Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserBatch(String) if you want to create the user if it does not yet exist Declaration ISharePointUser GetUserByIdBatch(int userId) Parameters Int32 userId Id of the user to get Returns ISharePointUser The found user as ISharePointPrincipal GetUserByIdBatchAsync(Batch, Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserBatchAsync(String) if you want to create the user if it does not yet exist Declaration Task GetUserByIdBatchAsync(Batch batch, int userId) Parameters Batch batch Batch to add this request to Int32 userId Id of the user to get Returns Task < ISharePointUser > The found user as ISharePointPrincipal GetUserByIdBatchAsync(Int32) Get's a user by it's id in this site. The user needs to exist, use EnsureUserBatchAsync(String) if you want to create the user if it does not yet exist Declaration Task GetUserByIdBatchAsync(int userId) Parameters Int32 userId Id of the user to get Returns Task < ISharePointUser > The found user as ISharePointPrincipal GetUserEffectivePermissions(String) Gets the user effective permissions of a user for a web Declaration IBasePermissions GetUserEffectivePermissions(string userPrincipalName) Parameters String userPrincipalName Login name of the user you wish to retrieve the permissions of Returns IBasePermissions Base permissions object that contains the High and the Low permissions GetUserEffectivePermissionsAsync(String) Gets the user effective permissions of a user for a web Declaration Task GetUserEffectivePermissionsAsync(string userPrincipalName) Parameters String userPrincipalName Login name of the user you wish to retrieve the permissions of Returns Task < IBasePermissions > Base permissions object that contains the High and the Low permissions GetVivaDashboard() Gets Viva Connections dashboard. If there is no dashboard configured, returns null Declaration IVivaDashboard GetVivaDashboard() Returns IVivaDashboard Viva Dashboard or null GetVivaDashboardAsync() Gets Viva Connections dashboard. If there is no dashboard configured, returns null Declaration Task GetVivaDashboardAsync() Returns Task < IVivaDashboard > Viva Dashboard or null GetWebTemplateByName(String, Int32, Boolean) Return a specific web template based by a name Declaration IWebTemplate GetWebTemplateByName(string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters String name Name of the template to retrieve Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IWebTemplate The template with the specified name, if available GetWebTemplateByNameAsync(String, Int32, Boolean) Return a specific web template based by a name Declaration Task GetWebTemplateByNameAsync(string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters String name Name of the template to retrieve Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IWebTemplate > The template with the specified name, if available GetWebTemplateByNameBatch(Batch, String, Int32, Boolean) Return a specific web template based by a name Declaration IBatchSingleResult GetWebTemplateByNameBatch(Batch batch, string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters Batch batch Batch to add this request to String name Name of the template to retrieve Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IBatchSingleResult < IWebTemplate > The template with the specified name, if available GetWebTemplateByNameBatch(String, Int32, Boolean) Return a specific web template based by a name Declaration IBatchSingleResult GetWebTemplateByNameBatch(string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters String name Name of the template to retrieve Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IBatchSingleResult < IWebTemplate > The template with the specified name, if available GetWebTemplateByNameBatchAsync(Batch, String, Int32, Boolean) Return a specific web template based by a name Declaration Task> GetWebTemplateByNameBatchAsync(Batch batch, string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters Batch batch Batch to add this request to String name Name of the template to retrieve Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IBatchSingleResult < IWebTemplate >> The template with the specified name, if available GetWebTemplateByNameBatchAsync(String, Int32, Boolean) Return a specific web template based by a name Declaration Task> GetWebTemplateByNameBatchAsync(string name, int lcid = 1033, bool includeCrossLanguage = false) Parameters String name Name of the template to retrieve Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IBatchSingleResult < IWebTemplate >> The list of webtemplates available on the current web GetWebTemplates(Int32, Boolean) Returns a collection of site templates available for the site. Declaration List GetWebTemplates(int lcid = 1033, bool includeCrossLanguage = false) Parameters Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns PnP.Core.Model.SharePoint.List < IWebTemplate > The list of webtemplates available on the current web GetWebTemplatesAsync(Int32, Boolean) Returns a collection of site templates available for the site. Declaration Task> GetWebTemplatesAsync(int lcid = 1033, bool includeCrossLanguage = false) Parameters Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < PnP.Core.Model.SharePoint.List < IWebTemplate >> The list of webtemplates available on the current web GetWebTemplatesBatch(Batch, Int32, Boolean) Returns a collection of site templates available for the site. Declaration IEnumerableBatchResult GetWebTemplatesBatch(Batch batch, int lcid = 1033, bool includeCrossLanguage = false) Parameters Batch batch Batch to add this request to Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IEnumerableBatchResult < IWebTemplate > The list of webtemplates available on the current web GetWebTemplatesBatch(Int32, Boolean) Returns a collection of site templates available for the site. Declaration IEnumerableBatchResult GetWebTemplatesBatch(int lcid = 1033, bool includeCrossLanguage = false) Parameters Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns IEnumerableBatchResult < IWebTemplate > The list of webtemplates available on the current web GetWebTemplatesBatchAsync(Batch, Int32, Boolean) Returns a collection of site templates available for the site. Declaration Task> GetWebTemplatesBatchAsync(Batch batch, int lcid = 1033, bool includeCrossLanguage = false) Parameters Batch batch Batch to add this request to Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IEnumerableBatchResult < IWebTemplate >> The list of webtemplates available on the current web GetWebTemplatesBatchAsync(Int32, Boolean) Returns a collection of site templates available for the site. Declaration Task> GetWebTemplatesBatchAsync(int lcid = 1033, bool includeCrossLanguage = false) Parameters Int32 lcid Specifies the LCID of the site templates to be retrieved. Boolean includeCrossLanguage Specifies whether to include language-neutral site templates. Returns Task < IEnumerableBatchResult < IWebTemplate >> The list of webtemplates available on the current web GetWssIdForTerm(String) Returns the Id for a term if present in the TaxonomyHiddenList. Otherwise returns -1; Declaration int GetWssIdForTerm(string termId) Parameters String termId Id of the term to lookup Returns Int32 Id of the term in the taxonomy hidden list, otherwise -1 GetWssIdForTermAsync(String) Returns the Id for a term if present in the TaxonomyHiddenList. Otherwise returns -1; Declaration Task GetWssIdForTermAsync(string termId) Parameters String termId Id of the term to lookup Returns Task < Int32 > Id of the term in the taxonomy hidden list, otherwise -1 HasCommunicationSiteFeatures() Does this web have the communication site features enabled? Declaration bool HasCommunicationSiteFeatures() Returns Boolean True if enabled, false otherwise HasCommunicationSiteFeaturesAsync() Does this web have the communication site features enabled? Declaration Task HasCommunicationSiteFeaturesAsync() Returns Task < Boolean > True if enabled, false otherwise IsNoScriptSite() Checks if this web is configured for NoScript Declaration bool IsNoScriptSite() Returns Boolean True if set to NoScript, false otherwise IsNoScriptSiteAsync() Checks if this web is configured for NoScript Declaration Task IsNoScriptSiteAsync() Returns Task < Boolean > True if set to NoScript, false otherwise IsSubSite() Checks if this web is a sub site Declaration bool IsSubSite() Returns Boolean True if the web is a sub site IsSubSiteAsync() Checks if this web is a sub site Declaration Task IsSubSiteAsync() Returns Task < Boolean > True if the web is a sub site IsSyntexContentCenter() Is this web a Syntex Content Center Declaration bool IsSyntexContentCenter() Returns Boolean True if this web is a Syntex Content Center, false otherwise IsSyntexContentCenterAsync() Is this web a Syntex Content Center Declaration Task IsSyntexContentCenterAsync() Returns Task < Boolean > True if this web is a Syntex Content Center, false otherwise IsSyntexEnabled() Is the tenant enabled for SharePoint Syntex Declaration bool IsSyntexEnabled() Returns Boolean True if SharePoint Syntex is enabled, false otherwise IsSyntexEnabledAsync() Is the tenant enabled for SharePoint Syntex Declaration Task IsSyntexEnabledAsync() Returns Task < Boolean > True if SharePoint Syntex is enabled, false otherwise IsSyntexEnabledForCurrentUser() Is SharePoint Syntex enabled for the current user Declaration bool IsSyntexEnabledForCurrentUser() Returns Boolean True if SharePoint Syntex is enabled for the current user, false otherwise IsSyntexEnabledForCurrentUserAsync() Is SharePoint Syntex enabled for the current user Declaration Task IsSyntexEnabledForCurrentUserAsync() Returns Task < Boolean > True if SharePoint Syntex is enabled for the current user, false otherwise NewPage(PageLayoutType) Creates a new modern page Declaration IPage NewPage(PageLayoutType pageLayoutType = default(PageLayoutType)) Parameters PageLayoutType pageLayoutType Optionally specify the page type, defaults to Article Returns IPage Created modern page NewPageAsync(PageLayoutType) Creates a new modern page Declaration Task NewPageAsync(PageLayoutType pageLayoutType = default(PageLayoutType)) Parameters PageLayoutType pageLayoutType Optionally specify the page type, defaults to Article Returns Task < IPage > Created modern page ReIndex() Reindexes this web Declaration void ReIndex() ReIndexAsync() Reindexes this web Declaration Task ReIndexAsync() Returns Task RemoveIndexedProperty(String) Removes a web propetry from the indexed properties Declaration bool RemoveIndexedProperty(string propertyName) Parameters String propertyName The property name Returns Boolean True if it was successfully removed otherwise false RemoveIndexedPropertyAsync(String) Removes a web propetry from the indexed properties Declaration Task RemoveIndexedPropertyAsync(string propertyName) Parameters String propertyName The property name Returns Task < Boolean > True if it was successfully removed otherwise false Search(SearchOptions) Performs a search query Declaration ISearchResult Search(SearchOptions query) Parameters SearchOptions query Search query to run Returns ISearchResult The results of the search query SearchAsync(SearchOptions) Performs a search query Declaration Task SearchAsync(SearchOptions query) Parameters SearchOptions query Search query to run Returns Task < ISearchResult > The results of the search query SearchBatch(SearchOptions) Performs a search query Declaration IBatchSingleResult SearchBatch(SearchOptions query) Parameters SearchOptions query Search query to run Returns IBatchSingleResult < ISearchResult > The results of the search query SearchBatch(Batch, SearchOptions) Performs a search query Declaration IBatchSingleResult SearchBatch(Batch batch, SearchOptions query) Parameters Batch batch Batch to add this request to SearchOptions query Search query to run Returns IBatchSingleResult < ISearchResult > The results of the search query SearchBatchAsync(SearchOptions) Performs a search query Declaration Task> SearchBatchAsync(SearchOptions query) Parameters SearchOptions query Search query to run Returns Task < IBatchSingleResult < ISearchResult >> The results of the search query SearchBatchAsync(Batch, SearchOptions) Performs a search query Declaration Task> SearchBatchAsync(Batch batch, SearchOptions query) Parameters Batch batch Batch to add this request to SearchOptions query Search query to run Returns Task < IBatchSingleResult < ISearchResult >> The results of the search query SetAccessRequest(AccessRequestOption, String) Applies the access request settings Declaration Task SetAccessRequest(AccessRequestOption operation, string email = null) Parameters AccessRequestOption operation The operation to be performed String email Applies the email address for the 'SpecificMail' operation Returns Task SetAccessRequestAsync(AccessRequestOption, String) Applies the access request settings Declaration Task SetAccessRequestAsync(AccessRequestOption operation, string email = null) Parameters AccessRequestOption operation The operation to be performed String email Applies the email address for the 'SpecificMail' operation Returns Task SetSearchConfigurationXml(String) Sets the search configuration for the web Declaration void SetSearchConfigurationXml(string configuration) Parameters String configuration Search configuration, obtained via GetSearchConfigurationXml() to apply SetSearchConfigurationXmlAsync(String) Sets the search configuration for the web Declaration Task SetSearchConfigurationXmlAsync(string configuration) Parameters String configuration Search configuration, obtained via GetSearchConfigurationXml() to apply Returns Task SyncHubSiteThemeAsync() Sync the hub site theme from parent hub site Declaration Task SyncHubSiteThemeAsync() Returns Task UnfurlLink(String, UnfurlOptions) Takes in a sharing or regular SharePoint link and tries to provide relavant information about the resource behind the passed in link Declaration IUnfurledResource UnfurlLink(string link, UnfurlOptions unfurlOptions = null) Parameters String link Link to resource to get information for UnfurlOptions unfurlOptions Options to control the unfurling data gathering Returns IUnfurledResource Data about the unfurled resource UnfurlLinkAsync(String, UnfurlOptions) Takes in a sharing or regular SharePoint link and tries to provide relavant information about the resource behind the passed in link Declaration Task UnfurlLinkAsync(string link, UnfurlOptions unfurlOptions = null) Parameters String link Link to resource to get information for UnfurlOptions unfurlOptions Options to control the unfurling data gathering Returns Task < IUnfurledResource > Data about the unfurled resource ValidateAndEnsureUsers(IList) Checks if the provided list of user UPN's are valid users in Azure AD and returns the 'ensured' SharePoint user Declaration IList ValidateAndEnsureUsers(IList userList) Parameters PnP.Core.Model.SharePoint.IList < String > userList List of user UPN's to validate in Azure AD Returns PnP.Core.Model.SharePoint.IList < ISharePointUser > The list of ISharePointUser that exist ValidateAndEnsureUsersAsync(IList) Checks if the provided list of user UPN's are valid users in Azure AD and returns the 'ensured' SharePoint user Declaration Task> ValidateAndEnsureUsersAsync(IList userList) Parameters PnP.Core.Model.SharePoint.IList < String > userList List of user UPN's to validate in Azure AD Returns Task < PnP.Core.Model.SharePoint.IList < ISharePointUser >> The list of ISharePointUser that exist ValidateUsers(IList) Checks if the provided list of user UPN's are valid users in Azure AD Declaration IList ValidateUsers(IList userList) Parameters PnP.Core.Model.SharePoint.IList < String > userList List of user UPN's to validate in Azure AD Returns PnP.Core.Model.SharePoint.IList < String > A list of users that were not found in Azure AD ValidateUsersAsync(IList) Checks if the provided list of user UPN's are valid users in Azure AD Declaration Task> ValidateUsersAsync(IList userList) Parameters PnP.Core.Model.SharePoint.IList < String > userList List of user UPN's to validate in Azure AD Returns Task < PnP.Core.Model.SharePoint.IList < String >> A list of users that were not found in Azure AD Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IWebCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IWebCollection.html", @@ -2372,7 +2372,7 @@ "api/PnP.Core.Model.SharePoint.LongRunningOperationOptions.html": { "href": "api/PnP.Core.Model.SharePoint.LongRunningOperationOptions.html", "title": "Class LongRunningOperationOptions | PnP Core SDK", - "keywords": "Class LongRunningOperationOptions Defines the options that control the long running operation ILongRunningOperation polling Inheritance Object LongRunningOperationOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class LongRunningOperationOptions : object Properties MaxRetries Maximum number of retries, defaults to unlimited (so wait for the long operation to either succeed or fail) Declaration public int? MaxRetries { get; set; } Property Value Nullable < Int32 > WaitTimeInSeconds Time in seconds between each completion check, defaults to 5 if not set Declaration public int? WaitTimeInSeconds { get; set; } Property Value Nullable < Int32 >" + "keywords": "Class LongRunningOperationOptions Defines the options that control the long running operation ILongRunningOperation polling Inheritance System.Object LongRunningOperationOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class LongRunningOperationOptions : object Properties MaxRetries Maximum number of retries, defaults to unlimited (so wait for the long operation to either succeed or fail) Declaration public int? MaxRetries { get; set; } Property Value Nullable < Int32 > WaitTimeInSeconds Time in seconds between each completion check, defaults to 5 if not set Declaration public int? WaitTimeInSeconds { get; set; } Property Value Nullable < Int32 >" }, "api/PnP.Core.Model.SharePoint.MachineLearningPublicationViewOption.html": { "href": "api/PnP.Core.Model.SharePoint.MachineLearningPublicationViewOption.html", @@ -2387,7 +2387,7 @@ "api/PnP.Core.Model.SharePoint.MoveCopyOptions.html": { "href": "api/PnP.Core.Model.SharePoint.MoveCopyOptions.html", "title": "Class MoveCopyOptions | PnP Core SDK", - "keywords": "Class MoveCopyOptions Options for move and copy operations Inheritance Object MoveCopyOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class MoveCopyOptions : object Properties KeepBoth Indicates whether both resources should be kept if a resource already exists at the specified destination. If set to true then when the target file exists then a new file with a number suffix will added. Declaration public bool KeepBoth { get; set; } Property Value Boolean ResetAuthorAndCreatedOnCopy Indicates whether to reset author and creation datetime on the copied resource. Declaration public bool ResetAuthorAndCreatedOnCopy { get; set; } Property Value Boolean RetainEditorAndModifiedOnMove Indicates whether to retain the editor and last modified datatime on the moved resource. Declaration public bool RetainEditorAndModifiedOnMove { get; set; } Property Value Boolean ShouldBypassSharedLocks Indicates whether the shared locks on the source resource should be by passed. Declaration public bool ShouldBypassSharedLocks { get; set; } Property Value Boolean" + "keywords": "Class MoveCopyOptions Options for move and copy operations Inheritance System.Object MoveCopyOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class MoveCopyOptions : object Properties KeepBoth Indicates whether both resources should be kept if a resource already exists at the specified destination. If set to true then when the target file exists then a new file with a number suffix will added. Declaration public bool KeepBoth { get; set; } Property Value Boolean ResetAuthorAndCreatedOnCopy Indicates whether to reset author and creation datetime on the copied resource. Declaration public bool ResetAuthorAndCreatedOnCopy { get; set; } Property Value Boolean RetainEditorAndModifiedOnMove Indicates whether to retain the editor and last modified datatime on the moved resource. Declaration public bool RetainEditorAndModifiedOnMove { get; set; } Property Value Boolean ShouldBypassSharedLocks Indicates whether the shared locks on the source resource should be by passed. Declaration public bool ShouldBypassSharedLocks { get; set; } Property Value Boolean" }, "api/PnP.Core.Model.SharePoint.MoveOperations.html": { "href": "api/PnP.Core.Model.SharePoint.MoveOperations.html", @@ -2397,7 +2397,7 @@ "api/PnP.Core.Model.SharePoint.NavigationNodeOptions.html": { "href": "api/PnP.Core.Model.SharePoint.NavigationNodeOptions.html", "title": "Class NavigationNodeOptions | PnP Core SDK", - "keywords": "Class NavigationNodeOptions Options to set when creating a new navigation node Inheritance Object NavigationNodeOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class NavigationNodeOptions : object Properties AudienceIds Audiences for this navigation item (max 10). Note that Web.NavAudienceTargetingEnabled has to be set to true first. Declaration public List AudienceIds { get; set; } Property Value PnP.Core.Model.SharePoint.List < Guid > ParentNode Defines the parent node of the navigation node Declaration public INavigationNode ParentNode { get; set; } Property Value INavigationNode Title Title of the new node (e.g. Home) Declaration public string Title { get; set; } Property Value String Url Url of the navigationnode (e.g. https://contoso.sharepoint.com/sites/testsite ) Declaration public string Url { get; set; } Property Value String" + "keywords": "Class NavigationNodeOptions Options to set when creating a new navigation node Inheritance System.Object NavigationNodeOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class NavigationNodeOptions : object Properties AudienceIds Audiences for this navigation item (max 10). Note that Web.NavAudienceTargetingEnabled has to be set to true first. Declaration public List AudienceIds { get; set; } Property Value PnP.Core.Model.SharePoint.List < Guid > ParentNode Defines the parent node of the navigation node Declaration public INavigationNode ParentNode { get; set; } Property Value INavigationNode Title Title of the new node (e.g. Home) Declaration public string Title { get; set; } Property Value String Url Url of the navigationnode (e.g. https://contoso.sharepoint.com/sites/testsite ) Declaration public string Url { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.NavigationType.html": { "href": "api/PnP.Core.Model.SharePoint.NavigationType.html", @@ -2427,7 +2427,7 @@ "api/PnP.Core.Model.SharePoint.PageImageOptions.html": { "href": "api/PnP.Core.Model.SharePoint.PageImageOptions.html", "title": "Class PageImageOptions | PnP Core SDK", - "keywords": "Class PageImageOptions Defines the options to configure an image Inheritance Object PageImageOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class PageImageOptions : object Properties Alignment Defines the alignment of the image Declaration public PageImageAlignment Alignment { get; set; } Property Value PageImageAlignment AlternativeText Alternative text of the image Declaration public string AlternativeText { get; set; } Property Value String Caption Image caption to show underneath the embedded image Declaration public string Caption { get; set; } Property Value String Height Defines the actual height of the image Declaration public int? Height { get; set; } Property Value Nullable < Int32 > Link Link the image should point to on click Declaration public string Link { get; set; } Property Value String Width Defines the actual width of the image Declaration public int? Width { get; set; } Property Value Nullable < Int32 > WidthPercentage Defines the width of the image relative to editor control it's placed in. The Width , Height and this property need to be all set to end up to get a functional inline image. When using PnP.Core.Model.SharePoint.Page.EditorType equal to CK4 then the WidthPercentage property is not used. Declaration public int? WidthPercentage { get; set; } Property Value Nullable < Int32 >" + "keywords": "Class PageImageOptions Defines the options to configure an image Inheritance System.Object PageImageOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class PageImageOptions : object Properties Alignment Defines the alignment of the image Declaration public PageImageAlignment Alignment { get; set; } Property Value PageImageAlignment AlternativeText Alternative text of the image Declaration public string AlternativeText { get; set; } Property Value String Caption Image caption to show underneath the embedded image Declaration public string Caption { get; set; } Property Value String Height Defines the actual height of the image Declaration public int? Height { get; set; } Property Value Nullable < Int32 > Link Link the image should point to on click Declaration public string Link { get; set; } Property Value String Width Defines the actual width of the image Declaration public int? Width { get; set; } Property Value Nullable < Int32 > WidthPercentage Defines the width of the image relative to editor control it's placed in. The Width , Height and this property need to be all set to end up to get a functional inline image. When using PnP.Core.Model.SharePoint.Page.EditorType equal to CK4 then the WidthPercentage property is not used. Declaration public int? WidthPercentage { get; set; } Property Value Nullable < Int32 >" }, "api/PnP.Core.Model.SharePoint.PageLayoutType.html": { "href": "api/PnP.Core.Model.SharePoint.PageLayoutType.html", @@ -2437,7 +2437,7 @@ "api/PnP.Core.Model.SharePoint.PageTranslationOptions.html": { "href": "api/PnP.Core.Model.SharePoint.PageTranslationOptions.html", "title": "Class PageTranslationOptions | PnP Core SDK", - "keywords": "Class PageTranslationOptions Class that defines the languages for which a translation must be generated Inheritance Object PageTranslationOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class PageTranslationOptions : object Properties LanguageCodes List of languages to generate a translation for Declaration public List LanguageCodes { get; } Property Value PnP.Core.Model.SharePoint.List < String > Methods AddLanguage(Int32) Add a new language to the list of langauges to be generated. Note that this language must be a language configured for multi-lingual pages on the site Declaration public void AddLanguage(int languageId) Parameters Int32 languageId Id defining the language to add. See https://capacreative.co.uk/resources/reference-sharepoint-online-languages-ids/ for a list of possible languages" + "keywords": "Class PageTranslationOptions Class that defines the languages for which a translation must be generated Inheritance System.Object PageTranslationOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class PageTranslationOptions : object Properties LanguageCodes List of languages to generate a translation for Declaration public List LanguageCodes { get; } Property Value PnP.Core.Model.SharePoint.List < String > Methods AddLanguage(Int32) Add a new language to the list of langauges to be generated. Note that this language must be a language configured for multi-lingual pages on the site Declaration public void AddLanguage(int languageId) Parameters Int32 languageId Id defining the language to add. See https://capacreative.co.uk/resources/reference-sharepoint-online-languages-ids/ for a list of possible languages" }, "api/PnP.Core.Model.SharePoint.PermissionKind.html": { "href": "api/PnP.Core.Model.SharePoint.PermissionKind.html", @@ -2447,7 +2447,7 @@ "api/PnP.Core.Model.SharePoint.PreviewOptions.html": { "href": "api/PnP.Core.Model.SharePoint.PreviewOptions.html", "title": "Class PreviewOptions | PnP Core SDK", - "keywords": "Class PreviewOptions Options that define how the preview URL must be constructed Inheritance Object PreviewOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class PreviewOptions : object Properties Page Optional page number of document to start at, if applicable. Specified as string for future use cases around file types such as ZIP Declaration public string Page { get; set; } Property Value String Zoom Optional zoom level to start at, if applicable Declaration public int Zoom { get; set; } Property Value Int32" + "keywords": "Class PreviewOptions Options that define how the preview URL must be constructed Inheritance System.Object PreviewOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class PreviewOptions : object Properties Page Optional page number of document to start at, if applicable. Specified as string for future use cases around file types such as ZIP Declaration public string Page { get; set; } Property Value String Zoom Optional zoom level to start at, if applicable Declaration public int Zoom { get; set; } Property Value Int32" }, "api/PnP.Core.Model.SharePoint.PromotedState.html": { "href": "api/PnP.Core.Model.SharePoint.PromotedState.html", @@ -2462,17 +2462,17 @@ "api/PnP.Core.Model.SharePoint.QuickView.html": { "href": "api/PnP.Core.Model.SharePoint.QuickView.html", "title": "Class QuickView | PnP Core SDK", - "keywords": "Class QuickView Representation of ACE QuickView Inheritance Object QuickView Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class QuickView : object Properties Data Serialized data to be used with quick view template Declaration public string Data { get; set; } Property Value String DisplayName Display name of the quick view Declaration public string DisplayName { get; set; } Property Value String Id Identificator of the quick view Declaration public string Id { get; set; } Property Value String Template Serialized Adaptive Card template Declaration public string Template { get; set; } Property Value String" + "keywords": "Class QuickView Representation of ACE QuickView Inheritance System.Object QuickView Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class QuickView : object Properties Data Serialized data to be used with quick view template Declaration public string Data { get; set; } Property Value String DisplayName Display name of the quick view Declaration public string DisplayName { get; set; } Property Value String Id Identificator of the quick view Declaration public string Id { get; set; } Property Value String Template Serialized Adaptive Card template Declaration public string Template { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.QuickViewAction.html": { "href": "api/PnP.Core.Model.SharePoint.QuickViewAction.html", "title": "Class QuickViewAction | PnP Core SDK", - "keywords": "Class QuickViewAction Quick view ACE action Inheritance Object AdaptiveCardAction AdaptiveCardAction < QuickViewActionParameter > QuickViewAction Inherited Members AdaptiveCardAction.Parameters AdaptiveCardAction.Type Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class QuickViewAction : AdaptiveCardAction Constructors QuickViewAction() Default constructor Declaration public QuickViewAction()" + "keywords": "Class QuickViewAction Quick view ACE action Inheritance System.Object AdaptiveCardAction AdaptiveCardAction < QuickViewActionParameter > QuickViewAction Inherited Members AdaptiveCardAction.Parameters AdaptiveCardAction.Type Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class QuickViewAction : AdaptiveCardAction Constructors QuickViewAction() Default constructor Declaration public QuickViewAction()" }, "api/PnP.Core.Model.SharePoint.QuickViewActionParameter.html": { "href": "api/PnP.Core.Model.SharePoint.QuickViewActionParameter.html", "title": "Class QuickViewActionParameter | PnP Core SDK", - "keywords": "Class QuickViewActionParameter Quick view ACE action parameters Inheritance Object QuickViewActionParameter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class QuickViewActionParameter : object Properties View Selected view Declaration public string View { get; set; } Property Value String" + "keywords": "Class QuickViewActionParameter Quick view ACE action parameters Inheritance System.Object QuickViewActionParameter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class QuickViewActionParameter : object Properties View Selected view Declaration public string View { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.RecycleBinItemState.html": { "href": "api/PnP.Core.Model.SharePoint.RecycleBinItemState.html", @@ -2492,7 +2492,7 @@ "api/PnP.Core.Model.SharePoint.RecycleBinQueryOptions.html": { "href": "api/PnP.Core.Model.SharePoint.RecycleBinQueryOptions.html", "title": "Class RecycleBinQueryOptions | PnP Core SDK", - "keywords": "Class RecycleBinQueryOptions Defines the recycle bin query criteria Inheritance Object RecycleBinQueryOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class RecycleBinQueryOptions : object Properties IsAscending Gets or sets a Boolean value that specifies whether to sort in ascending order. Defaults to true. Declaration public bool IsAscending { get; set; } Property Value Boolean ItemState Gets or sets the Recycle Bin stage of items to return in the query. Defaults to FirstStageRecycleBin . Declaration public RecycleBinItemState ItemState { get; set; } Property Value RecycleBinItemState OrderBy Gets or sets the column by which to order the Recycle Bin query. Defaults to Title Declaration public RecycleBinOrderBy OrderBy { get; set; } Property Value RecycleBinOrderBy PagingInfo Gets or sets a string used to get the next set of rows in the page. Declaration public string PagingInfo { get; set; } Property Value String RowLimit Gets or sets a limit for the number of items returned in the query per page. Defaults to 50. Declaration public int RowLimit { get; set; } Property Value Int32 ShowOnlyMyItems Gets or sets a Boolean value that specifies whether to get items deleted by other users. Defaults to false. Declaration public bool ShowOnlyMyItems { get; set; } Property Value Boolean" + "keywords": "Class RecycleBinQueryOptions Defines the recycle bin query criteria Inheritance System.Object RecycleBinQueryOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class RecycleBinQueryOptions : object Properties IsAscending Gets or sets a Boolean value that specifies whether to sort in ascending order. Defaults to true. Declaration public bool IsAscending { get; set; } Property Value Boolean ItemState Gets or sets the Recycle Bin stage of items to return in the query. Defaults to FirstStageRecycleBin . Declaration public RecycleBinItemState ItemState { get; set; } Property Value RecycleBinItemState OrderBy Gets or sets the column by which to order the Recycle Bin query. Defaults to Title Declaration public RecycleBinOrderBy OrderBy { get; set; } Property Value RecycleBinOrderBy PagingInfo Gets or sets a string used to get the next set of rows in the page. Declaration public string PagingInfo { get; set; } Property Value String RowLimit Gets or sets a limit for the number of items returned in the query per page. Defaults to 50. Declaration public int RowLimit { get; set; } Property Value Int32 ShowOnlyMyItems Gets or sets a Boolean value that specifies whether to get items deleted by other users. Defaults to false. Declaration public bool ShowOnlyMyItems { get; set; } Property Value Boolean" }, "api/PnP.Core.Model.SharePoint.RelationshipDeleteBehaviorType.html": { "href": "api/PnP.Core.Model.SharePoint.RelationshipDeleteBehaviorType.html", @@ -2502,7 +2502,7 @@ "api/PnP.Core.Model.SharePoint.RenderListDataOptions.html": { "href": "api/PnP.Core.Model.SharePoint.RenderListDataOptions.html", "title": "Class RenderListDataOptions | PnP Core SDK", - "keywords": "Class RenderListDataOptions Options to configure the rendering of list data via the RenderListDataAsStream method of IList See https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest#renderlistdataasstream-body-parameter-properties Inheritance Object RenderListDataOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class RenderListDataOptions : object Properties AddRequiredFields Specifies if required fields should be returned or not Declaration public bool? AddRequiredFields { get; set; } Property Value Nullable < Boolean > AllowMultipleValueFilterForTaxonomyFields Specifies if multi value filtering is allowed for taxonomy fields or not Declaration public bool? AllowMultipleValueFilterForTaxonomyFields { get; set; } Property Value Nullable < Boolean > AudienceTarget Audience to use while processing this request Declaration public bool? AudienceTarget { get; set; } Property Value Nullable < Boolean > DatesInUtc Specifies if we return DateTime field in UTC or local time Declaration public bool? DatesInUtc { get; set; } Property Value Nullable < Boolean > DeferredRender Use a deferred render? Declaration public bool? DeferredRender { get; set; } Property Value Nullable < Boolean > ExpandGroups Specifies if the grouping should be expanded or not Declaration public bool? ExpandGroups { get; set; } Property Value Nullable < Boolean > FirstGroupOnly Specifies if only the first group should be returned or not (regardless of view schema) Declaration public bool? FirstGroupOnly { get; set; } Property Value Nullable < Boolean > FolderServerRelativeUrl Specifies the url to the folder from which to return items Declaration public string FolderServerRelativeUrl { get; set; } Property Value String ImageFieldsToTryRewriteToCdnUrls Comma-separated list of field names whose values should be rewritten to CDN URLs Declaration public string ImageFieldsToTryRewriteToCdnUrls { get; set; } Property Value String MergeDefaultView Merge with the default view? Declaration public bool? MergeDefaultView { get; set; } Property Value Nullable < Boolean > OriginalDate Return the original date? Declaration public bool? OriginalDate { get; set; } Property Value Nullable < Boolean > OverrideViewXml Specifies the override XML to be combined with the View CAML. Applies only to the Query/Where part of the View CAML Declaration public string OverrideViewXml { get; set; } Property Value String Paging Specifies the paging information Declaration public string Paging { get; set; } Property Value String RenderOptions Specifies the type of output to return Declaration public RenderListDataOptionsFlags? RenderOptions { get; set; } Property Value Nullable < RenderListDataOptionsFlags > ReplaceGroup Specifies if the grouping should be replaced or not to deal with GroupBy throttling Declaration public bool? ReplaceGroup { get; set; } Property Value Nullable < Boolean > ViewXml Specifies the CAML view XML Declaration public string ViewXml { get; set; } Property Value String Methods SetViewXmlFromFields(List) Populates the needed ViewXml based upon the passed field names Declaration public void SetViewXmlFromFields(List fieldInternalNames) Parameters PnP.Core.Model.SharePoint.List < String > fieldInternalNames List of fields specified via their internal name" + "keywords": "Class RenderListDataOptions Options to configure the rendering of list data via the RenderListDataAsStream method of IList See https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest#renderlistdataasstream-body-parameter-properties Inheritance System.Object RenderListDataOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class RenderListDataOptions : object Properties AddRequiredFields Specifies if required fields should be returned or not Declaration public bool? AddRequiredFields { get; set; } Property Value Nullable < Boolean > AllowMultipleValueFilterForTaxonomyFields Specifies if multi value filtering is allowed for taxonomy fields or not Declaration public bool? AllowMultipleValueFilterForTaxonomyFields { get; set; } Property Value Nullable < Boolean > AudienceTarget Audience to use while processing this request Declaration public bool? AudienceTarget { get; set; } Property Value Nullable < Boolean > DatesInUtc Specifies if we return DateTime field in UTC or local time Declaration public bool? DatesInUtc { get; set; } Property Value Nullable < Boolean > DeferredRender Use a deferred render? Declaration public bool? DeferredRender { get; set; } Property Value Nullable < Boolean > ExpandGroups Specifies if the grouping should be expanded or not Declaration public bool? ExpandGroups { get; set; } Property Value Nullable < Boolean > FirstGroupOnly Specifies if only the first group should be returned or not (regardless of view schema) Declaration public bool? FirstGroupOnly { get; set; } Property Value Nullable < Boolean > FolderServerRelativeUrl Specifies the url to the folder from which to return items Declaration public string FolderServerRelativeUrl { get; set; } Property Value String ImageFieldsToTryRewriteToCdnUrls Comma-separated list of field names whose values should be rewritten to CDN URLs Declaration public string ImageFieldsToTryRewriteToCdnUrls { get; set; } Property Value String MergeDefaultView Merge with the default view? Declaration public bool? MergeDefaultView { get; set; } Property Value Nullable < Boolean > OriginalDate Return the original date? Declaration public bool? OriginalDate { get; set; } Property Value Nullable < Boolean > OverrideViewXml Specifies the override XML to be combined with the View CAML. Applies only to the Query/Where part of the View CAML Declaration public string OverrideViewXml { get; set; } Property Value String Paging Specifies the paging information Declaration public string Paging { get; set; } Property Value String RenderOptions Specifies the type of output to return Declaration public RenderListDataOptionsFlags? RenderOptions { get; set; } Property Value Nullable < RenderListDataOptionsFlags > ReplaceGroup Specifies if the grouping should be replaced or not to deal with GroupBy throttling Declaration public bool? ReplaceGroup { get; set; } Property Value Nullable < Boolean > ViewXml Specifies the CAML view XML Declaration public string ViewXml { get; set; } Property Value String Methods SetViewXmlFromFields(List) Populates the needed ViewXml based upon the passed field names Declaration public void SetViewXmlFromFields(List fieldInternalNames) Parameters PnP.Core.Model.SharePoint.List < String > fieldInternalNames List of fields specified via their internal name" }, "api/PnP.Core.Model.SharePoint.RenderListDataOptionsFlags.html": { "href": "api/PnP.Core.Model.SharePoint.RenderListDataOptionsFlags.html", @@ -2527,7 +2527,7 @@ "api/PnP.Core.Model.SharePoint.SearchOptions.html": { "href": "api/PnP.Core.Model.SharePoint.SearchOptions.html", "title": "Class SearchOptions | PnP Core SDK", - "keywords": "Class SearchOptions Defines the search query to make Inheritance Object SearchOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class SearchOptions : object Constructors SearchOptions(String) Default constructor Declaration public SearchOptions(string query) Parameters String query Provide the query to issue Properties ClientType Client type used for the search query (defaults to ContentSearchRegular) Declaration public string ClientType { get; set; } Property Value String Query Search query to issue Declaration public string Query { get; } Property Value String RefinementFilters The set of refinement filters used when issuing a refinement query Declaration public List RefinementFilters { get; set; } Property Value PnP.Core.Model.SharePoint.List < String > RefineProperties Properties used to refine the search results Declaration public List RefineProperties { get; set; } Property Value PnP.Core.Model.SharePoint.List < String > ResultSourceId Result source id to use for the search query Declaration public string ResultSourceId { get; } Property Value String RowLimit Max number of rows to return Declaration public int? RowLimit { get; set; } Property Value Nullable < Int32 > RowsPerPage Rows to return per page. Defaults to 500 Declaration public int? RowsPerPage { get; set; } Property Value Nullable < Int32 > SelectProperties Properties to select Declaration public List SelectProperties { get; set; } Property Value PnP.Core.Model.SharePoint.List < String > SortProperties Properties to sort the query on Declaration public List SortProperties { get; set; } Property Value PnP.Core.Model.SharePoint.List < SortOption > StartRow Start row of the search result set Declaration public int? StartRow { get; set; } Property Value Nullable < Int32 > TrimDuplicates Trim duplicate search results Declaration public bool TrimDuplicates { get; set; } Property Value Boolean" + "keywords": "Class SearchOptions Defines the search query to make Inheritance System.Object SearchOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class SearchOptions : object Constructors SearchOptions(String) Default constructor Declaration public SearchOptions(string query) Parameters String query Provide the query to issue Properties ClientType Client type used for the search query (defaults to ContentSearchRegular) Declaration public string ClientType { get; set; } Property Value String Query Search query to issue Declaration public string Query { get; } Property Value String RefinementFilters The set of refinement filters used when issuing a refinement query Declaration public List RefinementFilters { get; set; } Property Value PnP.Core.Model.SharePoint.List < String > RefineProperties Properties used to refine the search results Declaration public List RefineProperties { get; set; } Property Value PnP.Core.Model.SharePoint.List < String > ResultSourceId Result source id to use for the search query Declaration public string ResultSourceId { get; } Property Value String RowLimit Max number of rows to return Declaration public int? RowLimit { get; set; } Property Value Nullable < Int32 > RowsPerPage Rows to return per page. Defaults to 500 Declaration public int? RowsPerPage { get; set; } Property Value Nullable < Int32 > SelectProperties Properties to select Declaration public List SelectProperties { get; set; } Property Value PnP.Core.Model.SharePoint.List < String > SortProperties Properties to sort the query on Declaration public List SortProperties { get; set; } Property Value PnP.Core.Model.SharePoint.List < SortOption > StartRow Start row of the search result set Declaration public int? StartRow { get; set; } Property Value Nullable < Int32 > TrimDuplicates Trim duplicate search results Declaration public bool TrimDuplicates { get; set; } Property Value Boolean" }, "api/PnP.Core.Model.SharePoint.SearchScope.html": { "href": "api/PnP.Core.Model.SharePoint.SearchScope.html", @@ -2577,7 +2577,7 @@ "api/PnP.Core.Model.SharePoint.SortOption.html": { "href": "api/PnP.Core.Model.SharePoint.SortOption.html", "title": "Class SortOption | PnP Core SDK", - "keywords": "Class SortOption Defines a field to be used for sorting search query results Inheritance Object SortOption Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class SortOption : object Constructors SortOption(String) Creates SortOption class, defaults to ascending sort order Declaration public SortOption(string property) Parameters String property Property to sort on SortOption(String, SortDirection) Creates SortOption class Declaration public SortOption(string property, SortDirection sort) Parameters String property Property to sort on SortDirection sort Sort order to use Properties Property Property to sort on Declaration public string Property { get; } Property Value String Sort Sort order to use Declaration public SortDirection Sort { get; } Property Value SortDirection Methods ToString() Returns the sort option so it can be used in a search query Declaration public override string ToString() Returns String Sort option to use in a query" + "keywords": "Class SortOption Defines a field to be used for sorting search query results Inheritance System.Object SortOption Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class SortOption : object Constructors SortOption(String) Creates SortOption class, defaults to ascending sort order Declaration public SortOption(string property) Parameters String property Property to sort on SortOption(String, SortDirection) Creates SortOption class Declaration public SortOption(string property, SortDirection sort) Parameters String property Property to sort on SortDirection sort Sort order to use Properties Property Property to sort on Declaration public string Property { get; } Property Value String Sort Sort order to use Declaration public SortDirection Sort { get; } Property Value SortDirection Methods ToString() Returns the sort option so it can be used in a search query Declaration public override string ToString() Returns String Sort option to use in a query" }, "api/PnP.Core.Model.SharePoint.SPEffectiveInformationRightsManagementSettingsSource.html": { "href": "api/PnP.Core.Model.SharePoint.SPEffectiveInformationRightsManagementSettingsSource.html", @@ -2592,37 +2592,37 @@ "api/PnP.Core.Model.SharePoint.SyntexModelPublishOptions.html": { "href": "api/PnP.Core.Model.SharePoint.SyntexModelPublishOptions.html", "title": "Class SyntexModelPublishOptions | PnP Core SDK", - "keywords": "Class SyntexModelPublishOptions Information about the library to publish a Syntex model to Inheritance Object SyntexModelUnPublishOptions SyntexModelPublishOptions Inherited Members SyntexModelUnPublishOptions.TargetLibraryServerRelativeUrl SyntexModelUnPublishOptions.TargetSiteUrl SyntexModelUnPublishOptions.TargetWebServerRelativeUrl Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class SyntexModelPublishOptions : SyntexModelUnPublishOptions Constructors SyntexModelPublishOptions() Default constructor Declaration public SyntexModelPublishOptions() Properties ViewOption The view option specified when registering the model with the library Declaration public MachineLearningPublicationViewOption ViewOption { get; set; } Property Value MachineLearningPublicationViewOption" + "keywords": "Class SyntexModelPublishOptions Information about the library to publish a Syntex model to Inheritance System.Object SyntexModelUnPublishOptions SyntexModelPublishOptions Inherited Members SyntexModelUnPublishOptions.TargetLibraryServerRelativeUrl SyntexModelUnPublishOptions.TargetSiteUrl SyntexModelUnPublishOptions.TargetWebServerRelativeUrl Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class SyntexModelPublishOptions : SyntexModelUnPublishOptions Constructors SyntexModelPublishOptions() Default constructor Declaration public SyntexModelPublishOptions() Properties ViewOption The view option specified when registering the model with the library Declaration public MachineLearningPublicationViewOption ViewOption { get; set; } Property Value MachineLearningPublicationViewOption" }, "api/PnP.Core.Model.SharePoint.SyntexModelUnPublishOptions.html": { "href": "api/PnP.Core.Model.SharePoint.SyntexModelUnPublishOptions.html", "title": "Class SyntexModelUnPublishOptions | PnP Core SDK", - "keywords": "Class SyntexModelUnPublishOptions Information about the library to unpublish a Syntex model from Inheritance Object SyntexModelUnPublishOptions SyntexModelPublishOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class SyntexModelUnPublishOptions : object Constructors SyntexModelUnPublishOptions() Default constructor Declaration public SyntexModelUnPublishOptions() Properties TargetLibraryServerRelativeUrl Server relative url of the library registered with the model Declaration public string TargetLibraryServerRelativeUrl { get; set; } Property Value String TargetSiteUrl Fully qualified URL of the site collection holding the library registered with the model Declaration public string TargetSiteUrl { get; set; } Property Value String TargetWebServerRelativeUrl Server relative url of the web holding the library registered with the model Declaration public string TargetWebServerRelativeUrl { get; set; } Property Value String" + "keywords": "Class SyntexModelUnPublishOptions Information about the library to unpublish a Syntex model from Inheritance System.Object SyntexModelUnPublishOptions SyntexModelPublishOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class SyntexModelUnPublishOptions : object Constructors SyntexModelUnPublishOptions() Default constructor Declaration public SyntexModelUnPublishOptions() Properties TargetLibraryServerRelativeUrl Server relative url of the library registered with the model Declaration public string TargetLibraryServerRelativeUrl { get; set; } Property Value String TargetSiteUrl Fully qualified URL of the site collection holding the library registered with the model Declaration public string TargetSiteUrl { get; set; } Property Value String TargetWebServerRelativeUrl Server relative url of the web holding the library registered with the model Declaration public string TargetWebServerRelativeUrl { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.TeamsACE.html": { "href": "api/PnP.Core.Model.SharePoint.TeamsACE.html", "title": "Class TeamsACE | PnP Core SDK", - "keywords": "Class TeamsACE Represents Teams App ACE Inheritance Object AdaptiveCardExtension AdaptiveCardExtension < TeamsACEProperties > TeamsACE Inherited Members AdaptiveCardExtension.Properties AdaptiveCardExtension.Id AdaptiveCardExtension.InstanceId AdaptiveCardExtension.Title AdaptiveCardExtension.Description AdaptiveCardExtension.JsonProperties AdaptiveCardExtension.IconProperty AdaptiveCardExtension.CardSize AdaptiveCardExtension.Order AdaptiveCardExtension.ACEType Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class TeamsACE : AdaptiveCardExtension Constructors TeamsACE(CardSize) Default constructor Declaration public TeamsACE(CardSize cardSize = default(CardSize)) Parameters CardSize cardSize" + "keywords": "Class TeamsACE Represents Teams App ACE Inheritance System.Object AdaptiveCardExtension AdaptiveCardExtension < TeamsACEProperties > TeamsACE Inherited Members AdaptiveCardExtension.Properties AdaptiveCardExtension.Id AdaptiveCardExtension.InstanceId AdaptiveCardExtension.Title AdaptiveCardExtension.Description AdaptiveCardExtension.JsonProperties AdaptiveCardExtension.IconProperty AdaptiveCardExtension.CardSize AdaptiveCardExtension.Order AdaptiveCardExtension.ACEType Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class TeamsACE : AdaptiveCardExtension Constructors TeamsACE(CardSize) Default constructor Declaration public TeamsACE(CardSize cardSize = default(CardSize)) Parameters CardSize cardSize" }, "api/PnP.Core.Model.SharePoint.TeamsACEApp.html": { "href": "api/PnP.Core.Model.SharePoint.TeamsACEApp.html", "title": "Class TeamsACEApp | PnP Core SDK", - "keywords": "Class TeamsACEApp Teams ACE app Inheritance Object TeamsACEApp Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class TeamsACEApp : object Properties AppId ACE app id Declaration public string AppId { get; set; } Property Value String Description ACE description Declaration public string Description { get; set; } Property Value String DistributionMethod ACE distributionmethod Declaration public string DistributionMethod { get; set; } Property Value String IconProperties ACE icon properties Declaration public TeamsACEAppIconProperties IconProperties { get; set; } Property Value TeamsACEAppIconProperties IsBot ACE is bot Declaration public bool IsBot { get; set; } Property Value Boolean Title ACE title Declaration public string Title { get; set; } Property Value String" + "keywords": "Class TeamsACEApp Teams ACE app Inheritance System.Object TeamsACEApp Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class TeamsACEApp : object Properties AppId ACE app id Declaration public string AppId { get; set; } Property Value String Description ACE description Declaration public string Description { get; set; } Property Value String DistributionMethod ACE distributionmethod Declaration public string DistributionMethod { get; set; } Property Value String IconProperties ACE icon properties Declaration public TeamsACEAppIconProperties IconProperties { get; set; } Property Value TeamsACEAppIconProperties IsBot ACE is bot Declaration public bool IsBot { get; set; } Property Value Boolean Title ACE title Declaration public string Title { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.TeamsACEAppIconProperties.html": { "href": "api/PnP.Core.Model.SharePoint.TeamsACEAppIconProperties.html", "title": "Class TeamsACEAppIconProperties | PnP Core SDK", - "keywords": "Class TeamsACEAppIconProperties Teams ACE app icon properties Inheritance Object TeamsACEAppIconProperties Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class TeamsACEAppIconProperties : object Properties ColorIconWebUrl Color icon web url Declaration public string ColorIconWebUrl { get; set; } Property Value String OutlineIconWebUrl Outline icon web url Declaration public string OutlineIconWebUrl { get; set; } Property Value String" + "keywords": "Class TeamsACEAppIconProperties Teams ACE app icon properties Inheritance System.Object TeamsACEAppIconProperties Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class TeamsACEAppIconProperties : object Properties ColorIconWebUrl Color icon web url Declaration public string ColorIconWebUrl { get; set; } Property Value String OutlineIconWebUrl Outline icon web url Declaration public string OutlineIconWebUrl { get; set; } Property Value String" }, "api/PnP.Core.Model.SharePoint.TeamsACEFactory.html": { "href": "api/PnP.Core.Model.SharePoint.TeamsACEFactory.html", "title": "Class TeamsACEFactory | PnP Core SDK", - "keywords": "Class TeamsACEFactory Creates new instance of TeamsACE based on provided WebPart Inheritance Object ACEFactory TeamsACEFactory Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class TeamsACEFactory : ACEFactory Properties ACEId Id of Teams AdaptiveCardExtension Declaration public override string ACEId { get; } Property Value String Overrides ACEFactory.ACEId Methods BuildACEFromWebPart(IPageWebPart) Returns TeamsACE Declaration public override AdaptiveCardExtension BuildACEFromWebPart(IPageWebPart control) Parameters IPageWebPart control WebPart used to store ACE configuration Returns AdaptiveCardExtension Overrides ACEFactory.BuildACEFromWebPart(IPageWebPart)" + "keywords": "Class TeamsACEFactory Creates new instance of TeamsACE based on provided WebPart Inheritance System.Object ACEFactory TeamsACEFactory Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class TeamsACEFactory : ACEFactory Properties ACEId Id of Teams AdaptiveCardExtension Declaration public override string ACEId { get; } Property Value String Overrides ACEFactory.ACEId Methods BuildACEFromWebPart(IPageWebPart) Returns TeamsACE Declaration public override AdaptiveCardExtension BuildACEFromWebPart(IPageWebPart control) Parameters IPageWebPart control WebPart used to store ACE configuration Returns AdaptiveCardExtension Overrides ACEFactory.BuildACEFromWebPart(IPageWebPart)" }, "api/PnP.Core.Model.SharePoint.TeamsACEProperties.html": { "href": "api/PnP.Core.Model.SharePoint.TeamsACEProperties.html", "title": "Class TeamsACEProperties | PnP Core SDK", - "keywords": "Class TeamsACEProperties Teams ACE Properties Inheritance Object ACEProperties TeamsACEProperties Inherited Members ACEProperties.AceData ACEProperties.Title ACEProperties.Description ACEProperties.IconProperty Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class TeamsACEProperties : ACEProperties Properties SelectedApp Teams ACE app Declaration public TeamsACEApp SelectedApp { get; set; } Property Value TeamsACEApp" + "keywords": "Class TeamsACEProperties Teams ACE Properties Inheritance System.Object ACEProperties TeamsACEProperties Inherited Members ACEProperties.AceData ACEProperties.Title ACEProperties.Description ACEProperties.IconProperty Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class TeamsACEProperties : ACEProperties Properties SelectedApp Teams ACE app Declaration public TeamsACEApp SelectedApp { get; set; } Property Value TeamsACEApp" }, "api/PnP.Core.Model.SharePoint.TemplateFileType.html": { "href": "api/PnP.Core.Model.SharePoint.TemplateFileType.html", @@ -2642,7 +2642,7 @@ "api/PnP.Core.Model.SharePoint.ThumbnailOptions.html": { "href": "api/PnP.Core.Model.SharePoint.ThumbnailOptions.html", "title": "Class ThumbnailOptions | PnP Core SDK", - "keywords": "Class ThumbnailOptions Options to define the file thumbnail retrieval Inheritance Object ThumbnailOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ThumbnailOptions : object Properties CustomSizes Custom size(s) of the thumbnail to get Declaration public List CustomSizes { get; set; } Property Value PnP.Core.Model.SharePoint.List < CustomThumbnailOptions > StandardSizes Standard size(s) of the thumbnail to get Declaration public List StandardSizes { get; set; } Property Value PnP.Core.Model.SharePoint.List < ThumbnailSize >" + "keywords": "Class ThumbnailOptions Options to define the file thumbnail retrieval Inheritance System.Object ThumbnailOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ThumbnailOptions : object Properties CustomSizes Custom size(s) of the thumbnail to get Declaration public List CustomSizes { get; set; } Property Value PnP.Core.Model.SharePoint.List < CustomThumbnailOptions > StandardSizes Standard size(s) of the thumbnail to get Declaration public List StandardSizes { get; set; } Property Value PnP.Core.Model.SharePoint.List < ThumbnailSize >" }, "api/PnP.Core.Model.SharePoint.ThumbnailSize.html": { "href": "api/PnP.Core.Model.SharePoint.ThumbnailSize.html", @@ -2657,7 +2657,7 @@ "api/PnP.Core.Model.SharePoint.UnfurlOptions.html": { "href": "api/PnP.Core.Model.SharePoint.UnfurlOptions.html", "title": "Class UnfurlOptions | PnP Core SDK", - "keywords": "Class UnfurlOptions Link unfurling options Inheritance Object UnfurlOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class UnfurlOptions : object Properties ThumbnailOptions Optionally set specific options for the retrieved thumbnails Declaration public ThumbnailOptions ThumbnailOptions { get; set; } Property Value ThumbnailOptions" + "keywords": "Class UnfurlOptions Link unfurling options Inheritance System.Object UnfurlOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class UnfurlOptions : object Properties ThumbnailOptions Optionally set specific options for the retrieved thumbnails Declaration public ThumbnailOptions ThumbnailOptions { get; set; } Property Value ThumbnailOptions" }, "api/PnP.Core.Model.SharePoint.UrlFieldFormatType.html": { "href": "api/PnP.Core.Model.SharePoint.UrlFieldFormatType.html", @@ -2682,7 +2682,7 @@ "api/PnP.Core.Model.SharePoint.ViewOptions.html": { "href": "api/PnP.Core.Model.SharePoint.ViewOptions.html", "title": "Class ViewOptions | PnP Core SDK", - "keywords": "Class ViewOptions Options for creating a view Inheritance Object ViewOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ViewOptions : object Properties AssociatedContentTypeId Gets or sets the associated content type id Declaration public string AssociatedContentTypeId { get; set; } Property Value String BaseViewId Gets or sets the base view Id Declaration public int? BaseViewId { get; set; } Property Value Nullable < Int32 > CalendarViewStyles Gets of sets the Calendar view styles Declaration public string CalendarViewStyles { get; set; } Property Value String Paged Gets or sets a value that specifies whether the new list view is a paged view. Declaration public bool Paged { get; set; } Property Value Boolean PersonalView Gets or sets a value that specifies whether the new list view is a personal view. If the value is false, the new list view is a public view. Declaration public bool PersonalView { get; set; } Property Value Boolean Query Gets or sets a value that specifies the query for the new list view. Declaration public string Query { get; set; } Property Value String RowLimit Gets or sets a value that specifies the maximum number of list items that the new list view displays on a visual page of the list view. Declaration public int? RowLimit { get; set; } Property Value Nullable < Int32 > SetAsDefaultView Gets or sets a value that specifies whether the new list view is the default list view. Declaration public bool SetAsDefaultView { get; set; } Property Value Boolean Title Gets or sets the value that specifies the display name of the new list view. Declaration public string Title { get; set; } Property Value String ViewData Gets or sets the view data Declaration public string ViewData { get; set; } Property Value String ViewFields Gets or sets the value that specifies the collection of field internal names for the list fields in the new list view. Declaration public string[] ViewFields { get; set; } Property Value String [] ViewType2 Gets or sets the View Type 2 information Declaration public ViewType2 ViewType2 { get; set; } Property Value ViewType2 ViewTypeKind Gets or sets a value that specifies the type of the new list view. Declaration public ViewTypeKind ViewTypeKind { get; set; } Property Value ViewTypeKind" + "keywords": "Class ViewOptions Options for creating a view Inheritance System.Object ViewOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class ViewOptions : object Properties AssociatedContentTypeId Gets or sets the associated content type id Declaration public string AssociatedContentTypeId { get; set; } Property Value String BaseViewId Gets or sets the base view Id Declaration public int? BaseViewId { get; set; } Property Value Nullable < Int32 > CalendarViewStyles Gets of sets the Calendar view styles Declaration public string CalendarViewStyles { get; set; } Property Value String Paged Gets or sets a value that specifies whether the new list view is a paged view. Declaration public bool Paged { get; set; } Property Value Boolean PersonalView Gets or sets a value that specifies whether the new list view is a personal view. If the value is false, the new list view is a public view. Declaration public bool PersonalView { get; set; } Property Value Boolean Query Gets or sets a value that specifies the query for the new list view. Declaration public string Query { get; set; } Property Value String RowLimit Gets or sets a value that specifies the maximum number of list items that the new list view displays on a visual page of the list view. Declaration public int? RowLimit { get; set; } Property Value Nullable < Int32 > SetAsDefaultView Gets or sets a value that specifies whether the new list view is the default list view. Declaration public bool SetAsDefaultView { get; set; } Property Value Boolean Title Gets or sets the value that specifies the display name of the new list view. Declaration public string Title { get; set; } Property Value String ViewData Gets or sets the view data Declaration public string ViewData { get; set; } Property Value String ViewFields Gets or sets the value that specifies the collection of field internal names for the list fields in the new list view. Declaration public string[] ViewFields { get; set; } Property Value String [] ViewType2 Gets or sets the View Type 2 information Declaration public ViewType2 ViewType2 { get; set; } Property Value ViewType2 ViewTypeKind Gets or sets a value that specifies the type of the new list view. Declaration public ViewTypeKind ViewTypeKind { get; set; } Property Value ViewTypeKind" }, "api/PnP.Core.Model.SharePoint.ViewScope.html": { "href": "api/PnP.Core.Model.SharePoint.ViewScope.html", @@ -2707,12 +2707,12 @@ "api/PnP.Core.Model.SharePoint.WebOptions.html": { "href": "api/PnP.Core.Model.SharePoint.WebOptions.html", "title": "Class WebOptions | PnP Core SDK", - "keywords": "Class WebOptions Options to set when creating a new web Inheritance Object WebOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class WebOptions : object Properties Description Description to set on the new web Declaration public string Description { get; set; } Property Value String InheritPermissions Inherit permissions from the current web, defaults to true. Declaration public bool InheritPermissions { get; set; } Property Value Boolean Language Language to set for the new web, defaults to 1033 Declaration public int Language { get; set; } Property Value Int32 Template The site template to use for the new web (e.g. STS#3) Declaration public string Template { get; set; } Property Value String Title Title of the new web (e.g. My Sub Web) Declaration public string Title { get; set; } Property Value String Url Relative url of the new web (e.g. mysubweb) Declaration public string Url { get; set; } Property Value String" + "keywords": "Class WebOptions Options to set when creating a new web Inheritance System.Object WebOptions Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class WebOptions : object Properties Description Description to set on the new web Declaration public string Description { get; set; } Property Value String InheritPermissions Inherit permissions from the current web, defaults to true. Declaration public bool InheritPermissions { get; set; } Property Value Boolean Language Language to set for the new web, defaults to 1033 Declaration public int Language { get; set; } Property Value Int32 Template The site template to use for the new web (e.g. STS#3) Declaration public string Template { get; set; } Property Value String Title Title of the new web (e.g. My Sub Web) Declaration public string Title { get; set; } Property Value String Url Relative url of the new web (e.g. mysubweb) Declaration public string Url { get; set; } Property Value String" }, "api/PnP.Core.Model.Teams.ChatMessageAttachmentOptions.html": { "href": "api/PnP.Core.Model.Teams.ChatMessageAttachmentOptions.html", "title": "Class ChatMessageAttachmentOptions | PnP Core SDK", - "keywords": "Class ChatMessageAttachmentOptions Chat message attachment Inheritance Object ChatMessageAttachmentOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class ChatMessageAttachmentOptions : object Properties Content The content of the attachment. If the attachment is a rich card, set the property to the rich card object. This property and contentUrl are mutually exclusive. Declaration public string Content { get; set; } Property Value String ContentType The media type of the content attachment. Declaration public string ContentType { get; set; } Property Value String ContentUrl URL for the content of the attachment. Supported protocols: http, https, file and data. Declaration public Uri ContentUrl { get; set; } Property Value Uri Id Unique id of the attachment. Declaration public string Id { get; set; } Property Value String Name Name of the attachment. Declaration public string Name { get; set; } Property Value String ThumbnailUrl URL to a thumbnail image that the channel can use if it supports using an alternative, smaller form of content or contentUrl. For example, if you set contentType to application/word and set contentUrl to the location of the Word document, you might include a thumbnail image that represents the document. The channel could display the thumbnail image instead of the document. When the user clicks the image, the channel would open the document. Declaration public Uri ThumbnailUrl { get; set; } Property Value Uri" + "keywords": "Class ChatMessageAttachmentOptions Chat message attachment Inheritance System.Object ChatMessageAttachmentOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class ChatMessageAttachmentOptions : object Properties Content The content of the attachment. If the attachment is a rich card, set the property to the rich card object. This property and contentUrl are mutually exclusive. Declaration public string Content { get; set; } Property Value String ContentType The media type of the content attachment. Declaration public string ContentType { get; set; } Property Value String ContentUrl URL for the content of the attachment. Supported protocols: http, https, file and data. Declaration public Uri ContentUrl { get; set; } Property Value Uri Id Unique id of the attachment. Declaration public string Id { get; set; } Property Value String Name Name of the attachment. Declaration public string Name { get; set; } Property Value String ThumbnailUrl URL to a thumbnail image that the channel can use if it supports using an alternative, smaller form of content or contentUrl. For example, if you set contentType to application/word and set contentUrl to the location of the Word document, you might include a thumbnail image that represents the document. The channel could display the thumbnail image instead of the document. When the user clicks the image, the channel would open the document. Declaration public Uri ThumbnailUrl { get; set; } Property Value Uri" }, "api/PnP.Core.Model.Teams.ChatMessageContentType.html": { "href": "api/PnP.Core.Model.Teams.ChatMessageContentType.html", @@ -2722,7 +2722,7 @@ "api/PnP.Core.Model.Teams.ChatMessageHostedContentOptions.html": { "href": "api/PnP.Core.Model.Teams.ChatMessageHostedContentOptions.html", "title": "Class ChatMessageHostedContentOptions | PnP Core SDK", - "keywords": "Class ChatMessageHostedContentOptions Chat Message Hosted Content options Inheritance Object ChatMessageHostedContentOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class ChatMessageHostedContentOptions : object Properties ContentBytes Hosted content bytes Declaration public string ContentBytes { get; set; } Property Value String ContentType Hosted content type Declaration public string ContentType { get; set; } Property Value String Id Hosted Content Id Declaration public string Id { get; set; } Property Value String" + "keywords": "Class ChatMessageHostedContentOptions Chat Message Hosted Content options Inheritance System.Object ChatMessageHostedContentOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class ChatMessageHostedContentOptions : object Properties ContentBytes Hosted content bytes Declaration public string ContentBytes { get; set; } Property Value String ContentType Hosted content type Declaration public string ContentType { get; set; } Property Value String Id Hosted Content Id Declaration public string Id { get; set; } Property Value String" }, "api/PnP.Core.Model.Teams.ChatMessageImportance.html": { "href": "api/PnP.Core.Model.Teams.ChatMessageImportance.html", @@ -2732,12 +2732,12 @@ "api/PnP.Core.Model.Teams.ChatMessageMentionOptions.html": { "href": "api/PnP.Core.Model.Teams.ChatMessageMentionOptions.html", "title": "Class ChatMessageMentionOptions | PnP Core SDK", - "keywords": "Class ChatMessageMentionOptions Chat message mention options Inheritance Object ChatMessageMentionOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class ChatMessageMentionOptions : object Properties Id Index of an entity being mentioned in the specified chatMessage. Declaration public int Id { get; set; } Property Value Int32 Mentioned The entity (user, application, team, or channel) that was mentioned. If it was a channel or team that was @mentioned, the identitySet contains a conversation property giving the ID of the team/channel, and a conversationIdentityType property that represents either the team or channel. Declaration public ITeamChatMessageMentionedIdentitySet Mentioned { get; set; } Property Value ITeamChatMessageMentionedIdentitySet MentionText String used to represent the mention. For example, a user's display name, a team name. Declaration public string MentionText { get; set; } Property Value String" + "keywords": "Class ChatMessageMentionOptions Chat message mention options Inheritance System.Object ChatMessageMentionOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class ChatMessageMentionOptions : object Properties Id Index of an entity being mentioned in the specified chatMessage. Declaration public int Id { get; set; } Property Value Int32 Mentioned The entity (user, application, team, or channel) that was mentioned. If it was a channel or team that was @mentioned, the identitySet contains a conversation property giving the ID of the team/channel, and a conversationIdentityType property that represents either the team or channel. Declaration public ITeamChatMessageMentionedIdentitySet Mentioned { get; set; } Property Value ITeamChatMessageMentionedIdentitySet MentionText String used to represent the mention. For example, a user's display name, a team name. Declaration public string MentionText { get; set; } Property Value String" }, "api/PnP.Core.Model.Teams.ChatMessageOptions.html": { "href": "api/PnP.Core.Model.Teams.ChatMessageOptions.html", "title": "Class ChatMessageOptions | PnP Core SDK", - "keywords": "Class ChatMessageOptions Chat Message options Inheritance Object ChatMessageOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class ChatMessageOptions : object Properties Attachments Attachment options Declaration public List Attachments { get; } Property Value List < ChatMessageAttachmentOptions > Content Message content Declaration public string Content { get; set; } Property Value String ContentType Type of the message content Declaration public ChatMessageContentType ContentType { get; set; } Property Value ChatMessageContentType HostedContents Message hosted content options Declaration public List HostedContents { get; } Property Value List < ChatMessageHostedContentOptions > Mentions Mention options Declaration public List Mentions { get; } Property Value List < ChatMessageMentionOptions > Subject Message Subject Declaration public string Subject { get; set; } Property Value String" + "keywords": "Class ChatMessageOptions Chat Message options Inheritance System.Object ChatMessageOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class ChatMessageOptions : object Properties Attachments Attachment options Declaration public List Attachments { get; } Property Value List < ChatMessageAttachmentOptions > Content Message content Declaration public string Content { get; set; } Property Value String ContentType Type of the message content Declaration public ChatMessageContentType ContentType { get; set; } Property Value ChatMessageContentType HostedContents Message hosted content options Declaration public List HostedContents { get; } Property Value List < ChatMessageHostedContentOptions > Mentions Mention options Declaration public List Mentions { get; } Property Value List < ChatMessageMentionOptions > Subject Message Subject Declaration public string Subject { get; set; } Property Value String" }, "api/PnP.Core.Model.Teams.ChatMessageReactionType.html": { "href": "api/PnP.Core.Model.Teams.ChatMessageReactionType.html", @@ -2752,12 +2752,12 @@ "api/PnP.Core.Model.Teams.EventAddressOptions.html": { "href": "api/PnP.Core.Model.Teams.EventAddressOptions.html", "title": "Class EventAddressOptions | PnP Core SDK", - "keywords": "Class EventAddressOptions Options that can be set when creating an address location for a meeting request Inheritance Object EventAddressOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventAddressOptions : object Properties City City Declaration public string City { get; set; } Property Value String CountryOrRegion Country Or Region Declaration public string CountryOrRegion { get; set; } Property Value String PostalCode PostalCode Declaration public string PostalCode { get; set; } Property Value String State State Declaration public string State { get; set; } Property Value String Street Street Declaration public string Street { get; set; } Property Value String" + "keywords": "Class EventAddressOptions Options that can be set when creating an address location for a meeting request Inheritance System.Object EventAddressOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventAddressOptions : object Properties City City Declaration public string City { get; set; } Property Value String CountryOrRegion Country Or Region Declaration public string CountryOrRegion { get; set; } Property Value String PostalCode PostalCode Declaration public string PostalCode { get; set; } Property Value String State State Declaration public string State { get; set; } Property Value String Street Street Declaration public string Street { get; set; } Property Value String" }, "api/PnP.Core.Model.Teams.EventAttendeeOptions.html": { "href": "api/PnP.Core.Model.Teams.EventAttendeeOptions.html", "title": "Class EventAttendeeOptions | PnP Core SDK", - "keywords": "Class EventAttendeeOptions Options that can be set for the attendees Inheritance Object EventAttendeeOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventAttendeeOptions : object Properties EmailAddress Mail address Declaration public string EmailAddress { get; set; } Property Value String Name Name Declaration public string Name { get; set; } Property Value String Type Type Declaration public EventAttendeeType Type { get; set; } Property Value EventAttendeeType" + "keywords": "Class EventAttendeeOptions Options that can be set for the attendees Inheritance System.Object EventAttendeeOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventAttendeeOptions : object Properties EmailAddress Mail address Declaration public string EmailAddress { get; set; } Property Value String Name Name Declaration public string Name { get; set; } Property Value String Type Type Declaration public EventAttendeeType Type { get; set; } Property Value EventAttendeeType" }, "api/PnP.Core.Model.Teams.EventAttendeeType.html": { "href": "api/PnP.Core.Model.Teams.EventAttendeeType.html", @@ -2772,12 +2772,12 @@ "api/PnP.Core.Model.Teams.EventCoordinateOptions.html": { "href": "api/PnP.Core.Model.Teams.EventCoordinateOptions.html", "title": "Class EventCoordinateOptions | PnP Core SDK", - "keywords": "Class EventCoordinateOptions Options that can be set when creating a coordinate location for a meeting request Inheritance Object EventCoordinateOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventCoordinateOptions : object Properties Accuracy Accuracy Declaration public double Accuracy { get; set; } Property Value Double Altitude Altitude Declaration public double Altitude { get; set; } Property Value Double AltitudeAccuracy Altitude Accuracy Declaration public double AltitudeAccuracy { get; set; } Property Value Double Latitude Latitude Declaration public double Latitude { get; set; } Property Value Double Longitude Longitude Declaration public double Longitude { get; set; } Property Value Double" + "keywords": "Class EventCoordinateOptions Options that can be set when creating a coordinate location for a meeting request Inheritance System.Object EventCoordinateOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventCoordinateOptions : object Properties Accuracy Accuracy Declaration public double Accuracy { get; set; } Property Value Double Altitude Altitude Declaration public double Altitude { get; set; } Property Value Double AltitudeAccuracy Altitude Accuracy Declaration public double AltitudeAccuracy { get; set; } Property Value Double Latitude Latitude Declaration public double Latitude { get; set; } Property Value Double Longitude Longitude Declaration public double Longitude { get; set; } Property Value Double" }, "api/PnP.Core.Model.Teams.EventCreateOptions.html": { "href": "api/PnP.Core.Model.Teams.EventCreateOptions.html", "title": "Class EventCreateOptions | PnP Core SDK", - "keywords": "Class EventCreateOptions Options that can be set when creating a meeting request Inheritance Object EventCreateOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventCreateOptions : object Properties AllowNewTimeProposals Allow new time proposals Declaration public bool AllowNewTimeProposals { get; set; } Property Value Boolean Attendees List of attendees to be invited to the meeting Declaration public List Attendees { get; set; } Property Value List < EventAttendeeOptions > Body Body message Declaration public string Body { get; set; } Property Value String BodyContentType Body content type Declaration public EventBodyType BodyContentType { get; } Property Value EventBodyType End End time of the event Declaration public DateTime End { get; set; } Property Value DateTime EndTimeZone End time zone Declaration public EventTimeZone EndTimeZone { get; set; } Property Value EventTimeZone HideAttendees When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false. Declaration public bool HideAttendees { get; set; } Property Value Boolean Importance The importance of the event. The possible values are: low, normal, high. Declaration public EventImportance Importance { get; set; } Property Value EventImportance IsAllDay Set to true if the event lasts all day. Declaration public bool IsAllDay { get; set; } Property Value Boolean IsOnlineMeeting True if this event has online meeting information, false otherwise. Default is false. Optional. Declaration public bool IsOnlineMeeting { get; set; } Property Value Boolean Location Location of the event Declaration public EventLocationOptions Location { get; set; } Property Value EventLocationOptions Locations Locations of the event. An event can have multiple locations Declaration public List Locations { get; set; } Property Value List < EventLocationOptions > OnlineMeetingProvider Represents the online meeting service provider. Declaration public EventOnlineMeetingProvider OnlineMeetingProvider { get; set; } Property Value EventOnlineMeetingProvider Recurrence The recurrence pattern for the event. Declaration public EventRecurrenceOptions Recurrence { get; set; } Property Value EventRecurrenceOptions ResponseRequested Set to true if the sender would like a response when the event is accepted or declined. Declaration public bool ResponseRequested { get; set; } Property Value Boolean Sensitivity The sensitivity of the event. Declaration public EventSensitivity Sensitivity { get; set; } Property Value EventSensitivity ShowAs The status to show Declaration public EventShowAs ShowAs { get; set; } Property Value EventShowAs Start Start time of the event Declaration public DateTime Start { get; set; } Property Value DateTime StartTimeZone Start time zone Declaration public EventTimeZone StartTimeZone { get; set; } Property Value EventTimeZone Subject Subject property Declaration public string Subject { get; set; } Property Value String TransactionId Transaction ID Declaration public string TransactionId { get; set; } Property Value String" + "keywords": "Class EventCreateOptions Options that can be set when creating a meeting request Inheritance System.Object EventCreateOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventCreateOptions : object Properties AllowNewTimeProposals Allow new time proposals Declaration public bool AllowNewTimeProposals { get; set; } Property Value Boolean Attendees List of attendees to be invited to the meeting Declaration public List Attendees { get; set; } Property Value List < EventAttendeeOptions > Body Body message Declaration public string Body { get; set; } Property Value String BodyContentType Body content type Declaration public EventBodyType BodyContentType { get; } Property Value EventBodyType End End time of the event Declaration public DateTime End { get; set; } Property Value DateTime EndTimeZone End time zone Declaration public EventTimeZone EndTimeZone { get; set; } Property Value EventTimeZone HideAttendees When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false. Declaration public bool HideAttendees { get; set; } Property Value Boolean Importance The importance of the event. The possible values are: low, normal, high. Declaration public EventImportance Importance { get; set; } Property Value EventImportance IsAllDay Set to true if the event lasts all day. Declaration public bool IsAllDay { get; set; } Property Value Boolean IsOnlineMeeting True if this event has online meeting information, false otherwise. Default is false. Optional. Declaration public bool IsOnlineMeeting { get; set; } Property Value Boolean Location Location of the event Declaration public EventLocationOptions Location { get; set; } Property Value EventLocationOptions Locations Locations of the event. An event can have multiple locations Declaration public List Locations { get; set; } Property Value List < EventLocationOptions > OnlineMeetingProvider Represents the online meeting service provider. Declaration public EventOnlineMeetingProvider OnlineMeetingProvider { get; set; } Property Value EventOnlineMeetingProvider Recurrence The recurrence pattern for the event. Declaration public EventRecurrenceOptions Recurrence { get; set; } Property Value EventRecurrenceOptions ResponseRequested Set to true if the sender would like a response when the event is accepted or declined. Declaration public bool ResponseRequested { get; set; } Property Value Boolean Sensitivity The sensitivity of the event. Declaration public EventSensitivity Sensitivity { get; set; } Property Value EventSensitivity ShowAs The status to show Declaration public EventShowAs ShowAs { get; set; } Property Value EventShowAs Start Start time of the event Declaration public DateTime Start { get; set; } Property Value DateTime StartTimeZone Start time zone Declaration public EventTimeZone StartTimeZone { get; set; } Property Value EventTimeZone Subject Subject property Declaration public string Subject { get; set; } Property Value String TransactionId Transaction ID Declaration public string TransactionId { get; set; } Property Value String" }, "api/PnP.Core.Model.Teams.EventImportance.html": { "href": "api/PnP.Core.Model.Teams.EventImportance.html", @@ -2787,7 +2787,7 @@ "api/PnP.Core.Model.Teams.EventLocationOptions.html": { "href": "api/PnP.Core.Model.Teams.EventLocationOptions.html", "title": "Class EventLocationOptions | PnP Core SDK", - "keywords": "Class EventLocationOptions Options that can be set when creating a location for a meeting request Inheritance Object EventLocationOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventLocationOptions : object Properties Address Address options Declaration public EventAddressOptions Address { get; set; } Property Value EventAddressOptions Coordinates Coordinates options Declaration public EventCoordinateOptions Coordinates { get; set; } Property Value EventCoordinateOptions DisplayName Name of the location Declaration public string DisplayName { get; set; } Property Value String LocationEmailAddress Location email address Declaration public string LocationEmailAddress { get; set; } Property Value String LocationUri Location Uri Declaration public string LocationUri { get; set; } Property Value String Type Type of location Declaration public EventLocationType Type { get; set; } Property Value EventLocationType" + "keywords": "Class EventLocationOptions Options that can be set when creating a location for a meeting request Inheritance System.Object EventLocationOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventLocationOptions : object Properties Address Address options Declaration public EventAddressOptions Address { get; set; } Property Value EventAddressOptions Coordinates Coordinates options Declaration public EventCoordinateOptions Coordinates { get; set; } Property Value EventCoordinateOptions DisplayName Name of the location Declaration public string DisplayName { get; set; } Property Value String LocationEmailAddress Location email address Declaration public string LocationEmailAddress { get; set; } Property Value String LocationUri Location Uri Declaration public string LocationUri { get; set; } Property Value String Type Type of location Declaration public EventLocationType Type { get; set; } Property Value EventLocationType" }, "api/PnP.Core.Model.Teams.EventLocationType.html": { "href": "api/PnP.Core.Model.Teams.EventLocationType.html", @@ -2807,22 +2807,22 @@ "api/PnP.Core.Model.Teams.EventRecipientOptions.html": { "href": "api/PnP.Core.Model.Teams.EventRecipientOptions.html", "title": "Class EventRecipientOptions | PnP Core SDK", - "keywords": "Class EventRecipientOptions Options that can be set for a recipient Inheritance Object EventRecipientOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventRecipientOptions : object Properties Address Mail address for the recipient Declaration public string Address { get; set; } Property Value String Name Name for the recipient Declaration public string Name { get; set; } Property Value String" + "keywords": "Class EventRecipientOptions Options that can be set for a recipient Inheritance System.Object EventRecipientOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventRecipientOptions : object Properties Address Mail address for the recipient Declaration public string Address { get; set; } Property Value String Name Name for the recipient Declaration public string Name { get; set; } Property Value String" }, "api/PnP.Core.Model.Teams.EventRecurrenceOptions.html": { "href": "api/PnP.Core.Model.Teams.EventRecurrenceOptions.html", "title": "Class EventRecurrenceOptions | PnP Core SDK", - "keywords": "Class EventRecurrenceOptions Options that can be set for the recurrence Inheritance Object EventRecurrenceOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventRecurrenceOptions : object Properties Pattern Pattern options Declaration public EventRecurrencePatternOptions Pattern { get; set; } Property Value EventRecurrencePatternOptions Range Range options Declaration public EventRecurrenceRangeOptions Range { get; set; } Property Value EventRecurrenceRangeOptions" + "keywords": "Class EventRecurrenceOptions Options that can be set for the recurrence Inheritance System.Object EventRecurrenceOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventRecurrenceOptions : object Properties Pattern Pattern options Declaration public EventRecurrencePatternOptions Pattern { get; set; } Property Value EventRecurrencePatternOptions Range Range options Declaration public EventRecurrenceRangeOptions Range { get; set; } Property Value EventRecurrenceRangeOptions" }, "api/PnP.Core.Model.Teams.EventRecurrencePatternOptions.html": { "href": "api/PnP.Core.Model.Teams.EventRecurrencePatternOptions.html", "title": "Class EventRecurrencePatternOptions | PnP Core SDK", - "keywords": "Class EventRecurrencePatternOptions Options that can be set for the recurrence pattern Inheritance Object EventRecurrencePatternOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventRecurrencePatternOptions : object Properties DayOfMonth Day of the month Declaration public int DayOfMonth { get; set; } Property Value Int32 DaysOfWeek Days of week of the recurrence event Declaration public List DaysOfWeek { get; set; } Property Value List < DayOfWeek > FirstDayOfWeek First day of week Declaration public DayOfWeek FirstDayOfWeek { get; set; } Property Value DayOfWeek Index Index Declaration public EventWeekIndex Index { get; set; } Property Value EventWeekIndex Interval Interval Declaration public int Interval { get; set; } Property Value Int32 Month Month Declaration public int Month { get; set; } Property Value Int32 Type Type of recurrence Declaration public EventRecurrenceType Type { get; set; } Property Value EventRecurrenceType" + "keywords": "Class EventRecurrencePatternOptions Options that can be set for the recurrence pattern Inheritance System.Object EventRecurrencePatternOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventRecurrencePatternOptions : object Properties DayOfMonth Day of the month Declaration public int DayOfMonth { get; set; } Property Value Int32 DaysOfWeek Days of week of the recurrence event Declaration public List DaysOfWeek { get; set; } Property Value List < DayOfWeek > FirstDayOfWeek First day of week Declaration public DayOfWeek FirstDayOfWeek { get; set; } Property Value DayOfWeek Index Index Declaration public EventWeekIndex Index { get; set; } Property Value EventWeekIndex Interval Interval Declaration public int Interval { get; set; } Property Value Int32 Month Month Declaration public int Month { get; set; } Property Value Int32 Type Type of recurrence Declaration public EventRecurrenceType Type { get; set; } Property Value EventRecurrenceType" }, "api/PnP.Core.Model.Teams.EventRecurrenceRangeOptions.html": { "href": "api/PnP.Core.Model.Teams.EventRecurrenceRangeOptions.html", "title": "Class EventRecurrenceRangeOptions | PnP Core SDK", - "keywords": "Class EventRecurrenceRangeOptions Options that can be set for the recurrence range Inheritance Object EventRecurrenceRangeOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventRecurrenceRangeOptions : object Properties EndDate End date Declaration public DateTime EndDate { get; set; } Property Value DateTime NumberOfOccurences Amount of occurences Declaration public int NumberOfOccurences { get; set; } Property Value Int32 RecurrenceTimeZone Time zone Declaration public string RecurrenceTimeZone { get; set; } Property Value String StartDate Start date Declaration public DateTime StartDate { get; set; } Property Value DateTime Type Range type Declaration public EventRecurrenceRangeType Type { get; set; } Property Value EventRecurrenceRangeType" + "keywords": "Class EventRecurrenceRangeOptions Options that can be set for the recurrence range Inheritance System.Object EventRecurrenceRangeOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventRecurrenceRangeOptions : object Properties EndDate End date Declaration public DateTime EndDate { get; set; } Property Value DateTime NumberOfOccurences Amount of occurences Declaration public int NumberOfOccurences { get; set; } Property Value Int32 RecurrenceTimeZone Time zone Declaration public string RecurrenceTimeZone { get; set; } Property Value String StartDate Start date Declaration public DateTime StartDate { get; set; } Property Value DateTime Type Range type Declaration public EventRecurrenceRangeType Type { get; set; } Property Value EventRecurrenceRangeType" }, "api/PnP.Core.Model.Teams.EventRecurrenceRangeType.html": { "href": "api/PnP.Core.Model.Teams.EventRecurrenceRangeType.html", @@ -2862,7 +2862,7 @@ "api/PnP.Core.Model.Teams.EventUpdateOptions.html": { "href": "api/PnP.Core.Model.Teams.EventUpdateOptions.html", "title": "Class EventUpdateOptions | PnP Core SDK", - "keywords": "Class EventUpdateOptions Options that can be set when creating a meeting request Inheritance Object EventUpdateOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventUpdateOptions : object Properties AllowNewTimeProposals Allow new time proposals Declaration public bool AllowNewTimeProposals { get; set; } Property Value Boolean Attendees List of attendees to be invited to the meeting Declaration public List Attendees { get; set; } Property Value List < EventAttendeeOptions > Body Body message Declaration public string Body { get; set; } Property Value String BodyContentType Body content type Declaration public EventBodyType BodyContentType { get; } Property Value EventBodyType End End time of the event Declaration public DateTime End { get; set; } Property Value DateTime EndTimeZone End time zone Declaration public EventTimeZone EndTimeZone { get; set; } Property Value EventTimeZone HideAttendees When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false. Declaration public bool HideAttendees { get; set; } Property Value Boolean Importance The importance of the event. The possible values are: low, normal, high. Declaration public EventImportance Importance { get; set; } Property Value EventImportance IsAllDay Set to true if the event lasts all day. Declaration public bool IsAllDay { get; set; } Property Value Boolean IsOnlineMeeting True if this event has online meeting information, false otherwise. Default is false. Optional. Declaration public bool IsOnlineMeeting { get; set; } Property Value Boolean Location Location of the event Declaration public EventLocationOptions Location { get; set; } Property Value EventLocationOptions Locations Locations of the event. An event can have multiple locations Declaration public List Locations { get; set; } Property Value List < EventLocationOptions > OnlineMeetingProvider Represents the online meeting service provider. Declaration public EventOnlineMeetingProvider OnlineMeetingProvider { get; set; } Property Value EventOnlineMeetingProvider ResponseRequested Set to true if the sender would like a response when the event is accepted or declined. Declaration public bool ResponseRequested { get; set; } Property Value Boolean Sensitivity The sensitivity of the event. Declaration public EventSensitivity Sensitivity { get; set; } Property Value EventSensitivity ShowAs The status to show Declaration public EventShowAs ShowAs { get; set; } Property Value EventShowAs Start Start time of the event Declaration public DateTime Start { get; set; } Property Value DateTime StartTimeZone Start time zone Declaration public EventTimeZone StartTimeZone { get; set; } Property Value EventTimeZone Subject Subject property Declaration public string Subject { get; set; } Property Value String" + "keywords": "Class EventUpdateOptions Options that can be set when creating a meeting request Inheritance System.Object EventUpdateOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventUpdateOptions : object Properties AllowNewTimeProposals Allow new time proposals Declaration public bool AllowNewTimeProposals { get; set; } Property Value Boolean Attendees List of attendees to be invited to the meeting Declaration public List Attendees { get; set; } Property Value List < EventAttendeeOptions > Body Body message Declaration public string Body { get; set; } Property Value String BodyContentType Body content type Declaration public EventBodyType BodyContentType { get; } Property Value EventBodyType End End time of the event Declaration public DateTime End { get; set; } Property Value DateTime EndTimeZone End time zone Declaration public EventTimeZone EndTimeZone { get; set; } Property Value EventTimeZone HideAttendees When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false. Declaration public bool HideAttendees { get; set; } Property Value Boolean Importance The importance of the event. The possible values are: low, normal, high. Declaration public EventImportance Importance { get; set; } Property Value EventImportance IsAllDay Set to true if the event lasts all day. Declaration public bool IsAllDay { get; set; } Property Value Boolean IsOnlineMeeting True if this event has online meeting information, false otherwise. Default is false. Optional. Declaration public bool IsOnlineMeeting { get; set; } Property Value Boolean Location Location of the event Declaration public EventLocationOptions Location { get; set; } Property Value EventLocationOptions Locations Locations of the event. An event can have multiple locations Declaration public List Locations { get; set; } Property Value List < EventLocationOptions > OnlineMeetingProvider Represents the online meeting service provider. Declaration public EventOnlineMeetingProvider OnlineMeetingProvider { get; set; } Property Value EventOnlineMeetingProvider ResponseRequested Set to true if the sender would like a response when the event is accepted or declined. Declaration public bool ResponseRequested { get; set; } Property Value Boolean Sensitivity The sensitivity of the event. Declaration public EventSensitivity Sensitivity { get; set; } Property Value EventSensitivity ShowAs The status to show Declaration public EventShowAs ShowAs { get; set; } Property Value EventShowAs Start Start time of the event Declaration public DateTime Start { get; set; } Property Value DateTime StartTimeZone Start time zone Declaration public EventTimeZone StartTimeZone { get; set; } Property Value EventTimeZone Subject Subject property Declaration public string Subject { get; set; } Property Value String" }, "api/PnP.Core.Model.Teams.EventWeekIndex.html": { "href": "api/PnP.Core.Model.Teams.EventWeekIndex.html", @@ -3002,12 +3002,12 @@ "api/PnP.Core.Model.Teams.ITeamChannel.html": { "href": "api/PnP.Core.Model.Teams.ITeamChannel.html", "title": "Interface ITeamChannel | PnP Core SDK", - "keywords": "Interface ITeamChannel Defines a Channel of Microsoft Teams Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public interface ITeamChannel : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties CreatedDateTime Timestamp at which the channel was created Declaration DateTime CreatedDateTime { get; } Property Value DateTime Description The description of the Team Channel Declaration string Description { get; set; } Property Value String DisplayName The display name of the Team Channel Declaration string DisplayName { get; set; } Property Value String Email The email address of the Team Channel Declaration string Email { get; } Property Value String FilesFolderWebUrl The fully qualified url for the SharePoint folder hosting this channel's files (uses Graph Beta) Declaration Uri FilesFolderWebUrl { get; } Property Value Uri Id The Unique ID of the Team Channel Declaration string Id { get; } Property Value String IsFavoriteByDefault Defines whether the Team Channel is favorite by default in the Team Declaration bool IsFavoriteByDefault { get; set; } Property Value Boolean MembershipType Defines the Membership type for the Team Channel Declaration TeamChannelMembershipType MembershipType { get; set; } Property Value TeamChannelMembershipType Messages Messages in this Team Channel Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ITeamChatMessageCollection Messages { get; } Property Value ITeamChatMessageCollection Tabs Tabs in this Channel Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ITeamChannelTabCollection Tabs { get; } Property Value ITeamChannelTabCollection WebUrl The Web URL of the Team Channel Declaration Uri WebUrl { get; } Property Value Uri Methods GetFilesFolder(Expression>[]) Gets the IFolder hosting the files of this channel Declaration IFolder GetFilesFolder(params Expression>[] expressions) Parameters Expression < Func < IFolder , Object >>[] expressions Properties of the folder to load Returns IFolder Folder hosting the files of this channel GetFilesFolderAsync(Expression>[]) Gets the IFolder hosting the files of this channel Declaration Task GetFilesFolderAsync(params Expression>[] expressions) Parameters Expression < Func < IFolder , Object >>[] expressions Properties of the folder to load Returns Task < IFolder > Folder hosting the files of this channel Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface ITeamChannel Defines a Channel of Microsoft Teams Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) IDataModelUpdate.UpdateBatchAsync() IDataModelUpdate.UpdateBatchAsync(Batch) IDataModelUpdate.UpdateAsync() IDataModelUpdate.UpdateBatch() IDataModelUpdate.UpdateBatch(Batch) IDataModelUpdate.Update() IDataModelDelete.DeleteBatchAsync() IDataModelDelete.DeleteBatchAsync(Batch) IDataModelDelete.DeleteAsync() IDataModelDelete.DeleteBatch() IDataModelDelete.DeleteBatch(Batch) IDataModelDelete.Delete() Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public interface ITeamChannel : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties CreatedDateTime Timestamp at which the channel was created Declaration DateTime CreatedDateTime { get; } Property Value DateTime Description The description of the Team Channel Declaration string Description { get; set; } Property Value String DisplayName The display name of the Team Channel Declaration string DisplayName { get; set; } Property Value String Email The email address of the Team Channel Declaration string Email { get; } Property Value String FilesFolderWebUrl The fully qualified url for the SharePoint folder hosting this channel's files (uses Graph Beta) Declaration Uri FilesFolderWebUrl { get; } Property Value Uri Id The Unique ID of the Team Channel Declaration string Id { get; } Property Value String IsFavoriteByDefault Defines whether the Team Channel is favorite by default in the Team Declaration bool IsFavoriteByDefault { get; set; } Property Value Boolean MembershipType Defines the Membership type for the Team Channel Declaration TeamChannelMembershipType MembershipType { get; set; } Property Value TeamChannelMembershipType Messages Messages in this Team Channel Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ITeamChatMessageCollection Messages { get; } Property Value ITeamChatMessageCollection Tabs Tabs in this Channel Implements . See Requesting model collections and IQueryable performance considerations to learn more. Declaration ITeamChannelTabCollection Tabs { get; } Property Value ITeamChannelTabCollection WebUrl The Web URL of the Team Channel Declaration Uri WebUrl { get; } Property Value Uri Methods GetFilesFolder(Expression>[]) Gets the IFolder hosting the files of this channel Declaration IFolder GetFilesFolder(params Expression>[] expressions) Parameters Expression < Func < IFolder , System.Object >>[] expressions Properties of the folder to load Returns IFolder Folder hosting the files of this channel GetFilesFolderAsync(Expression>[]) Gets the IFolder hosting the files of this channel Declaration Task GetFilesFolderAsync(params Expression>[] expressions) Parameters Expression < Func < IFolder , System.Object >>[] expressions Properties of the folder to load Returns Task < IFolder > Folder hosting the files of this channel Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.Teams.ITeamChannelCollection.html": { "href": "api/PnP.Core.Model.Teams.ITeamChannelCollection.html", "title": "Interface ITeamChannelCollection | PnP Core SDK", - "keywords": "Interface ITeamChannelCollection Public interface to define a collection of Team Channels Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() IDataModelCollectionLoad.LoadAsync(Expression>[]) IDataModelCollectionLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelCollectionDeleteByStringId.DeleteById(String) IDataModelCollectionDeleteByStringId.DeleteByIdAsync(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatch(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatchAsync(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatch(Batch, String) IDataModelCollectionDeleteByStringId.DeleteByIdBatchAsync(Batch, String) Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public interface ITeamChannelCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad, IDataModelCollectionDeleteByStringId, ISupportModules Methods Add(String, TeamChannelOptions) Adds a new channel Declaration ITeamChannel Add(string name, TeamChannelOptions options) Parameters String name Display name of the channel TeamChannelOptions options Options for creating the channel Returns ITeamChannel Newly added channel Add(String, String) Adds a new channel Declaration ITeamChannel Add(string name, string description = null) Parameters String name Display name of the channel String description Optional description of the channel Returns ITeamChannel Newly added channel AddAsync(String, TeamChannelOptions) Adds a new channel Declaration Task AddAsync(string name, TeamChannelOptions options) Parameters String name Display name of the channel TeamChannelOptions options Options for creating the channel Returns Task < ITeamChannel > Newly added channel AddAsync(String, String) Adds a new channel Declaration Task AddAsync(string name, string description = null) Parameters String name Display name of the channel String description Optional description of the channel Returns Task < ITeamChannel > Newly added channel AddBatch(Batch, String, TeamChannelOptions) Adds a new channel Declaration ITeamChannel AddBatch(Batch batch, string name, TeamChannelOptions options) Parameters Batch batch Batch to use String name Display name of the channel TeamChannelOptions options Options for creating the channel Returns ITeamChannel Newly added channel AddBatch(Batch, String, String) Adds a new channel Declaration ITeamChannel AddBatch(Batch batch, string name, string description = null) Parameters Batch batch Batch to use String name Display name of the channel String description Optional description of the channel Returns ITeamChannel Newly added channel AddBatch(String, TeamChannelOptions) Adds a new channel Declaration ITeamChannel AddBatch(string name, TeamChannelOptions options) Parameters String name Display name of the channel TeamChannelOptions options Options for creating the channel Returns ITeamChannel Newly added channel AddBatch(String, String) Adds a new channel Declaration ITeamChannel AddBatch(string name, string description = null) Parameters String name Display name of the channel String description Optional description of the channel Returns ITeamChannel Newly added channel AddBatchAsync(Batch, String, TeamChannelOptions) Adds a new channel Declaration Task AddBatchAsync(Batch batch, string name, TeamChannelOptions options) Parameters Batch batch Batch to use String name Display name of the channel TeamChannelOptions options Options for creating the channel Returns Task < ITeamChannel > Newly added channel AddBatchAsync(Batch, String, String) Adds a new channel Declaration Task AddBatchAsync(Batch batch, string name, string description = null) Parameters Batch batch Batch to use String name Display name of the channel String description Optional description of the channel Returns Task < ITeamChannel > Newly added channel AddBatchAsync(String, TeamChannelOptions) Adds a new channel Declaration Task AddBatchAsync(string name, TeamChannelOptions options) Parameters String name Display name of the channel TeamChannelOptions options Options for creating the channel Returns Task < ITeamChannel > Newly added channel AddBatchAsync(String, String) Adds a new channel Declaration Task AddBatchAsync(string name, string description = null) Parameters String name Display name of the channel String description Optional description of the channel Returns Task < ITeamChannel > Newly added channel GetByDisplayName(String, Expression>[]) Method to select a channel by displayName Declaration ITeamChannel GetByDisplayName(string displayName, params Expression>[] selectors) Parameters String displayName The displayName to search for Expression < Func < ITeamChannel , Object >>[] selectors The expressions declaring the fields to select Returns ITeamChannel The resulting channel instance, if any GetByDisplayNameAsync(String, Expression>[]) Method to select a channel by displayName asynchronously Declaration Task GetByDisplayNameAsync(string displayName, params Expression>[] selectors) Parameters String displayName The displayName to search for Expression < Func < ITeamChannel , Object >>[] selectors The expressions declaring the fields to select Returns Task < ITeamChannel > The resulting channel instance, if any Extension Methods DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.Load(IDataModelCollectionLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" + "keywords": "Interface ITeamChannelCollection Public interface to define a collection of Team Channels Inherited Members IDataModelParent.Parent IDataModelWithContext.PnPContext IRequestableCollection.Requested IRequestableCollection.Length IRequestableCollection.RequestedItems IRequestableCollection.Clear() IDataModelCollectionLoad.LoadAsync(Expression>[]) IDataModelCollectionLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelCollectionDeleteByStringId.DeleteById(String) IDataModelCollectionDeleteByStringId.DeleteByIdAsync(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatch(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatchAsync(String) IDataModelCollectionDeleteByStringId.DeleteByIdBatch(Batch, String) IDataModelCollectionDeleteByStringId.DeleteByIdBatchAsync(Batch, String) Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public interface ITeamChannelCollection : IDataModelCollection, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad, IDataModelCollectionDeleteByStringId, ISupportModules Methods Add(String, TeamChannelOptions) Adds a new channel Declaration ITeamChannel Add(string name, TeamChannelOptions options) Parameters String name Display name of the channel TeamChannelOptions options Options for creating the channel Returns ITeamChannel Newly added channel Add(String, String) Adds a new channel Declaration ITeamChannel Add(string name, string description = null) Parameters String name Display name of the channel String description Optional description of the channel Returns ITeamChannel Newly added channel AddAsync(String, TeamChannelOptions) Adds a new channel Declaration Task AddAsync(string name, TeamChannelOptions options) Parameters String name Display name of the channel TeamChannelOptions options Options for creating the channel Returns Task < ITeamChannel > Newly added channel AddAsync(String, String) Adds a new channel Declaration Task AddAsync(string name, string description = null) Parameters String name Display name of the channel String description Optional description of the channel Returns Task < ITeamChannel > Newly added channel AddBatch(Batch, String, TeamChannelOptions) Adds a new channel Declaration ITeamChannel AddBatch(Batch batch, string name, TeamChannelOptions options) Parameters Batch batch Batch to use String name Display name of the channel TeamChannelOptions options Options for creating the channel Returns ITeamChannel Newly added channel AddBatch(Batch, String, String) Adds a new channel Declaration ITeamChannel AddBatch(Batch batch, string name, string description = null) Parameters Batch batch Batch to use String name Display name of the channel String description Optional description of the channel Returns ITeamChannel Newly added channel AddBatch(String, TeamChannelOptions) Adds a new channel Declaration ITeamChannel AddBatch(string name, TeamChannelOptions options) Parameters String name Display name of the channel TeamChannelOptions options Options for creating the channel Returns ITeamChannel Newly added channel AddBatch(String, String) Adds a new channel Declaration ITeamChannel AddBatch(string name, string description = null) Parameters String name Display name of the channel String description Optional description of the channel Returns ITeamChannel Newly added channel AddBatchAsync(Batch, String, TeamChannelOptions) Adds a new channel Declaration Task AddBatchAsync(Batch batch, string name, TeamChannelOptions options) Parameters Batch batch Batch to use String name Display name of the channel TeamChannelOptions options Options for creating the channel Returns Task < ITeamChannel > Newly added channel AddBatchAsync(Batch, String, String) Adds a new channel Declaration Task AddBatchAsync(Batch batch, string name, string description = null) Parameters Batch batch Batch to use String name Display name of the channel String description Optional description of the channel Returns Task < ITeamChannel > Newly added channel AddBatchAsync(String, TeamChannelOptions) Adds a new channel Declaration Task AddBatchAsync(string name, TeamChannelOptions options) Parameters String name Display name of the channel TeamChannelOptions options Options for creating the channel Returns Task < ITeamChannel > Newly added channel AddBatchAsync(String, String) Adds a new channel Declaration Task AddBatchAsync(string name, string description = null) Parameters String name Display name of the channel String description Optional description of the channel Returns Task < ITeamChannel > Newly added channel GetByDisplayName(String, Expression>[]) Method to select a channel by displayName Declaration ITeamChannel GetByDisplayName(string displayName, params Expression>[] selectors) Parameters String displayName The displayName to search for Expression < Func < ITeamChannel , System.Object >>[] selectors The expressions declaring the fields to select Returns ITeamChannel The resulting channel instance, if any GetByDisplayNameAsync(String, Expression>[]) Method to select a channel by displayName asynchronously Declaration Task GetByDisplayNameAsync(string displayName, params Expression>[] selectors) Parameters String displayName The displayName to search for Expression < Func < ITeamChannel , System.Object >>[] selectors The expressions declaring the fields to select Returns Task < ITeamChannel > The resulting channel instance, if any Extension Methods DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.LoadBatchAsync(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Batch, Expression>[]) DataModelCollectionLoadExtensions.LoadBatch(IDataModelCollectionLoad, Expression>[]) DataModelCollectionLoadExtensions.Load(IDataModelCollectionLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>) QueryableExtensions.AsRequested(IDataModelCollection)" }, "api/PnP.Core.Model.Teams.ITeamChannelIdentity.html": { "href": "api/PnP.Core.Model.Teams.ITeamChannelIdentity.html", @@ -3172,12 +3172,12 @@ "api/PnP.Core.Model.Teams.TeamChannelOptions.html": { "href": "api/PnP.Core.Model.Teams.TeamChannelOptions.html", "title": "Class TeamChannelOptions | PnP Core SDK", - "keywords": "Class TeamChannelOptions Available options for Teams channel Inheritance Object TeamChannelOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class TeamChannelOptions : object Constructors TeamChannelOptions(String) Creates a new TeamChannelOptions instance with the provided description. Declaration public TeamChannelOptions(string description = null) Parameters String description The channel description. Properties Description Gets or sets the channel description. Declaration public string Description { get; set; } Property Value String MembershipType Gets or sets the channel membership type. The membership type cannot be changed for existing channels. Declaration public TeamChannelMembershipType? MembershipType { get; set; } Property Value Nullable < TeamChannelMembershipType >" + "keywords": "Class TeamChannelOptions Available options for Teams channel Inheritance System.Object TeamChannelOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class TeamChannelOptions : object Constructors TeamChannelOptions(String) Creates a new TeamChannelOptions instance with the provided description. Declaration public TeamChannelOptions(string description = null) Parameters String description The channel description. Properties Description Gets or sets the channel description. Declaration public string Description { get; set; } Property Value String MembershipType Gets or sets the channel membership type. The membership type cannot be changed for existing channels. Declaration public TeamChannelMembershipType? MembershipType { get; set; } Property Value Nullable < TeamChannelMembershipType >" }, "api/PnP.Core.Model.Teams.TeamChannelTabConstants.html": { "href": "api/PnP.Core.Model.Teams.TeamChannelTabConstants.html", "title": "Class TeamChannelTabConstants | PnP Core SDK", - "keywords": "Class TeamChannelTabConstants Team channel tab constants Inheritance Object TeamChannelTabConstants Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public static class TeamChannelTabConstants : object Fields DocumentLibraryAppId SharePoint Document library Declaration public const string DocumentLibraryAppId = null Field Value String ExcelAppId Microsoft Excel Declaration public const string ExcelAppId = null Field Value String FormsAppId Microsoft Forms Declaration public const string FormsAppId = null Field Value String OneNoteAppId Microsoft OneNote Declaration public const string OneNoteAppId = null Field Value String PdfAppId Adobe PDF Declaration public const string PdfAppId = null Field Value String PlannerAppId Microsoft Planner Declaration public const string PlannerAppId = null Field Value String PowerBiAppId Microsoft Power BI Declaration public const string PowerBiAppId = null Field Value String PptAppId PowerPoint Declaration public const string PptAppId = null Field Value String SharePointPageOrListAppId SharePoint page or list Declaration public const string SharePointPageOrListAppId = null Field Value String StreamsAppId Microsoft Streams Declaration public const string StreamsAppId = null Field Value String TeamsAppId Teams app Declaration public const string TeamsAppId = null Field Value String WebAppId Generic Web app Declaration public const string WebAppId = null Field Value String WhiteBoardAppId Teams whiteboard Declaration public const string WhiteBoardAppId = null Field Value String WikiAppId Teams Wiki Declaration public const string WikiAppId = null Field Value String WordAppId Microsoft Word Declaration public const string WordAppId = null Field Value String" + "keywords": "Class TeamChannelTabConstants Team channel tab constants Inheritance System.Object TeamChannelTabConstants Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public static class TeamChannelTabConstants : object Fields DocumentLibraryAppId SharePoint Document library Declaration public const string DocumentLibraryAppId = null Field Value String ExcelAppId Microsoft Excel Declaration public const string ExcelAppId = null Field Value String FormsAppId Microsoft Forms Declaration public const string FormsAppId = null Field Value String OneNoteAppId Microsoft OneNote Declaration public const string OneNoteAppId = null Field Value String PdfAppId Adobe PDF Declaration public const string PdfAppId = null Field Value String PlannerAppId Microsoft Planner Declaration public const string PlannerAppId = null Field Value String PowerBiAppId Microsoft Power BI Declaration public const string PowerBiAppId = null Field Value String PptAppId PowerPoint Declaration public const string PptAppId = null Field Value String SharePointPageOrListAppId SharePoint page or list Declaration public const string SharePointPageOrListAppId = null Field Value String StreamsAppId Microsoft Streams Declaration public const string StreamsAppId = null Field Value String TeamsAppId Teams app Declaration public const string TeamsAppId = null Field Value String WebAppId Generic Web app Declaration public const string WebAppId = null Field Value String WhiteBoardAppId Teams whiteboard Declaration public const string WhiteBoardAppId = null Field Value String WikiAppId Teams Wiki Declaration public const string WikiAppId = null Field Value String WordAppId Microsoft Word Declaration public const string WordAppId = null Field Value String" }, "api/PnP.Core.Model.Teams.TeamConversationIdentityType.html": { "href": "api/PnP.Core.Model.Teams.TeamConversationIdentityType.html", @@ -3202,7 +3202,7 @@ "api/PnP.Core.Model.Teams.TeamTagOptions.html": { "href": "api/PnP.Core.Model.Teams.TeamTagOptions.html", "title": "Class TeamTagOptions | PnP Core SDK", - "keywords": "Class TeamTagOptions Options for the team tag Inheritance Object TeamTagOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class TeamTagOptions : object Properties DisplayName Display name of the tag Declaration public string DisplayName { get; set; } Property Value String Members Members associated with the tags Declaration public List Members { get; set; } Property Value List < TeamTagUserOptions >" + "keywords": "Class TeamTagOptions Options for the team tag Inheritance System.Object TeamTagOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class TeamTagOptions : object Properties DisplayName Display name of the tag Declaration public string DisplayName { get; set; } Property Value String Members Members associated with the tags Declaration public List Members { get; set; } Property Value List < TeamTagUserOptions >" }, "api/PnP.Core.Model.Teams.TeamTagType.html": { "href": "api/PnP.Core.Model.Teams.TeamTagType.html", @@ -3212,7 +3212,7 @@ "api/PnP.Core.Model.Teams.TeamTagUserOptions.html": { "href": "api/PnP.Core.Model.Teams.TeamTagUserOptions.html", "title": "Class TeamTagUserOptions | PnP Core SDK", - "keywords": "Class TeamTagUserOptions Options for the team tag members Inheritance Object TeamTagUserOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class TeamTagUserOptions : object Properties UserId UserId to add to the tag Declaration public string UserId { get; set; } Property Value String" + "keywords": "Class TeamTagUserOptions Options for the team tag members Inheritance System.Object TeamTagUserOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class TeamTagUserOptions : object Properties UserId UserId to add to the tag Declaration public string UserId { get; set; } Property Value String" }, "api/PnP.Core.Model.Teams.TeamUserIdentityType.html": { "href": "api/PnP.Core.Model.Teams.TeamUserIdentityType.html", @@ -3227,22 +3227,22 @@ "api/PnP.Core.Model.TransientDictionary.html": { "href": "api/PnP.Core.Model.TransientDictionary.html", "title": "Class TransientDictionary | PnP Core SDK", - "keywords": "Class TransientDictionary Class for tracking Dictionary changes Inheritance Object TransientDictionary Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public class TransientDictionary : Dictionary Properties HasChanges Does this model instance have changes? Declaration public bool HasChanges { get; } Property Value Boolean Item[String] Gets or sets the value of an object in this dictionary Declaration public object this[string key] { get; set; } Parameters String key Key of the object to set Property Value Object Methods Add(String, Object) Adds a new item to the dictionary Declaration public void Add(string key, object value) Parameters String key Key of the item to add Object value Value of the item to add" + "keywords": "Class TransientDictionary Class for tracking Dictionary changes Inheritance System.Object TransientDictionary Namespace : PnP.Core.Model Assembly : PnP.Core.dll Syntax public class TransientDictionary : Dictionary Properties HasChanges Does this model instance have changes? Declaration public bool HasChanges { get; } Property Value Boolean Item[String] Gets or sets the value of an object in this dictionary Declaration public object this[string key] { get; set; } Parameters String key Key of the object to set Property Value System.Object Methods Add(String, Object) Adds a new item to the dictionary Declaration public void Add(string key, object value) Parameters String key Key of the item to add System.Object value Value of the item to add" }, "api/PnP.Core.PnPException.html": { "href": "api/PnP.Core.PnPException.html", "title": "Class PnPException | PnP Core SDK", - "keywords": "Class PnPException Base class for the pnp core sdk exceptions Inheritance Object PnPException AuthenticationException ClientException ServiceException Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public abstract class PnPException : Exception Constructors PnPException() Creates a PnP Exception Declaration public PnPException() PnPException(String) Creates a PnP Exception Declaration public PnPException(string message) Parameters String message Exception message PnPException(String, Exception) Creates a PnP Exception Declaration public PnPException(string message, Exception innerException) Parameters String message Exception message Exception innerException Inner exception to be linked to this PnPException Properties Error Additional error information Declaration public BaseError Error { get; set; } Property Value BaseError" + "keywords": "Class PnPException Base class for the pnp core sdk exceptions Inheritance System.Object PnPException AuthenticationException ClientException ServiceException Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public abstract class PnPException : Exception Constructors PnPException() Creates a PnP Exception Declaration public PnPException() PnPException(String) Creates a PnP Exception Declaration public PnPException(string message) Parameters String message Exception message PnPException(String, Exception) Creates a PnP Exception Declaration public PnPException(string message, Exception innerException) Parameters String message Exception message Exception innerException Inner exception to be linked to this PnPException Properties Error Additional error information Declaration public BaseError Error { get; set; } Property Value BaseError" }, "api/PnP.Core.QueryModel.BaseDataModelExtensions.html": { "href": "api/PnP.Core.QueryModel.BaseDataModelExtensions.html", "title": "Class BaseDataModelExtensions | PnP Core SDK", - "keywords": "Class BaseDataModelExtensions Class holding data model extension methods Inheritance Object BaseDataModelExtensions Namespace : PnP.Core.QueryModel Assembly : PnP.Core.dll Syntax public static class BaseDataModelExtensions : object Methods AndThen(Task, Func>) Chains async calls. See https://stackoverflow.com/a/52739551 for more information Declaration public static async Task AndThen(this Task inputTask, Func> mapping) Parameters Task inputTask Async operatation to start from Func > mapping Async operation to run next Returns Task Task outcome from the ran async operation Type Parameters TIn Input task TOut Output task" + "keywords": "Class BaseDataModelExtensions Class holding data model extension methods Inheritance System.Object BaseDataModelExtensions Namespace : PnP.Core.QueryModel Assembly : PnP.Core.dll Syntax public static class BaseDataModelExtensions : object Methods AndThen(Task, Func>) Chains async calls. See https://stackoverflow.com/a/52739551 for more information Declaration public static async Task AndThen(this Task inputTask, Func> mapping) Parameters Task inputTask Async operatation to start from Func > mapping Async operation to run next Returns Task Task outcome from the ran async operation Type Parameters TIn Input task TOut Output task" }, "api/PnP.Core.QueryModel.BaseQueryProvider.html": { "href": "api/PnP.Core.QueryModel.BaseQueryProvider.html", "title": "Class BaseQueryProvider | PnP Core SDK", - "keywords": "Class BaseQueryProvider Base abstract class to implement the basic logic of an IQueryProvider Inheritance Object BaseQueryProvider Namespace : PnP.Core.QueryModel Assembly : PnP.Core.dll Syntax public abstract class BaseQueryProvider : object, IAsyncQueryProvider Methods AddToBatchAsync(Expression, Batch) Adds the expression to the batch specified Declaration public abstract Task> AddToBatchAsync(Expression expression, Batch batch) Parameters Expression expression Batch batch Returns Task < IEnumerableBatchResult > Type Parameters TResult Implements IAsyncQueryProvider.AddToBatchAsync(Expression, Batch) AddToCurrentBatchAsync(Expression) Adds the expression to the current batch Declaration public abstract Task> AddToCurrentBatchAsync(Expression expression) Parameters Expression expression Returns Task < IEnumerableBatchResult > Type Parameters TResult Implements IAsyncQueryProvider.AddToCurrentBatchAsync(Expression) CreateQuery(Expression) Creates a query for the provided expression Declaration public abstract IQueryable CreateQuery(Expression expression) Parameters Expression expression Expression to create a query for Returns IQueryable CreateQuery(Expression) Creates a query for the provided expression Declaration public IQueryable CreateQuery(Expression expression) Parameters Expression expression Expression that will be translated into a query Returns IQueryable Created query Type Parameters TResult Result type of the query Execute(Expression) Executes the provided expression Declaration public object Execute(Expression expression) Parameters Expression expression Expression to execute Returns Object Execute(Expression) Executes the provided expression Declaration public TResult Execute(Expression expression) Parameters Expression expression Expression to execute Returns TResult Loaded model instace of type TResult Type Parameters TResult Resulting type of the linq expression execution ExecuteAsync(Expression, CancellationToken) Executes the provided expression Declaration public TResult ExecuteAsync(Expression expression, CancellationToken cancellationToken) Parameters Expression expression Expression to execute CancellationToken cancellationToken Cancellation token Returns TResult Loaded model instace of type TResult Type Parameters TResult Resulting type of the linq expression execution Implements IAsyncQueryProvider.ExecuteAsync(Expression, CancellationToken) ExecuteObjectAsync(Expression, CancellationToken) Executes the provided expression Declaration public abstract Task ExecuteObjectAsync(Expression expression, CancellationToken token) Parameters Expression expression Expression to execute CancellationToken token Token for cancellation Returns Task < Object >" + "keywords": "Class BaseQueryProvider Base abstract class to implement the basic logic of an IQueryProvider Inheritance System.Object BaseQueryProvider Namespace : PnP.Core.QueryModel Assembly : PnP.Core.dll Syntax public abstract class BaseQueryProvider : object, IAsyncQueryProvider Methods AddToBatchAsync(Expression, Batch) Adds the expression to the batch specified Declaration public abstract Task> AddToBatchAsync(Expression expression, Batch batch) Parameters Expression expression Batch batch Returns Task < IEnumerableBatchResult > Type Parameters TResult Implements IAsyncQueryProvider.AddToBatchAsync(Expression, Batch) AddToCurrentBatchAsync(Expression) Adds the expression to the current batch Declaration public abstract Task> AddToCurrentBatchAsync(Expression expression) Parameters Expression expression Returns Task < IEnumerableBatchResult > Type Parameters TResult Implements IAsyncQueryProvider.AddToCurrentBatchAsync(Expression) CreateQuery(Expression) Creates a query for the provided expression Declaration public abstract IQueryable CreateQuery(Expression expression) Parameters Expression expression Expression to create a query for Returns IQueryable CreateQuery(Expression) Creates a query for the provided expression Declaration public IQueryable CreateQuery(Expression expression) Parameters Expression expression Expression that will be translated into a query Returns IQueryable Created query Type Parameters TResult Result type of the query Execute(Expression) Executes the provided expression Declaration public object Execute(Expression expression) Parameters Expression expression Expression to execute Returns System.Object Execute(Expression) Executes the provided expression Declaration public TResult Execute(Expression expression) Parameters Expression expression Expression to execute Returns TResult Loaded model instace of type TResult Type Parameters TResult Resulting type of the linq expression execution ExecuteAsync(Expression, CancellationToken) Executes the provided expression Declaration public TResult ExecuteAsync(Expression expression, CancellationToken cancellationToken) Parameters Expression expression Expression to execute CancellationToken cancellationToken Cancellation token Returns TResult Loaded model instace of type TResult Type Parameters TResult Resulting type of the linq expression execution Implements IAsyncQueryProvider.ExecuteAsync(Expression, CancellationToken) ExecuteObjectAsync(Expression, CancellationToken) Executes the provided expression Declaration public abstract Task ExecuteObjectAsync(Expression expression, CancellationToken token) Parameters Expression expression Expression to execute CancellationToken token Token for cancellation Returns Task < System.Object >" }, "api/PnP.Core.QueryModel.FilteringConcatOperator.html": { "href": "api/PnP.Core.QueryModel.FilteringConcatOperator.html", @@ -3257,12 +3257,12 @@ "api/PnP.Core.QueryModel.FilterItem.html": { "href": "api/PnP.Core.QueryModel.FilterItem.html", "title": "Class FilterItem | PnP Core SDK", - "keywords": "Class FilterItem Defines a filtering criteria item Inheritance Object ODataFilter FilterItem Inherited Members ODataFilter.ConcatOperator Namespace : PnP.Core.QueryModel Assembly : PnP.Core.dll Syntax public class FilterItem : ODataFilter Properties Criteria The filtering criteria. Default: Equal. Declaration public FilteringCriteria Criteria { get; set; } Property Value FilteringCriteria Field The name of the field for the filtering criteria Declaration public string Field { get; set; } Property Value String Value The actual value for the filtering criteria Declaration public object Value { get; set; } Property Value Object" + "keywords": "Class FilterItem Defines a filtering criteria item Inheritance System.Object ODataFilter FilterItem Inherited Members ODataFilter.ConcatOperator Namespace : PnP.Core.QueryModel Assembly : PnP.Core.dll Syntax public class FilterItem : ODataFilter Properties Criteria The filtering criteria. Default: Equal. Declaration public FilteringCriteria Criteria { get; set; } Property Value FilteringCriteria Field The name of the field for the filtering criteria Declaration public string Field { get; set; } Property Value String Value The actual value for the filtering criteria Declaration public object Value { get; set; } Property Value System.Object" }, "api/PnP.Core.QueryModel.FiltersGroup.html": { "href": "api/PnP.Core.QueryModel.FiltersGroup.html", "title": "Class FiltersGroup | PnP Core SDK", - "keywords": "Class FiltersGroup Defines a group of filters Inheritance Object ODataFilter FiltersGroup Inherited Members ODataFilter.ConcatOperator Namespace : PnP.Core.QueryModel Assembly : PnP.Core.dll Syntax public class FiltersGroup : ODataFilter Constructors FiltersGroup() Constructs a group of filters Declaration public FiltersGroup() FiltersGroup(List) Constructs a group of filters based upon the provide list of filters Declaration public FiltersGroup(List filters) Parameters List < ODataFilter > filters List of ODataFilter filters Properties Filters Declaration public List Filters { get; } Property Value List < ODataFilter >" + "keywords": "Class FiltersGroup Defines a group of filters Inheritance System.Object ODataFilter FiltersGroup Inherited Members ODataFilter.ConcatOperator Namespace : PnP.Core.QueryModel Assembly : PnP.Core.dll Syntax public class FiltersGroup : ODataFilter Constructors FiltersGroup() Constructs a group of filters Declaration public FiltersGroup() FiltersGroup(List) Constructs a group of filters based upon the provide list of filters Declaration public FiltersGroup(List filters) Parameters List < ODataFilter > filters List of ODataFilter filters Properties Filters Declaration public List Filters { get; } Property Value List < ODataFilter >" }, "api/PnP.Core.QueryModel.html": { "href": "api/PnP.Core.QueryModel.html", @@ -3277,7 +3277,7 @@ "api/PnP.Core.QueryModel.ODataFilter.html": { "href": "api/PnP.Core.QueryModel.ODataFilter.html", "title": "Class ODataFilter | PnP Core SDK", - "keywords": "Class ODataFilter Interface to define the basic functionalities of a filtering item (either a single item or a group of items) Inheritance Object ODataFilter FilterItem FiltersGroup Namespace : PnP.Core.QueryModel Assembly : PnP.Core.dll Syntax public abstract class ODataFilter : object Properties ConcatOperator The concatenation operator between the current filter item and the next one in the chain, within the current filtering group. Default: AND. Declaration public FilteringConcatOperator ConcatOperator { get; set; } Property Value FilteringConcatOperator" + "keywords": "Class ODataFilter Interface to define the basic functionalities of a filtering item (either a single item or a group of items) Inheritance System.Object ODataFilter FilterItem FiltersGroup Namespace : PnP.Core.QueryModel Assembly : PnP.Core.dll Syntax public abstract class ODataFilter : object Properties ConcatOperator The concatenation operator between the current filter item and the next one in the chain, within the current filtering group. Default: AND. Declaration public FilteringConcatOperator ConcatOperator { get; set; } Property Value FilteringConcatOperator" }, "api/PnP.Core.QueryModel.ODataTargetPlatform.html": { "href": "api/PnP.Core.QueryModel.ODataTargetPlatform.html", @@ -3292,32 +3292,32 @@ "api/PnP.Core.QueryModel.OrderByItem.html": { "href": "api/PnP.Core.QueryModel.OrderByItem.html", "title": "Class OrderByItem | PnP Core SDK", - "keywords": "Class OrderByItem Defines a single sorting item Inheritance Object OrderByItem Namespace : PnP.Core.QueryModel Assembly : PnP.Core.dll Syntax public class OrderByItem : object Properties Direction The direction (Ascending/Descending) for the sorting criteria. Default: Ascending. Declaration public OrderByDirection Direction { get; set; } Property Value OrderByDirection Field The name of the field to sort by Declaration public string Field { get; set; } Property Value String" + "keywords": "Class OrderByItem Defines a single sorting item Inheritance System.Object OrderByItem Namespace : PnP.Core.QueryModel Assembly : PnP.Core.dll Syntax public class OrderByItem : object Properties Direction The direction (Ascending/Descending) for the sorting criteria. Default: Ascending. Declaration public OrderByDirection Direction { get; set; } Property Value OrderByDirection Field The name of the field to sort by Declaration public string Field { get; set; } Property Value String" }, "api/PnP.Core.QueryModel.QueryableExtensions.html": { "href": "api/PnP.Core.QueryModel.QueryableExtensions.html", "title": "Class QueryableExtensions | PnP Core SDK", - "keywords": "Class QueryableExtensions Useful extension methods for use with Entity Framework LINQ queries. Inheritance Object QueryableExtensions Namespace : PnP.Core.QueryModel Assembly : PnP.Core.dll Syntax public static class QueryableExtensions : object Methods AsAsyncEnumerable(IQueryable) Returns an which can be enumerated asynchronously. Declaration public static IAsyncEnumerable AsAsyncEnumerable(this IQueryable source) Parameters IQueryable source An to enumerate. Returns IAsyncEnumerable The query results. Type Parameters TSource The type of the elements of source . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. AsBatch(IQueryable) Adds the query to the current batch Declaration public static IEnumerableBatchResult AsBatch(this IQueryable source) Parameters IQueryable source Returns IEnumerableBatchResult Type Parameters TSource AsBatch(IQueryable, Batch) Adds the query to the specified batch Declaration public static IEnumerableBatchResult AsBatch(this IQueryable source, Batch batch) Parameters IQueryable source Batch batch Returns IEnumerableBatchResult Type Parameters TSource AsBatchAsync(IQueryable) Adds the query to the current batch Declaration public static Task> AsBatchAsync(this IQueryable source) Parameters IQueryable source Returns Task < IEnumerableBatchResult > Type Parameters TSource AsBatchAsync(IQueryable, Batch) Adds the query to the specified batch Declaration public static Task> AsBatchAsync(this IQueryable source, Batch batch) Parameters IQueryable source Batch batch Returns Task < IEnumerableBatchResult > Type Parameters TSource AsRequested(IDataModelCollection) Returns an which can be enumerated without executing an actual LINQ query on the target data provider. Declaration public static IEnumerable AsRequested(this IDataModelCollection source) Parameters IDataModelCollection source An IDataModelCollection to enumerate. Returns IEnumerable The query results. Type Parameters TSource The type of the elements of source . FirstAsync(IQueryable, CancellationToken) Asynchronously returns the first element of a sequence. Declaration public static Task FirstAsync(this IQueryable source, CancellationToken cancellationToken = null) Parameters IQueryable source An to return the first element of. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task A task that represents the asynchronous operation. The task result contains the first element in source . Type Parameters TSource The type of the elements of source . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. FirstAsync(IQueryable, Expression>, CancellationToken) Asynchronously returns the first element of a sequence that satisfies a specified condition. Declaration public static Task FirstAsync(this IQueryable source, Expression> predicate, CancellationToken cancellationToken = null) Parameters IQueryable source An to return the first element of. Expression < Func > predicate A function to test each element for a condition. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task A task that represents the asynchronous operation. The task result contains the first element in source that passes the test in predicate . Type Parameters TSource The type of the elements of source . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. FirstOrDefaultAsync(IQueryable, CancellationToken) Asynchronously returns the first element of a sequence, or a default value if the sequence contains no elements. Declaration public static Task FirstOrDefaultAsync(this IQueryable source, CancellationToken cancellationToken = null) Parameters IQueryable source An to return the first element of. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task A task that represents the asynchronous operation. The task result contains langword_csharp_default ( TSource ) if source is empty; otherwise, the first element in source . Type Parameters TSource The type of the elements of source . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. FirstOrDefaultAsync(IQueryable, Expression>, CancellationToken) Asynchronously returns the first element of a sequence that satisfies a specified condition or a default value if no such element is found. Declaration public static Task FirstOrDefaultAsync(this IQueryable source, Expression> predicate, CancellationToken cancellationToken = null) Parameters IQueryable source An to return the first element of. Expression < Func > predicate A function to test each element for a condition. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task A task that represents the asynchronous operation. The task result contains langword_csharp_default ( TSource ) if source is empty or if no element passes the test specified by predicate ; otherwise, the first element in source that passes the test specified by predicate . Type Parameters TSource The type of the elements of source . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. ForEachAsync(IQueryable, Action, CancellationToken) Asynchronously enumerates the query results and performs the specified action on each element. Declaration public static async Task ForEachAsync(this IQueryable source, Action action, CancellationToken cancellationToken = null) Parameters IQueryable source An to enumerate. Action action The action to perform on each element. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task A task that represents the asynchronous operation. Type Parameters T The type of the elements of source . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. QueryProperties(IQueryable, Expression>[]) Extension method to declare the fields/metadata properties to load while executing the REST query Declaration public static IQueryable QueryProperties(this IQueryable source, params Expression>[] selectors) Parameters IQueryable source The collection of items to load fields/metadata from Expression < Func >[] selectors An array of selectors for the fields/metadata Returns IQueryable The resulting collection Type Parameters TResult The type of the target entity QueryProperties(ISupportQuery, Expression>[]) Extension method to declare a field/metadata property to load while executing the REST query Declaration public static ISupportQuery QueryProperties(this ISupportQuery source, params Expression>[] selectors) Parameters ISupportQuery source The collection of items to load the field/metadata from Expression < Func >[] selectors A selector for a field/metadata Returns ISupportQuery The resulting collection Type Parameters TResult The type of the target entity ToArrayAsync(IQueryable, CancellationToken) Asynchronously creates an array from an by enumerating it asynchronously. Declaration public static async Task ToArrayAsync(this IQueryable source, CancellationToken cancellationToken = null) Parameters IQueryable source An to create an array from. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task A task that represents the asynchronous operation. The task result contains an array that contains elements from the input sequence. Type Parameters TSource The type of the elements of source . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. ToDictionaryAsync(IQueryable, Func, CancellationToken) Creates a from an by enumerating it asynchronously according to a specified key selector function. Declaration public static Task> ToDictionaryAsync(this IQueryable source, Func keySelector, CancellationToken cancellationToken = null) Parameters IQueryable source An to create a from. Func keySelector A function to extract a key from each element. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task < Dictionary > A task that represents the asynchronous operation. The task result contains a that contains selected keys and values. Type Parameters TSource The type of the elements of source . TKey The type of the key returned by keySelector . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. ToDictionaryAsync(IQueryable, Func, IEqualityComparer, CancellationToken) Creates a from an by enumerating it asynchronously according to a specified key selector function and a comparer. Declaration public static Task> ToDictionaryAsync(this IQueryable source, Func keySelector, IEqualityComparer comparer, CancellationToken cancellationToken = null) Parameters IQueryable source An to create a from. Func keySelector A function to extract a key from each element. IEqualityComparer comparer An to compare keys. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task < Dictionary > A task that represents the asynchronous operation. The task result contains a that contains selected keys and values. Type Parameters TSource The type of the elements of source . TKey The type of the key returned by keySelector . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. ToDictionaryAsync(IQueryable, Func, Func, CancellationToken) Creates a from an by enumerating it asynchronously according to a specified key selector and an element selector function. Declaration public static Task> ToDictionaryAsync(this IQueryable source, Func keySelector, Func elementSelector, CancellationToken cancellationToken = null) Parameters IQueryable source An to create a from. Func keySelector A function to extract a key from each element. Func elementSelector A transform function to produce a result element value from each element. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task < Dictionary > A task that represents the asynchronous operation. The task result contains a that contains values of type TElement selected from the input sequence. Type Parameters TSource The type of the elements of source . TKey The type of the key returned by keySelector . TElement The type of the value returned by elementSelector . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. ToDictionaryAsync(IQueryable, Func, Func, IEqualityComparer, CancellationToken) Creates a from an by enumerating it asynchronously according to a specified key selector function, a comparer, and an element selector function. Declaration public static async Task> ToDictionaryAsync(this IQueryable source, Func keySelector, Func elementSelector, IEqualityComparer comparer, CancellationToken cancellationToken = null) Parameters IQueryable source An to create a from. Func keySelector A function to extract a key from each element. Func elementSelector A transform function to produce a result element value from each element. IEqualityComparer comparer An to compare keys. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task < Dictionary > A task that represents the asynchronous operation. The task result contains a that contains values of type TElement selected from the input sequence. Type Parameters TSource The type of the elements of source . TKey The type of the key returned by keySelector . TElement The type of the value returned by elementSelector . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. ToListAsync(IQueryable, CancellationToken) Asynchronously creates a from an by enumerating it asynchronously. Declaration public static async Task> ToListAsync(this IQueryable source, CancellationToken cancellationToken = null) Parameters IQueryable source An to create a list from. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task < List > A task that represents the asynchronous operation. The task result contains a that contains elements from the input sequence. Type Parameters TSource The type of the elements of source . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context." + "keywords": "Class QueryableExtensions Useful extension methods for use with Entity Framework LINQ queries. Inheritance System.Object QueryableExtensions Namespace : PnP.Core.QueryModel Assembly : PnP.Core.dll Syntax public static class QueryableExtensions : object Methods AsAsyncEnumerable(IQueryable) Returns an which can be enumerated asynchronously. Declaration public static IAsyncEnumerable AsAsyncEnumerable(this IQueryable source) Parameters IQueryable source An to enumerate. Returns IAsyncEnumerable The query results. Type Parameters TSource The type of the elements of source . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. AsBatch(IQueryable) Adds the query to the current batch Declaration public static IEnumerableBatchResult AsBatch(this IQueryable source) Parameters IQueryable source Returns IEnumerableBatchResult Type Parameters TSource AsBatch(IQueryable, Batch) Adds the query to the specified batch Declaration public static IEnumerableBatchResult AsBatch(this IQueryable source, Batch batch) Parameters IQueryable source Batch batch Returns IEnumerableBatchResult Type Parameters TSource AsBatchAsync(IQueryable) Adds the query to the current batch Declaration public static Task> AsBatchAsync(this IQueryable source) Parameters IQueryable source Returns Task < IEnumerableBatchResult > Type Parameters TSource AsBatchAsync(IQueryable, Batch) Adds the query to the specified batch Declaration public static Task> AsBatchAsync(this IQueryable source, Batch batch) Parameters IQueryable source Batch batch Returns Task < IEnumerableBatchResult > Type Parameters TSource AsRequested(IDataModelCollection) Returns an which can be enumerated without executing an actual LINQ query on the target data provider. Declaration public static IEnumerable AsRequested(this IDataModelCollection source) Parameters IDataModelCollection source An IDataModelCollection to enumerate. Returns IEnumerable The query results. Type Parameters TSource The type of the elements of source . FirstAsync(IQueryable, CancellationToken) Asynchronously returns the first element of a sequence. Declaration public static Task FirstAsync(this IQueryable source, CancellationToken cancellationToken = null) Parameters IQueryable source An to return the first element of. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task A task that represents the asynchronous operation. The task result contains the first element in source . Type Parameters TSource The type of the elements of source . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. FirstAsync(IQueryable, Expression>, CancellationToken) Asynchronously returns the first element of a sequence that satisfies a specified condition. Declaration public static Task FirstAsync(this IQueryable source, Expression> predicate, CancellationToken cancellationToken = null) Parameters IQueryable source An to return the first element of. Expression < Func > predicate A function to test each element for a condition. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task A task that represents the asynchronous operation. The task result contains the first element in source that passes the test in predicate . Type Parameters TSource The type of the elements of source . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. FirstOrDefaultAsync(IQueryable, CancellationToken) Asynchronously returns the first element of a sequence, or a default value if the sequence contains no elements. Declaration public static Task FirstOrDefaultAsync(this IQueryable source, CancellationToken cancellationToken = null) Parameters IQueryable source An to return the first element of. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task A task that represents the asynchronous operation. The task result contains langword_csharp_default ( TSource ) if source is empty; otherwise, the first element in source . Type Parameters TSource The type of the elements of source . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. FirstOrDefaultAsync(IQueryable, Expression>, CancellationToken) Asynchronously returns the first element of a sequence that satisfies a specified condition or a default value if no such element is found. Declaration public static Task FirstOrDefaultAsync(this IQueryable source, Expression> predicate, CancellationToken cancellationToken = null) Parameters IQueryable source An to return the first element of. Expression < Func > predicate A function to test each element for a condition. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task A task that represents the asynchronous operation. The task result contains langword_csharp_default ( TSource ) if source is empty or if no element passes the test specified by predicate ; otherwise, the first element in source that passes the test specified by predicate . Type Parameters TSource The type of the elements of source . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. ForEachAsync(IQueryable, Action, CancellationToken) Asynchronously enumerates the query results and performs the specified action on each element. Declaration public static async Task ForEachAsync(this IQueryable source, Action action, CancellationToken cancellationToken = null) Parameters IQueryable source An to enumerate. Action action The action to perform on each element. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task A task that represents the asynchronous operation. Type Parameters T The type of the elements of source . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. QueryProperties(IQueryable, Expression>[]) Extension method to declare the fields/metadata properties to load while executing the REST query Declaration public static IQueryable QueryProperties(this IQueryable source, params Expression>[] selectors) Parameters IQueryable source The collection of items to load fields/metadata from Expression < Func >[] selectors An array of selectors for the fields/metadata Returns IQueryable The resulting collection Type Parameters TResult The type of the target entity QueryProperties(ISupportQuery, Expression>[]) Extension method to declare a field/metadata property to load while executing the REST query Declaration public static ISupportQuery QueryProperties(this ISupportQuery source, params Expression>[] selectors) Parameters ISupportQuery source The collection of items to load the field/metadata from Expression < Func >[] selectors A selector for a field/metadata Returns ISupportQuery The resulting collection Type Parameters TResult The type of the target entity ToArrayAsync(IQueryable, CancellationToken) Asynchronously creates an array from an by enumerating it asynchronously. Declaration public static async Task ToArrayAsync(this IQueryable source, CancellationToken cancellationToken = null) Parameters IQueryable source An to create an array from. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task A task that represents the asynchronous operation. The task result contains an array that contains elements from the input sequence. Type Parameters TSource The type of the elements of source . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. ToDictionaryAsync(IQueryable, Func, CancellationToken) Creates a from an by enumerating it asynchronously according to a specified key selector function. Declaration public static Task> ToDictionaryAsync(this IQueryable source, Func keySelector, CancellationToken cancellationToken = null) Parameters IQueryable source An to create a from. Func keySelector A function to extract a key from each element. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task < Dictionary > A task that represents the asynchronous operation. The task result contains a that contains selected keys and values. Type Parameters TSource The type of the elements of source . TKey The type of the key returned by keySelector . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. ToDictionaryAsync(IQueryable, Func, IEqualityComparer, CancellationToken) Creates a from an by enumerating it asynchronously according to a specified key selector function and a comparer. Declaration public static Task> ToDictionaryAsync(this IQueryable source, Func keySelector, IEqualityComparer comparer, CancellationToken cancellationToken = null) Parameters IQueryable source An to create a from. Func keySelector A function to extract a key from each element. IEqualityComparer comparer An to compare keys. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task < Dictionary > A task that represents the asynchronous operation. The task result contains a that contains selected keys and values. Type Parameters TSource The type of the elements of source . TKey The type of the key returned by keySelector . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. ToDictionaryAsync(IQueryable, Func, Func, CancellationToken) Creates a from an by enumerating it asynchronously according to a specified key selector and an element selector function. Declaration public static Task> ToDictionaryAsync(this IQueryable source, Func keySelector, Func elementSelector, CancellationToken cancellationToken = null) Parameters IQueryable source An to create a from. Func keySelector A function to extract a key from each element. Func elementSelector A transform function to produce a result element value from each element. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task < Dictionary > A task that represents the asynchronous operation. The task result contains a that contains values of type TElement selected from the input sequence. Type Parameters TSource The type of the elements of source . TKey The type of the key returned by keySelector . TElement The type of the value returned by elementSelector . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. ToDictionaryAsync(IQueryable, Func, Func, IEqualityComparer, CancellationToken) Creates a from an by enumerating it asynchronously according to a specified key selector function, a comparer, and an element selector function. Declaration public static async Task> ToDictionaryAsync(this IQueryable source, Func keySelector, Func elementSelector, IEqualityComparer comparer, CancellationToken cancellationToken = null) Parameters IQueryable source An to create a from. Func keySelector A function to extract a key from each element. Func elementSelector A transform function to produce a result element value from each element. IEqualityComparer comparer An to compare keys. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task < Dictionary > A task that represents the asynchronous operation. The task result contains a that contains values of type TElement selected from the input sequence. Type Parameters TSource The type of the elements of source . TKey The type of the key returned by keySelector . TElement The type of the value returned by elementSelector . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context. ToListAsync(IQueryable, CancellationToken) Asynchronously creates a from an by enumerating it asynchronously. Declaration public static async Task> ToListAsync(this IQueryable source, CancellationToken cancellationToken = null) Parameters IQueryable source An to create a list from. CancellationToken cancellationToken A to observe while waiting for the task to complete. Returns Task < List > A task that represents the asynchronous operation. The task result contains a that contains elements from the input sequence. Type Parameters TSource The type of the elements of source . Remarks Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context." }, "api/PnP.Core.ServiceError.html": { "href": "api/PnP.Core.ServiceError.html", "title": "Class ServiceError | PnP Core SDK", - "keywords": "Class ServiceError Error information for a service error Inheritance Object BaseError ServiceError CsomError MicrosoftGraphError SharePointRestError Inherited Members BaseError.Type BaseError.PnPCorrelationId BaseError.AdditionalData BaseError.AddAdditionalData(String, Object) Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class ServiceError : BaseError Constructors ServiceError(ErrorType, Int32) ServiceError constructor using error type and http response code to create a backend service request error Declaration public ServiceError(ErrorType type, int httpResponseCode) Parameters ErrorType type Type of the error Int32 httpResponseCode Http response code of the error Properties ClientRequestId Client request id header returned in the response. Declaration public string ClientRequestId { get; } Property Value String Code Graph error code Declaration public string Code { get; } Property Value String HttpResponseCode Http response code that was linked to the service error Declaration public int HttpResponseCode { get; } Property Value Int32 Message Error message that was linked to the service error Declaration public string Message { get; } Property Value String" + "keywords": "Class ServiceError Error information for a service error Inheritance System.Object BaseError ServiceError CsomError MicrosoftGraphError SharePointRestError Inherited Members BaseError.Type BaseError.PnPCorrelationId BaseError.AdditionalData BaseError.AddAdditionalData(String, Object) Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class ServiceError : BaseError Constructors ServiceError(ErrorType, Int32) ServiceError constructor using error type and http response code to create a backend service request error Declaration public ServiceError(ErrorType type, int httpResponseCode) Parameters ErrorType type Type of the error Int32 httpResponseCode Http response code of the error Properties ClientRequestId Client request id header returned in the response. Declaration public string ClientRequestId { get; } Property Value String Code Graph error code Declaration public string Code { get; } Property Value String HttpResponseCode Http response code that was linked to the service error Declaration public int HttpResponseCode { get; } Property Value Int32 Message Error message that was linked to the service error Declaration public string Message { get; } Property Value String" }, "api/PnP.Core.ServiceException.html": { "href": "api/PnP.Core.ServiceException.html", "title": "Class ServiceException | PnP Core SDK", - "keywords": "Class ServiceException Abstract class representing service errors Inheritance Object PnPException ServiceException CsomServiceException MicrosoftGraphServiceException SharePointRestServiceException Inherited Members PnPException.Error Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class ServiceException : PnPException Constructors ServiceException() Creates a service request exception Declaration public ServiceException() ServiceException(ErrorType, Int32, String) Creates a service request exception Declaration public ServiceException(ErrorType type, int httpResponseCode, string message) Parameters ErrorType type Error type Int32 httpResponseCode Http response code of the service request that got an error back String message Exception message ServiceException(String) Creates a service request exception Declaration public ServiceException(string message) Parameters String message Exception message ServiceException(String, Exception) Creates a service request exception Declaration public ServiceException(string message, Exception innerException) Parameters String message Exception message Exception innerException Inner exception to be linked to this ServiceException" + "keywords": "Class ServiceException Abstract class representing service errors Inheritance System.Object PnPException ServiceException CsomServiceException MicrosoftGraphServiceException SharePointRestServiceException Inherited Members PnPException.Error Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class ServiceException : PnPException Constructors ServiceException() Creates a service request exception Declaration public ServiceException() ServiceException(ErrorType, Int32, String) Creates a service request exception Declaration public ServiceException(ErrorType type, int httpResponseCode, string message) Parameters ErrorType type Error type Int32 httpResponseCode Http response code of the service request that got an error back String message Exception message ServiceException(String) Creates a service request exception Declaration public ServiceException(string message) Parameters String message Exception message ServiceException(String, Exception) Creates a service request exception Declaration public ServiceException(string message, Exception innerException) Parameters String message Exception message Exception innerException Inner exception to be linked to this ServiceException" }, "api/PnP.Core.Services.ApiRequest.html": { "href": "api/PnP.Core.Services.ApiRequest.html", "title": "Class ApiRequest | PnP Core SDK", - "keywords": "Class ApiRequest Defines an API request that can be executed Inheritance Object ApiRequest Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class ApiRequest : object Constructors ApiRequest(HttpMethod, ApiRequestType, String, String, Dictionary) Creates an API request to execute Declaration public ApiRequest(HttpMethod httpMethod, ApiRequestType type, string request, string body, Dictionary headers = null) Parameters HttpMethod httpMethod Http method to use ApiRequestType type ApiRequestType of the request String request Actual API call to issue String body Optional body of the request Dictionary < String , String > headers Optional headers for the request ApiRequest(ApiRequestType, String) Creates an API request to execute Declaration public ApiRequest(ApiRequestType type, string request) Parameters ApiRequestType type ApiRequestType of the request String request Actual API call to issue Properties Body The optional payload/body of the API call to execute Declaration public string Body { get; set; } Property Value String Headers The optional headers of the API call to execute - for example IF-Match for PATCH Request. Declaration public Dictionary Headers { get; } Property Value Dictionary < String , String > HttpMethod The Http method to use Declaration public HttpMethod HttpMethod { get; set; } Property Value HttpMethod Request The REST/Graph API call to execute Declaration public string Request { get; set; } Property Value String Type The type of API call to execute Declaration public ApiRequestType Type { get; set; } Property Value ApiRequestType" + "keywords": "Class ApiRequest Defines an API request that can be executed Inheritance System.Object ApiRequest Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class ApiRequest : object Constructors ApiRequest(HttpMethod, ApiRequestType, String, String, Dictionary) Creates an API request to execute Declaration public ApiRequest(HttpMethod httpMethod, ApiRequestType type, string request, string body, Dictionary headers = null) Parameters HttpMethod httpMethod Http method to use ApiRequestType type ApiRequestType of the request String request Actual API call to issue String body Optional body of the request Dictionary < String , String > headers Optional headers for the request ApiRequest(ApiRequestType, String) Creates an API request to execute Declaration public ApiRequest(ApiRequestType type, string request) Parameters ApiRequestType type ApiRequestType of the request String request Actual API call to issue Properties Body The optional payload/body of the API call to execute Declaration public string Body { get; set; } Property Value String Headers The optional headers of the API call to execute - for example IF-Match for PATCH Request. Declaration public Dictionary Headers { get; } Property Value Dictionary < String , String > HttpMethod The Http method to use Declaration public HttpMethod HttpMethod { get; set; } Property Value HttpMethod Request The REST/Graph API call to execute Declaration public string Request { get; set; } Property Value String Type The type of API call to execute Declaration public ApiRequestType Type { get; set; } Property Value ApiRequestType" }, "api/PnP.Core.Services.ApiRequestResponse.html": { "href": "api/PnP.Core.Services.ApiRequestResponse.html", "title": "Class ApiRequestResponse | PnP Core SDK", - "keywords": "Class ApiRequestResponse The response of an executed ApiRequest Inheritance Object ApiRequestResponse Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class ApiRequestResponse : object Properties ApiRequest Gets the ApiRequest that resulted in this response Declaration public ApiRequest ApiRequest { get; } Property Value ApiRequest Headers Contains additional response headers (if any) Declaration public Dictionary Headers { get; } Property Value Dictionary < String , String > Response The JSON response Declaration public string Response { get; } Property Value String StatusCode Contains the request http status code Declaration public HttpStatusCode StatusCode { get; } Property Value HttpStatusCode" + "keywords": "Class ApiRequestResponse The response of an executed ApiRequest Inheritance System.Object ApiRequestResponse Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class ApiRequestResponse : object Properties ApiRequest Gets the ApiRequest that resulted in this response Declaration public ApiRequest ApiRequest { get; } Property Value ApiRequest Headers Contains additional response headers (if any) Declaration public Dictionary Headers { get; } Property Value Dictionary < String , String > Response The JSON response Declaration public string Response { get; } Property Value String StatusCode Contains the request http status code Declaration public HttpStatusCode StatusCode { get; } Property Value HttpStatusCode" }, "api/PnP.Core.Services.ApiRequestType.html": { "href": "api/PnP.Core.Services.ApiRequestType.html", @@ -3332,22 +3332,22 @@ "api/PnP.Core.Services.Batch.html": { "href": "api/PnP.Core.Services.Batch.html", "title": "Class Batch | PnP Core SDK", - "keywords": "Class Batch Defines a Batch of requests to execute Inheritance Object Batch Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class Batch : object Constructors Batch() Default public constructor, instantiates a Batch Declaration public Batch() Properties Executed Was this Batch executed? Declaration public bool Executed { get; } Property Value Boolean Requests List with requests Declaration public SortedList Requests { get; } Property Value SortedList < Int32 , BatchRequest >" + "keywords": "Class Batch Defines a Batch of requests to execute Inheritance System.Object Batch Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class Batch : object Constructors Batch() Default public constructor, instantiates a Batch Declaration public Batch() Properties Executed Was this Batch executed? Declaration public bool Executed { get; } Property Value Boolean Requests List with requests Declaration public SortedList Requests { get; } Property Value SortedList < Int32 , BatchRequest >" }, "api/PnP.Core.Services.BatchRequest.html": { "href": "api/PnP.Core.Services.BatchRequest.html", "title": "Class BatchRequest | PnP Core SDK", - "keywords": "Class BatchRequest Defines a request in a Batch Inheritance Object BatchRequest Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class BatchRequest : object Properties ResponseHttpStatusCode Http response code for this request (only populated when the Batch was executed) Declaration public HttpStatusCode ResponseHttpStatusCode { get; } Property Value HttpStatusCode ResponseJson Json response for this request (only populated when the Batch was executed) Declaration public string ResponseJson { get; } Property Value String" + "keywords": "Class BatchRequest Defines a request in a Batch Inheritance System.Object BatchRequest Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class BatchRequest : object Properties ResponseHttpStatusCode Http response code for this request (only populated when the Batch was executed) Declaration public HttpStatusCode ResponseHttpStatusCode { get; } Property Value HttpStatusCode ResponseJson Json response for this request (only populated when the Batch was executed) Declaration public string ResponseJson { get; } Property Value String" }, "api/PnP.Core.Services.BatchResult.html": { "href": "api/PnP.Core.Services.BatchResult.html", "title": "Class BatchResult | PnP Core SDK", - "keywords": "Class BatchResult Holds information about the outcome of each batch request Inheritance Object BatchResult Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class BatchResult : object Properties ApiBody API call body Declaration public string ApiBody { get; } Property Value String ApiMethod API call method Declaration public HttpMethod ApiMethod { get; } Property Value HttpMethod ApiRequest API call request Declaration public string ApiRequest { get; } Property Value String ApiResponse The response content from the batch request Declaration public string ApiResponse { get; } Property Value String ApiType API call Type Declaration public string ApiType { get; } Property Value String Error If an error happened then the error information is stored here Declaration public ServiceError Error { get; } Property Value ServiceError StatusCode Status code of the request Declaration public HttpStatusCode StatusCode { get; } Property Value HttpStatusCode" + "keywords": "Class BatchResult Holds information about the outcome of each batch request Inheritance System.Object BatchResult Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class BatchResult : object Properties ApiBody API call body Declaration public string ApiBody { get; } Property Value String ApiMethod API call method Declaration public HttpMethod ApiMethod { get; } Property Value HttpMethod ApiRequest API call request Declaration public string ApiRequest { get; } Property Value String ApiResponse The response content from the batch request Declaration public string ApiResponse { get; } Property Value String ApiType API call Type Declaration public string ApiType { get; } Property Value String Error If an error happened then the error information is stored here Declaration public ServiceError Error { get; } Property Value ServiceError StatusCode Status code of the request Declaration public HttpStatusCode StatusCode { get; } Property Value HttpStatusCode" }, "api/PnP.Core.Services.BatchResultValue-1.html": { "href": "api/PnP.Core.Services.BatchResultValue-1.html", "title": "Class BatchResultValue | PnP Core SDK", - "keywords": "Class BatchResultValue Wraps a reference or value type in an object Inheritance Object BatchResultValue Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class BatchResultValue : object Type Parameters T Type of the value/reference type to wrap Properties Value The wrapped reference/value type Declaration public T Value { get; } Property Value T" + "keywords": "Class BatchResultValue Wraps a reference or value type in an object Inheritance System.Object BatchResultValue Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class BatchResultValue : object Type Parameters T Type of the value/reference type to wrap Properties Value The wrapped reference/value type Declaration public T Value { get; } Property Value T" }, "api/PnP.Core.Services.Builder.Configuration.html": { "href": "api/PnP.Core.Services.Builder.Configuration.html", @@ -3357,42 +3357,42 @@ "api/PnP.Core.Services.Builder.Configuration.PnPCoreContextOptions.html": { "href": "api/PnP.Core.Services.Builder.Configuration.PnPCoreContextOptions.html", "title": "Class PnPCoreContextOptions | PnP Core SDK", - "keywords": "Class PnPCoreContextOptions Microsoft Graph global settings Inheritance Object PnPCoreContextOptions Namespace : PnP.Core.Services.Builder.Configuration Assembly : PnP.Core.dll Syntax public class PnPCoreContextOptions : object Properties GraphAlwaysUseBeta If true than all requests to Microsoft Graph use the beta endpoint Declaration public bool GraphAlwaysUseBeta { get; set; } Property Value Boolean GraphCanUseBeta If true than the Graph beta endpoint is used when there's no other option, default approach stays using the v1 endpoint Declaration public bool GraphCanUseBeta { get; set; } Property Value Boolean GraphFirst Controls whether the library will try to use Microsoft Graph over REST whenever that's defined in the model Declaration public bool GraphFirst { get; set; } Property Value Boolean" + "keywords": "Class PnPCoreContextOptions Microsoft Graph global settings Inheritance System.Object PnPCoreContextOptions Namespace : PnP.Core.Services.Builder.Configuration Assembly : PnP.Core.dll Syntax public class PnPCoreContextOptions : object Properties GraphAlwaysUseBeta If true than all requests to Microsoft Graph use the beta endpoint Declaration public bool GraphAlwaysUseBeta { get; set; } Property Value Boolean GraphCanUseBeta If true than the Graph beta endpoint is used when there's no other option, default approach stays using the v1 endpoint Declaration public bool GraphCanUseBeta { get; set; } Property Value Boolean GraphFirst Controls whether the library will try to use Microsoft Graph over REST whenever that's defined in the model Declaration public bool GraphFirst { get; set; } Property Value Boolean" }, "api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsAzureActiveDirectoryOptions.html": { "href": "api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsAzureActiveDirectoryOptions.html", "title": "Class PnPCoreHttpRequestsAzureActiveDirectoryOptions | PnP Core SDK", - "keywords": "Class PnPCoreHttpRequestsAzureActiveDirectoryOptions Microsoft Graph REST options Inheritance Object PnPCoreHttpRequestsAzureActiveDirectoryOptions Namespace : PnP.Core.Services.Builder.Configuration Assembly : PnP.Core.dll Syntax public class PnPCoreHttpRequestsAzureActiveDirectoryOptions : object Properties DelayInSeconds How many seconds to wait for the next retry attempt. Defaults to 3 Declaration public int DelayInSeconds { get; set; } Property Value Int32 MaxRetries When not using retry-after, how many times can a retry be made. Defaults to 10 Declaration public int MaxRetries { get; set; } Property Value Int32 UseIncrementalDelay Use an incremental strategy for the delay: each retry doubles the previous delay time. Defaults to true Declaration public bool UseIncrementalDelay { get; set; } Property Value Boolean UseRetryAfterHeader Use the Retry-After header for calculating the delay in case of a retry. Defaults to true Declaration public bool UseRetryAfterHeader { get; set; } Property Value Boolean" + "keywords": "Class PnPCoreHttpRequestsAzureActiveDirectoryOptions Microsoft Graph REST options Inheritance System.Object PnPCoreHttpRequestsAzureActiveDirectoryOptions Namespace : PnP.Core.Services.Builder.Configuration Assembly : PnP.Core.dll Syntax public class PnPCoreHttpRequestsAzureActiveDirectoryOptions : object Properties DelayInSeconds How many seconds to wait for the next retry attempt. Defaults to 3 Declaration public int DelayInSeconds { get; set; } Property Value Int32 MaxRetries When not using retry-after, how many times can a retry be made. Defaults to 10 Declaration public int MaxRetries { get; set; } Property Value Int32 UseIncrementalDelay Use an incremental strategy for the delay: each retry doubles the previous delay time. Defaults to true Declaration public bool UseIncrementalDelay { get; set; } Property Value Boolean UseRetryAfterHeader Use the Retry-After header for calculating the delay in case of a retry. Defaults to true Declaration public bool UseRetryAfterHeader { get; set; } Property Value Boolean" }, "api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsGraphOptions.html": { "href": "api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsGraphOptions.html", "title": "Class PnPCoreHttpRequestsGraphOptions | PnP Core SDK", - "keywords": "Class PnPCoreHttpRequestsGraphOptions Microsoft Graph REST options Inheritance Object PnPCoreHttpRequestsGraphOptions Namespace : PnP.Core.Services.Builder.Configuration Assembly : PnP.Core.dll Syntax public class PnPCoreHttpRequestsGraphOptions : object Properties DelayInSeconds How many seconds to wait for the next retry attempt. Defaults to 3 Declaration public int DelayInSeconds { get; set; } Property Value Int32 MaxRetries When not using retry-after, how many times can a retry be made. Defaults to 10 Declaration public int MaxRetries { get; set; } Property Value Int32 UseIncrementalDelay Use an incremental strategy for the delay: each retry doubles the previous delay time. Defaults to true Declaration public bool UseIncrementalDelay { get; set; } Property Value Boolean UseRetryAfterHeader Use the Retry-After header for calculating the delay in case of a retry. Defaults to true Declaration public bool UseRetryAfterHeader { get; set; } Property Value Boolean" + "keywords": "Class PnPCoreHttpRequestsGraphOptions Microsoft Graph REST options Inheritance System.Object PnPCoreHttpRequestsGraphOptions Namespace : PnP.Core.Services.Builder.Configuration Assembly : PnP.Core.dll Syntax public class PnPCoreHttpRequestsGraphOptions : object Properties DelayInSeconds How many seconds to wait for the next retry attempt. Defaults to 3 Declaration public int DelayInSeconds { get; set; } Property Value Int32 MaxRetries When not using retry-after, how many times can a retry be made. Defaults to 10 Declaration public int MaxRetries { get; set; } Property Value Int32 UseIncrementalDelay Use an incremental strategy for the delay: each retry doubles the previous delay time. Defaults to true Declaration public bool UseIncrementalDelay { get; set; } Property Value Boolean UseRetryAfterHeader Use the Retry-After header for calculating the delay in case of a retry. Defaults to true Declaration public bool UseRetryAfterHeader { get; set; } Property Value Boolean" }, "api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsOptions.html": { "href": "api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsOptions.html", "title": "Class PnPCoreHttpRequestsOptions | PnP Core SDK", - "keywords": "Class PnPCoreHttpRequestsOptions Http request global settings Inheritance Object PnPCoreHttpRequestsOptions Namespace : PnP.Core.Services.Builder.Configuration Assembly : PnP.Core.dll Syntax public class PnPCoreHttpRequestsOptions : object Properties AzureActiveDirectory Azure AD options Declaration public PnPCoreHttpRequestsAzureActiveDirectoryOptions AzureActiveDirectory { get; set; } Property Value PnPCoreHttpRequestsAzureActiveDirectoryOptions MicrosoftGraph Microsoft Graph REST options Declaration public PnPCoreHttpRequestsGraphOptions MicrosoftGraph { get; set; } Property Value PnPCoreHttpRequestsGraphOptions RateLimiterMinimumCapacityLeft When set (e.g. to 10%) then RateLimit response headers coming from SharePoint and Graph are used: if there's less then the set value (e.g. 10%) capacity left before getting throttled the pending request will be delayed until the 1 minute window is reset. Defaults to 0 (disabled). Declaration public int RateLimiterMinimumCapacityLeft { get; set; } Property Value Int32 SharePointRest SharePoint Online REST options Declaration public PnPCoreHttpRequestsSharePointRestOptions SharePointRest { get; set; } Property Value PnPCoreHttpRequestsSharePointRestOptions Timeout HTTP request timeout in seconds to use when making calls to SharePoint or Microsoft Graph Declaration public int Timeout { get; set; } Property Value Int32 UserAgent User agent value, can be customized via configuration Declaration public string UserAgent { get; set; } Property Value String" + "keywords": "Class PnPCoreHttpRequestsOptions Http request global settings Inheritance System.Object PnPCoreHttpRequestsOptions Namespace : PnP.Core.Services.Builder.Configuration Assembly : PnP.Core.dll Syntax public class PnPCoreHttpRequestsOptions : object Properties AzureActiveDirectory Azure AD options Declaration public PnPCoreHttpRequestsAzureActiveDirectoryOptions AzureActiveDirectory { get; set; } Property Value PnPCoreHttpRequestsAzureActiveDirectoryOptions MicrosoftGraph Microsoft Graph REST options Declaration public PnPCoreHttpRequestsGraphOptions MicrosoftGraph { get; set; } Property Value PnPCoreHttpRequestsGraphOptions RateLimiterMinimumCapacityLeft When set (e.g. to 10%) then RateLimit response headers coming from SharePoint and Graph are used: if there's less then the set value (e.g. 10%) capacity left before getting throttled the pending request will be delayed until the 1 minute window is reset. Defaults to 0 (disabled). Declaration public int RateLimiterMinimumCapacityLeft { get; set; } Property Value Int32 SharePointRest SharePoint Online REST options Declaration public PnPCoreHttpRequestsSharePointRestOptions SharePointRest { get; set; } Property Value PnPCoreHttpRequestsSharePointRestOptions Timeout HTTP request timeout in seconds to use when making calls to SharePoint or Microsoft Graph Declaration public int Timeout { get; set; } Property Value Int32 UserAgent User agent value, can be customized via configuration Declaration public string UserAgent { get; set; } Property Value String" }, "api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsSharePointRestOptions.html": { "href": "api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsSharePointRestOptions.html", "title": "Class PnPCoreHttpRequestsSharePointRestOptions | PnP Core SDK", - "keywords": "Class PnPCoreHttpRequestsSharePointRestOptions SharePoint Online REST options Inheritance Object PnPCoreHttpRequestsSharePointRestOptions Namespace : PnP.Core.Services.Builder.Configuration Assembly : PnP.Core.dll Syntax public class PnPCoreHttpRequestsSharePointRestOptions : object Properties DefaultPageSize Defines the default page size for querying items in SharePoint REST Declaration public int DefaultPageSize { get; set; } Property Value Int32 DelayInSeconds How many seconds to wait for the next retry attempt. Defaults to 3 Declaration public int DelayInSeconds { get; set; } Property Value Int32 MaxRetries When not using retry-after, how many times can a retry be made. Defaults to 10 Declaration public int MaxRetries { get; set; } Property Value Int32 UseIncrementalDelay Use an incremental strategy for the delay: each retry doubles the previous delay time. Defaults to true Declaration public bool UseIncrementalDelay { get; set; } Property Value Boolean UseRetryAfterHeader Use the Retry-After header for calculating the delay in case of a retry. Defaults to false Declaration public bool UseRetryAfterHeader { get; set; } Property Value Boolean" + "keywords": "Class PnPCoreHttpRequestsSharePointRestOptions SharePoint Online REST options Inheritance System.Object PnPCoreHttpRequestsSharePointRestOptions Namespace : PnP.Core.Services.Builder.Configuration Assembly : PnP.Core.dll Syntax public class PnPCoreHttpRequestsSharePointRestOptions : object Properties DefaultPageSize Defines the default page size for querying items in SharePoint REST Declaration public int DefaultPageSize { get; set; } Property Value Int32 DelayInSeconds How many seconds to wait for the next retry attempt. Defaults to 3 Declaration public int DelayInSeconds { get; set; } Property Value Int32 MaxRetries When not using retry-after, how many times can a retry be made. Defaults to 10 Declaration public int MaxRetries { get; set; } Property Value Int32 UseIncrementalDelay Use an incremental strategy for the delay: each retry doubles the previous delay time. Defaults to true Declaration public bool UseIncrementalDelay { get; set; } Property Value Boolean UseRetryAfterHeader Use the Retry-After header for calculating the delay in case of a retry. Defaults to false Declaration public bool UseRetryAfterHeader { get; set; } Property Value Boolean" }, "api/PnP.Core.Services.Builder.Configuration.PnPCoreOptions.html": { "href": "api/PnP.Core.Services.Builder.Configuration.PnPCoreOptions.html", "title": "Class PnPCoreOptions | PnP Core SDK", - "keywords": "Class PnPCoreOptions Options for configuring PnP Core SDK Inheritance Object PnPCoreOptions Namespace : PnP.Core.Services.Builder.Configuration Assembly : PnP.Core.dll Syntax public class PnPCoreOptions : object Properties AADTenantId AAD tenant id, used for telemetry purposes. Can be customized via configuration Declaration public Guid AADTenantId { get; set; } Property Value Guid AzureADLoginAuthority Returns the Azure AD Login authority (e.g. login.microsoftonline.com) to use when Environment is set to Custom Declaration public string AzureADLoginAuthority { get; set; } Property Value String DefaultAuthenticationProvider The default Authentication Provider for the sites Declaration public IAuthenticationProvider DefaultAuthenticationProvider { get; set; } Property Value IAuthenticationProvider DisableTelemetry Turns on/off telemetry, can be customized via configuration. Defaults to false. Declaration public bool DisableTelemetry { get; set; } Property Value Boolean Environment The Microsoft 365 cloud environment that's used Declaration public string Environment { get; set; } Property Value String HttpRequests The global HTTP requests settings Declaration public PnPCoreHttpRequestsOptions HttpRequests { get; set; } Property Value PnPCoreHttpRequestsOptions MicrosoftGraphAuthority Returns the Microsoft Graph authority (e.g. graph.microsoft.com) to use when Environment is set to Custom Declaration public string MicrosoftGraphAuthority { get; set; } Property Value String PnPContext The global PnPContext options Declaration public PnPCoreContextOptions PnPContext { get; set; } Property Value PnPCoreContextOptions Sites The sites options Declaration public PnPCoreSitesOptions Sites { get; } Property Value PnPCoreSitesOptions" + "keywords": "Class PnPCoreOptions Options for configuring PnP Core SDK Inheritance System.Object PnPCoreOptions Namespace : PnP.Core.Services.Builder.Configuration Assembly : PnP.Core.dll Syntax public class PnPCoreOptions : object Properties AADTenantId AAD tenant id, used for telemetry purposes. Can be customized via configuration Declaration public Guid AADTenantId { get; set; } Property Value Guid AzureADLoginAuthority Returns the Azure AD Login authority (e.g. login.microsoftonline.com) to use when Environment is set to Custom Declaration public string AzureADLoginAuthority { get; set; } Property Value String DefaultAuthenticationProvider The default Authentication Provider for the sites Declaration public IAuthenticationProvider DefaultAuthenticationProvider { get; set; } Property Value IAuthenticationProvider DisableTelemetry Turns on/off telemetry, can be customized via configuration. Defaults to false. Declaration public bool DisableTelemetry { get; set; } Property Value Boolean Environment The Microsoft 365 cloud environment that's used Declaration public string Environment { get; set; } Property Value String HttpRequests The global HTTP requests settings Declaration public PnPCoreHttpRequestsOptions HttpRequests { get; set; } Property Value PnPCoreHttpRequestsOptions MicrosoftGraphAuthority Returns the Microsoft Graph authority (e.g. graph.microsoft.com) to use when Environment is set to Custom Declaration public string MicrosoftGraphAuthority { get; set; } Property Value String PnPContext The global PnPContext options Declaration public PnPCoreContextOptions PnPContext { get; set; } Property Value PnPCoreContextOptions Sites The sites options Declaration public PnPCoreSitesOptions Sites { get; } Property Value PnPCoreSitesOptions" }, "api/PnP.Core.Services.Builder.Configuration.PnPCoreSiteOptions.html": { "href": "api/PnP.Core.Services.Builder.Configuration.PnPCoreSiteOptions.html", "title": "Class PnPCoreSiteOptions | PnP Core SDK", - "keywords": "Class PnPCoreSiteOptions Options for configuring a single site in PnP Core SDK Inheritance Object PnPCoreSiteOptions Namespace : PnP.Core.Services.Builder.Configuration Assembly : PnP.Core.dll Syntax public class PnPCoreSiteOptions : object Properties AuthenticationProvider The Authentication Provider Declaration public IAuthenticationProvider AuthenticationProvider { get; set; } Property Value IAuthenticationProvider SiteUrl The URL of the target site Declaration public string SiteUrl { get; set; } Property Value String" + "keywords": "Class PnPCoreSiteOptions Options for configuring a single site in PnP Core SDK Inheritance System.Object PnPCoreSiteOptions Namespace : PnP.Core.Services.Builder.Configuration Assembly : PnP.Core.dll Syntax public class PnPCoreSiteOptions : object Properties AuthenticationProvider The Authentication Provider Declaration public IAuthenticationProvider AuthenticationProvider { get; set; } Property Value IAuthenticationProvider SiteUrl The URL of the target site Declaration public string SiteUrl { get; set; } Property Value String" }, "api/PnP.Core.Services.Builder.Configuration.PnPCoreSitesOptions.html": { "href": "api/PnP.Core.Services.Builder.Configuration.PnPCoreSitesOptions.html", "title": "Class PnPCoreSitesOptions | PnP Core SDK", - "keywords": "Class PnPCoreSitesOptions Options for configuring PnP Core SDK Inheritance Object PnPCoreSitesOptions Namespace : PnP.Core.Services.Builder.Configuration Assembly : PnP.Core.dll Syntax public class PnPCoreSitesOptions : Dictionary" + "keywords": "Class PnPCoreSitesOptions Options for configuring PnP Core SDK Inheritance System.Object PnPCoreSitesOptions Namespace : PnP.Core.Services.Builder.Configuration Assembly : PnP.Core.dll Syntax public class PnPCoreSitesOptions : Dictionary" }, "api/PnP.Core.Services.Builder.html": { "href": "api/PnP.Core.Services.Builder.html", @@ -3407,12 +3407,12 @@ "api/PnP.Core.Services.Builder.PnPCoreBuilder.html": { "href": "api/PnP.Core.Services.Builder.PnPCoreBuilder.html", "title": "Class PnPCoreBuilder | PnP Core SDK", - "keywords": "Class PnPCoreBuilder Used to configure PnP Core SDK Inheritance Object PnPCoreBuilder Namespace : PnP.Core.Services.Builder Assembly : PnP.Core.dll Syntax public class PnPCoreBuilder : object, IPnPCoreBuilder Constructors PnPCoreBuilder(IServiceCollection) Constructor Declaration public PnPCoreBuilder(IServiceCollection services) Parameters IServiceCollection services The services being configured. Properties Services The services being configured Declaration public virtual IServiceCollection Services { get; } Property Value IServiceCollection Implements IPnPCoreBuilder.Services" + "keywords": "Class PnPCoreBuilder Used to configure PnP Core SDK Inheritance System.Object PnPCoreBuilder Namespace : PnP.Core.Services.Builder Assembly : PnP.Core.dll Syntax public class PnPCoreBuilder : object, IPnPCoreBuilder Constructors PnPCoreBuilder(IServiceCollection) Constructor Declaration public PnPCoreBuilder(IServiceCollection services) Parameters IServiceCollection services The services being configured. Properties Services The services being configured Declaration public virtual IServiceCollection Services { get; } Property Value IServiceCollection Implements IPnPCoreBuilder.Services" }, "api/PnP.Core.Services.EventHub.html": { "href": "api/PnP.Core.Services.EventHub.html", "title": "Class EventHub | PnP Core SDK", - "keywords": "Class EventHub Class that allows a PnP Core SDK consumer to hookup with events being triggered from within PnP Core SDK Inheritance Object EventHub Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public sealed class EventHub : object Constructors EventHub() Default constructor Declaration public EventHub() Properties RequestRateLimitUpdate Event so subscribe to for getting event rate limit information Declaration public Action RequestRateLimitUpdate { get; set; } Property Value Action < IRateLimitEvent > RequestRateLimitWaitAsync Event to subscribe to for implementing a delay due to the rate limit information received via RequestRateLimitUpdate . Declaration public EventHub.RequestRateLimitWaitDelegate RequestRateLimitWaitAsync { get; set; } Property Value EventHub.RequestRateLimitWaitDelegate RequestRetry Event to subscribe to get notified whenever a request is getting retried due to throttling or an error Declaration public Action RequestRetry { get; set; } Property Value Action < IRetryEvent >" + "keywords": "Class EventHub Class that allows a PnP Core SDK consumer to hookup with events being triggered from within PnP Core SDK Inheritance System.Object EventHub Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public sealed class EventHub : object Constructors EventHub() Default constructor Declaration public EventHub() Properties RequestRateLimitUpdate Event so subscribe to for getting event rate limit information Declaration public Action RequestRateLimitUpdate { get; set; } Property Value Action < IRateLimitEvent > RequestRateLimitWaitAsync Event to subscribe to for implementing a delay due to the rate limit information received via RequestRateLimitUpdate . Declaration public EventHub.RequestRateLimitWaitDelegate RequestRateLimitWaitAsync { get; set; } Property Value EventHub.RequestRateLimitWaitDelegate RequestRetry Event to subscribe to get notified whenever a request is getting retried due to throttling or an error Declaration public Action RequestRetry { get; set; } Property Value Action < IRetryEvent >" }, "api/PnP.Core.Services.EventHub.RequestRateLimitWaitDelegate.html": { "href": "api/PnP.Core.Services.EventHub.RequestRateLimitWaitDelegate.html", @@ -3422,7 +3422,7 @@ "api/PnP.Core.Services.FromJson.html": { "href": "api/PnP.Core.Services.FromJson.html", "title": "Class FromJson | PnP Core SDK", - "keywords": "Class FromJson Class that represents the JSON context that's being used during call outs when parsing JSON responses Inheritance Object FromJson Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class FromJson : object" + "keywords": "Class FromJson Class that represents the JSON context that's being used during call outs when parsing JSON responses Inheritance System.Object FromJson Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class FromJson : object" }, "api/PnP.Core.Services.html": { "href": "api/PnP.Core.Services.html", @@ -3442,7 +3442,7 @@ "api/PnP.Core.Services.IPnPContext.html": { "href": "api/PnP.Core.Services.IPnPContext.html", "title": "Interface IPnPContext | PnP Core SDK", - "keywords": "Interface IPnPContext PnPContext interface to support mocking (that's the only reason) Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public interface IPnPContext Properties AuthenticationProvider Connected authentication provider Declaration IAuthenticationProvider AuthenticationProvider { get; } Property Value IAuthenticationProvider AzureADLoginAuthority Returns the Azure AD Login authority (e.g. login.microsoftonline.com) to use when Environment is set to Custom Declaration string AzureADLoginAuthority { get; } Property Value String ContentTypeHub Entry point for the ContentTypeHub Object Declaration IContentTypeHub ContentTypeHub { get; } Property Value IContentTypeHub Environment Returns the used Microsoft 365 cloud environment Declaration Microsoft365Environment? Environment { get; } Property Value Nullable < Microsoft365Environment > GraphAlwaysUseBeta If true than all requests to Microsoft Graph use the beta endpoint Declaration bool GraphAlwaysUseBeta { get; set; } Property Value Boolean GraphCanUseBeta If true than the Graph beta endpoint is used when there's no other option, default approach stays using the v1 endpoint Declaration bool GraphCanUseBeta { get; set; } Property Value Boolean GraphClient Connected Microsoft Graph client Declaration MicrosoftGraphClient GraphClient { get; } Property Value MicrosoftGraphClient GraphFirst Controls whether the library will try to use Microsoft Graph over REST whenever that's defined in the model Declaration bool GraphFirst { get; set; } Property Value Boolean Group Entry point for the Group Object Declaration IGraphGroup Group { get; } Property Value IGraphGroup HasPendingRequests Are there pending requests to execute (in the case of batching) Declaration bool HasPendingRequests { get; } Property Value Boolean Logger Connected logger Declaration ILogger Logger { get; } Property Value ILogger Me Entry point for the Me Object Declaration IMe Me { get; } Property Value IMe MicrosoftGraphAuthority Returns the Microsoft Graph authority (e.g. graph.microsoft.com) to use when Environment is set to Custom Declaration string MicrosoftGraphAuthority { get; } Property Value String Properties Collection for custom properties that you want to attach to a PnPContext Declaration IDictionary Properties { get; } Property Value IDictionary < String , Object > RestClient Connected SharePoint REST client Declaration SharePointRestClient RestClient { get; } Property Value SharePointRestClient Site Entry point for the Site Object Declaration ISite Site { get; } Property Value ISite Social Entry point for the Social Object Declaration ISocial Social { get; } Property Value ISocial Team Entry point for the Team Object Declaration ITeam Team { get; } Property Value ITeam TermStore Entry point for the TermStore Object Declaration ITermStore TermStore { get; } Property Value ITermStore Uri Uri of the SharePoint site we're working against Declaration Uri Uri { get; } Property Value Uri Web Entry point for the Web Object Declaration IWeb Web { get; } Property Value IWeb Methods Clone() Clones this context into a new context for the same SharePoint site Declaration PnPContext Clone() Returns PnPContext New PnPContext Clone(Guid) Clones this context for another SharePoint site Declaration PnPContext Clone(Guid groupId) Parameters Guid groupId Id of the other Microsoft 365 group to create a PnPContext for Returns PnPContext New PnPContext Clone(String) Clones this context for another SharePoint site provided as configuration Declaration PnPContext Clone(string name) Parameters String name The name of the SPOContext configuration to use Returns PnPContext New PnPContext for the request config Clone(Uri) Clones this context for another SharePoint site Declaration PnPContext Clone(Uri uri) Parameters Uri uri Uri of the other SharePoint site Returns PnPContext New PnPContext CloneAsync() Clones this context into a new context for the same SharePoint site Declaration Task CloneAsync() Returns Task < PnPContext > New PnPContext CloneAsync(Guid) Clones this context for another SharePoint site Declaration Task CloneAsync(Guid groupId) Parameters Guid groupId Id of the other Microsoft 365 group to create a PnPContext for Returns Task < PnPContext > New PnPContext CloneAsync(String) Clones this context for another SharePoint site provided as configuration Declaration Task CloneAsync(string name) Parameters String name The name of the SPOContext configuration to use Returns Task < PnPContext > New PnPContext for the request config CloneAsync(Uri) Clones this context for another SharePoint site Declaration Task CloneAsync(Uri uri) Parameters Uri uri Uri of the other SharePoint site Returns Task < PnPContext > New PnPContext Execute(Batch, Boolean) Method to execute a given batch Declaration List Execute(Batch batch, bool throwOnError = true) Parameters Batch batch Batch to execute Boolean throwOnError Throw an exception on the first encountered error in the batch Returns PnP.Core.Model.SharePoint.List < BatchResult > The asynchronous task that will be executed Execute(Boolean) Method to execute the current batch Declaration List Execute(bool throwOnError = true) Parameters Boolean throwOnError Throw an exception on the first encountered error in the batch Returns PnP.Core.Model.SharePoint.List < BatchResult > The asynchronous task that will be executed ExecuteAsync(Batch, Boolean) Method to execute a given batch Declaration Task> ExecuteAsync(Batch batch, bool throwOnError = true) Parameters Batch batch Batch to execute Boolean throwOnError Throw an exception on the first encountered error in the batch Returns Task < PnP.Core.Model.SharePoint.List < BatchResult >> The asynchronous task that will be executed ExecuteAsync(Boolean) Method to execute the current batch Declaration Task> ExecuteAsync(bool throwOnError = true) Parameters Boolean throwOnError Throw an exception on the first encountered error in the batch Returns Task < PnP.Core.Model.SharePoint.List < BatchResult >> The asynchronous task that will be executed GetLongRunningOperation(String) Gets an ongoing Graph long-running operation. Declaration ILongRunningOperation GetLongRunningOperation(string location) Parameters String location The location of the operation Returns ILongRunningOperation An ILongRunningOperation associated with the location Extension Methods PnPContextExtensions.GetSharePointAdmin(IPnPContext) PnPContextExtensions.GetSiteCollectionManager(IPnPContext) PnPContextExtensions.GetTeamManager(IPnPContext) PnPContextExtensions.GetTenantAppManager(IPnPContext) PnPContextExtensions.GetSiteCollectionAppManager(IPnPContext) PnPContextExtensions.GetMicrosoft365Admin(IPnPContext)" + "keywords": "Interface IPnPContext PnPContext interface to support mocking (that's the only reason) Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public interface IPnPContext Properties AuthenticationProvider Connected authentication provider Declaration IAuthenticationProvider AuthenticationProvider { get; } Property Value IAuthenticationProvider AzureADLoginAuthority Returns the Azure AD Login authority (e.g. login.microsoftonline.com) to use when Environment is set to Custom Declaration string AzureADLoginAuthority { get; } Property Value String ContentTypeHub Entry point for the ContentTypeHub Object Declaration IContentTypeHub ContentTypeHub { get; } Property Value IContentTypeHub Environment Returns the used Microsoft 365 cloud environment Declaration Microsoft365Environment? Environment { get; } Property Value Nullable < Microsoft365Environment > GraphAlwaysUseBeta If true than all requests to Microsoft Graph use the beta endpoint Declaration bool GraphAlwaysUseBeta { get; set; } Property Value Boolean GraphCanUseBeta If true than the Graph beta endpoint is used when there's no other option, default approach stays using the v1 endpoint Declaration bool GraphCanUseBeta { get; set; } Property Value Boolean GraphClient Connected Microsoft Graph client Declaration MicrosoftGraphClient GraphClient { get; } Property Value MicrosoftGraphClient GraphFirst Controls whether the library will try to use Microsoft Graph over REST whenever that's defined in the model Declaration bool GraphFirst { get; set; } Property Value Boolean Group Entry point for the Group Object Declaration IGraphGroup Group { get; } Property Value IGraphGroup HasPendingRequests Are there pending requests to execute (in the case of batching) Declaration bool HasPendingRequests { get; } Property Value Boolean Logger Connected logger Declaration ILogger Logger { get; } Property Value ILogger Me Entry point for the Me Object Declaration IMe Me { get; } Property Value IMe MicrosoftGraphAuthority Returns the Microsoft Graph authority (e.g. graph.microsoft.com) to use when Environment is set to Custom Declaration string MicrosoftGraphAuthority { get; } Property Value String Properties Collection for custom properties that you want to attach to a PnPContext Declaration IDictionary Properties { get; } Property Value IDictionary < String , System.Object > RestClient Connected SharePoint REST client Declaration SharePointRestClient RestClient { get; } Property Value SharePointRestClient Site Entry point for the Site Object Declaration ISite Site { get; } Property Value ISite Social Entry point for the Social Object Declaration ISocial Social { get; } Property Value ISocial Team Entry point for the Team Object Declaration ITeam Team { get; } Property Value ITeam TermStore Entry point for the TermStore Object Declaration ITermStore TermStore { get; } Property Value ITermStore Uri Uri of the SharePoint site we're working against Declaration Uri Uri { get; } Property Value Uri Web Entry point for the Web Object Declaration IWeb Web { get; } Property Value IWeb Methods Clone() Clones this context into a new context for the same SharePoint site Declaration PnPContext Clone() Returns PnPContext New PnPContext Clone(Guid) Clones this context for another SharePoint site Declaration PnPContext Clone(Guid groupId) Parameters Guid groupId Id of the other Microsoft 365 group to create a PnPContext for Returns PnPContext New PnPContext Clone(String) Clones this context for another SharePoint site provided as configuration Declaration PnPContext Clone(string name) Parameters String name The name of the SPOContext configuration to use Returns PnPContext New PnPContext for the request config Clone(Uri) Clones this context for another SharePoint site Declaration PnPContext Clone(Uri uri) Parameters Uri uri Uri of the other SharePoint site Returns PnPContext New PnPContext CloneAsync() Clones this context into a new context for the same SharePoint site Declaration Task CloneAsync() Returns Task < PnPContext > New PnPContext CloneAsync(Guid) Clones this context for another SharePoint site Declaration Task CloneAsync(Guid groupId) Parameters Guid groupId Id of the other Microsoft 365 group to create a PnPContext for Returns Task < PnPContext > New PnPContext CloneAsync(String) Clones this context for another SharePoint site provided as configuration Declaration Task CloneAsync(string name) Parameters String name The name of the SPOContext configuration to use Returns Task < PnPContext > New PnPContext for the request config CloneAsync(Uri) Clones this context for another SharePoint site Declaration Task CloneAsync(Uri uri) Parameters Uri uri Uri of the other SharePoint site Returns Task < PnPContext > New PnPContext Execute(Batch, Boolean) Method to execute a given batch Declaration List Execute(Batch batch, bool throwOnError = true) Parameters Batch batch Batch to execute Boolean throwOnError Throw an exception on the first encountered error in the batch Returns PnP.Core.Model.SharePoint.List < BatchResult > The asynchronous task that will be executed Execute(Boolean) Method to execute the current batch Declaration List Execute(bool throwOnError = true) Parameters Boolean throwOnError Throw an exception on the first encountered error in the batch Returns PnP.Core.Model.SharePoint.List < BatchResult > The asynchronous task that will be executed ExecuteAsync(Batch, Boolean) Method to execute a given batch Declaration Task> ExecuteAsync(Batch batch, bool throwOnError = true) Parameters Batch batch Batch to execute Boolean throwOnError Throw an exception on the first encountered error in the batch Returns Task < PnP.Core.Model.SharePoint.List < BatchResult >> The asynchronous task that will be executed ExecuteAsync(Boolean) Method to execute the current batch Declaration Task> ExecuteAsync(bool throwOnError = true) Parameters Boolean throwOnError Throw an exception on the first encountered error in the batch Returns Task < PnP.Core.Model.SharePoint.List < BatchResult >> The asynchronous task that will be executed GetLongRunningOperation(String) Gets an ongoing Graph long-running operation. Declaration ILongRunningOperation GetLongRunningOperation(string location) Parameters String location The location of the operation Returns ILongRunningOperation An ILongRunningOperation associated with the location Extension Methods PnPContextExtensions.GetSharePointAdmin(IPnPContext) PnPContextExtensions.GetSiteCollectionManager(IPnPContext) PnPContextExtensions.GetTeamManager(IPnPContext) PnPContextExtensions.GetTenantAppManager(IPnPContext) PnPContextExtensions.GetSiteCollectionAppManager(IPnPContext) PnPContextExtensions.GetMicrosoft365Admin(IPnPContext)" }, "api/PnP.Core.Services.IPnPContextExtensions.html": { "href": "api/PnP.Core.Services.IPnPContextExtensions.html", @@ -3452,7 +3452,7 @@ "api/PnP.Core.Services.IPnPContextExtensionsImplementation.html": { "href": "api/PnP.Core.Services.IPnPContextExtensionsImplementation.html", "title": "Class IPnPContextExtensionsImplementation | PnP Core SDK", - "keywords": "Class IPnPContextExtensionsImplementation Extends the IPnPContext with additional functionality Inheritance Object IPnPContextExtensionsImplementation Namespace : PnP.Core.Services Assembly : PnP.Core.Admin.dll Syntax public class IPnPContextExtensionsImplementation : object, IPnPContextExtensions Methods GetMicrosoft365Admin(IPnPContext) Extends a IPnPContext with Microsoft 365 admin functionality Declaration public IMicrosoft365Admin GetMicrosoft365Admin(IPnPContext context) Parameters IPnPContext context IPnPContext to extend Returns IMicrosoft365Admin An IMicrosoft365Admin instance enabling Microsoft 365 admin operations Implements IPnPContextExtensions.GetMicrosoft365Admin(IPnPContext) GetSharePointAdmin(IPnPContext) Extends a IPnPContext with SharePoint admin functionality Declaration public ISharePointAdmin GetSharePointAdmin(IPnPContext context) Parameters IPnPContext context IPnPContext to extend Returns ISharePointAdmin An ISharePointAdmin instance enabling SharePoint admin operations Implements IPnPContextExtensions.GetSharePointAdmin(IPnPContext) GetSiteCollectionAppManager(IPnPContext) Extends a IPnPContext with site collection Application Lifecycle Management (ALM) functionality Declaration public ISiteCollectionAppManager GetSiteCollectionAppManager(IPnPContext context) Parameters IPnPContext context IPnPContext to extend Returns ISiteCollectionAppManager An ISiteCollectionAppManager instance enabling site collection app catalog operations Implements IPnPContextExtensions.GetSiteCollectionAppManager(IPnPContext) GetSiteCollectionManager(IPnPContext) Extends a IPnPContext with site collection admin functionality Declaration public ISiteCollectionManager GetSiteCollectionManager(IPnPContext context) Parameters IPnPContext context IPnPContext to extend Returns ISiteCollectionManager An ISiteCollectionManager instance enabling site collection admin operations Implements IPnPContextExtensions.GetSiteCollectionManager(IPnPContext) GetTeamManager(IPnPContext) Extends a IPnPContext with Teams admin functionality Declaration public ITeamManager GetTeamManager(IPnPContext context) Parameters IPnPContext context IPnPContext to extend Returns ITeamManager An ISiteCollectionManager instance enabling site collection admin operations Implements IPnPContextExtensions.GetTeamManager(IPnPContext) GetTenantAppManager(IPnPContext) Extends a IPnPContext with tenant Application Lifecycle Management (ALM) functionality Declaration public ITenantAppManager GetTenantAppManager(IPnPContext context) Parameters IPnPContext context IPnPContext to extend Returns ITenantAppManager An ITenantAppManager instance enabling tenant app catalog operations Implements IPnPContextExtensions.GetTenantAppManager(IPnPContext)" + "keywords": "Class IPnPContextExtensionsImplementation Extends the IPnPContext with additional functionality Inheritance System.Object IPnPContextExtensionsImplementation Namespace : PnP.Core.Services Assembly : PnP.Core.Admin.dll Syntax public class IPnPContextExtensionsImplementation : object, IPnPContextExtensions Methods GetMicrosoft365Admin(IPnPContext) Extends a IPnPContext with Microsoft 365 admin functionality Declaration public IMicrosoft365Admin GetMicrosoft365Admin(IPnPContext context) Parameters IPnPContext context IPnPContext to extend Returns IMicrosoft365Admin An IMicrosoft365Admin instance enabling Microsoft 365 admin operations Implements IPnPContextExtensions.GetMicrosoft365Admin(IPnPContext) GetSharePointAdmin(IPnPContext) Extends a IPnPContext with SharePoint admin functionality Declaration public ISharePointAdmin GetSharePointAdmin(IPnPContext context) Parameters IPnPContext context IPnPContext to extend Returns ISharePointAdmin An ISharePointAdmin instance enabling SharePoint admin operations Implements IPnPContextExtensions.GetSharePointAdmin(IPnPContext) GetSiteCollectionAppManager(IPnPContext) Extends a IPnPContext with site collection Application Lifecycle Management (ALM) functionality Declaration public ISiteCollectionAppManager GetSiteCollectionAppManager(IPnPContext context) Parameters IPnPContext context IPnPContext to extend Returns ISiteCollectionAppManager An ISiteCollectionAppManager instance enabling site collection app catalog operations Implements IPnPContextExtensions.GetSiteCollectionAppManager(IPnPContext) GetSiteCollectionManager(IPnPContext) Extends a IPnPContext with site collection admin functionality Declaration public ISiteCollectionManager GetSiteCollectionManager(IPnPContext context) Parameters IPnPContext context IPnPContext to extend Returns ISiteCollectionManager An ISiteCollectionManager instance enabling site collection admin operations Implements IPnPContextExtensions.GetSiteCollectionManager(IPnPContext) GetTeamManager(IPnPContext) Extends a IPnPContext with Teams admin functionality Declaration public ITeamManager GetTeamManager(IPnPContext context) Parameters IPnPContext context IPnPContext to extend Returns ITeamManager An ISiteCollectionManager instance enabling site collection admin operations Implements IPnPContextExtensions.GetTeamManager(IPnPContext) GetTenantAppManager(IPnPContext) Extends a IPnPContext with tenant Application Lifecycle Management (ALM) functionality Declaration public ITenantAppManager GetTenantAppManager(IPnPContext context) Parameters IPnPContext context IPnPContext to extend Returns ITenantAppManager An ITenantAppManager instance enabling tenant app catalog operations Implements IPnPContextExtensions.GetTenantAppManager(IPnPContext)" }, "api/PnP.Core.Services.IPnPContextFactory.html": { "href": "api/PnP.Core.Services.IPnPContextFactory.html", @@ -3462,12 +3462,12 @@ "api/PnP.Core.Services.IRateLimitEvent.html": { "href": "api/PnP.Core.Services.IRateLimitEvent.html", "title": "Interface IRateLimitEvent | PnP Core SDK", - "keywords": "Interface IRateLimitEvent Event containing information about the happened rate limit event Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public interface IRateLimitEvent Properties Limit Maximum number of requests per window Declaration int Limit { get; } Property Value Int32 Properties Event property bag Declaration IDictionary Properties { get; } Property Value IDictionary < String , Object > Remaining The remaining requests in the current window. Declaration int Remaining { get; } Property Value Int32 Request Request that was retried Declaration Uri Request { get; } Property Value Uri Reset The time, in , when the current window gets reset Declaration int Reset { get; } Property Value Int32" + "keywords": "Interface IRateLimitEvent Event containing information about the happened rate limit event Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public interface IRateLimitEvent Properties Limit Maximum number of requests per window Declaration int Limit { get; } Property Value Int32 Properties Event property bag Declaration IDictionary Properties { get; } Property Value IDictionary < String , System.Object > Remaining The remaining requests in the current window. Declaration int Remaining { get; } Property Value Int32 Request Request that was retried Declaration Uri Request { get; } Property Value Uri Reset The time, in , when the current window gets reset Declaration int Reset { get; } Property Value Int32" }, "api/PnP.Core.Services.IRetryEvent.html": { "href": "api/PnP.Core.Services.IRetryEvent.html", "title": "Interface IRetryEvent | PnP Core SDK", - "keywords": "Interface IRetryEvent Event containing information about the happened retry Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public interface IRetryEvent Properties Exception SocketException that triggered the retry Declaration Exception Exception { get; } Property Value Exception HttpStatusCode Http status code for the retried request Declaration int HttpStatusCode { get; } Property Value Int32 Properties Event property bag Declaration IDictionary Properties { get; } Property Value IDictionary < String , Object > Request Request that was retried Declaration Uri Request { get; } Property Value Uri WaitTime Wait before the next try in seconds Declaration int WaitTime { get; } Property Value Int32" + "keywords": "Interface IRetryEvent Event containing information about the happened retry Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public interface IRetryEvent Properties Exception SocketException that triggered the retry Declaration Exception Exception { get; } Property Value Exception HttpStatusCode Http status code for the retried request Declaration int HttpStatusCode { get; } Property Value Int32 Properties Event property bag Declaration IDictionary Properties { get; } Property Value IDictionary < String , System.Object > Request Request that was retried Declaration Uri Request { get; } Property Value Uri WaitTime Wait before the next try in seconds Declaration int WaitTime { get; } Property Value Int32" }, "api/PnP.Core.Services.Microsoft365Environment.html": { "href": "api/PnP.Core.Services.Microsoft365Environment.html", @@ -3477,72 +3477,72 @@ "api/PnP.Core.Services.MicrosoftGraphClient.html": { "href": "api/PnP.Core.Services.MicrosoftGraphClient.html", "title": "Class MicrosoftGraphClient | PnP Core SDK", - "keywords": "Class MicrosoftGraphClient Client that handles all Microsoft Graph requests Inheritance Object MicrosoftGraphClient Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class MicrosoftGraphClient : object Constructors MicrosoftGraphClient(HttpClient, ILogger, IOptions) Constructs the Microsoft Graph http client Declaration public MicrosoftGraphClient(HttpClient client, ILogger log, IOptions options) Parameters HttpClient client Http client instance ILogger < MicrosoftGraphClient > log Logger IOptions < PnPGlobalSettingsOptions > options Settings to configure the http client Properties Client Returns the configured Microsoft Graph http client Declaration public HttpClient Client { get; } Property Value HttpClient" + "keywords": "Class MicrosoftGraphClient Client that handles all Microsoft Graph requests Inheritance System.Object MicrosoftGraphClient Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class MicrosoftGraphClient : object Constructors MicrosoftGraphClient(HttpClient, ILogger, IOptions) Constructs the Microsoft Graph http client Declaration public MicrosoftGraphClient(HttpClient client, ILogger log, IOptions options) Parameters HttpClient client Http client instance ILogger < MicrosoftGraphClient > log Logger IOptions < PnPGlobalSettingsOptions > options Settings to configure the http client Properties Client Returns the configured Microsoft Graph http client Declaration public HttpClient Client { get; } Property Value HttpClient" }, "api/PnP.Core.Services.PnPContext.html": { "href": "api/PnP.Core.Services.PnPContext.html", "title": "Class PnPContext | PnP Core SDK", - "keywords": "Class PnPContext PnP Context class...the glue between the model and the data stores Inheritance Object PnPContext Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class PnPContext : IDisposable, IPnPContext Properties AuthenticationProvider Connected authentication provider Declaration public IAuthenticationProvider AuthenticationProvider { get; } Property Value IAuthenticationProvider Implements IPnPContext.AuthenticationProvider AzureADLoginAuthority Returns the Azure AD Login authority (e.g. login.microsoftonline.com) to use when Environment is set to Custom Declaration public string AzureADLoginAuthority { get; } Property Value String Implements IPnPContext.AzureADLoginAuthority ContentTypeHub Entry point for the ContentTypeHub object Declaration public IContentTypeHub ContentTypeHub { get; } Property Value IContentTypeHub Implements IPnPContext.ContentTypeHub CurrentBatch Current batch, used for implicit batching Declaration public Batch CurrentBatch { get; } Property Value Batch Environment Returns the used Microsoft 365 cloud environment Declaration public Microsoft365Environment? Environment { get; } Property Value Nullable < Microsoft365Environment > Implements IPnPContext.Environment GraphAlwaysUseBeta If true than all requests to Microsoft Graph use the beta endpoint Declaration public bool GraphAlwaysUseBeta { get; set; } Property Value Boolean Implements IPnPContext.GraphAlwaysUseBeta GraphCanUseBeta If true than the Graph beta endpoint is used when there's no other option, default approach stays using the v1 endpoint Declaration public bool GraphCanUseBeta { get; set; } Property Value Boolean Implements IPnPContext.GraphCanUseBeta GraphClient Connected Microsoft Graph client Declaration public MicrosoftGraphClient GraphClient { get; } Property Value MicrosoftGraphClient Implements IPnPContext.GraphClient GraphFirst Controls whether the library will try to use Microsoft Graph over REST whenever that's defined in the model Declaration public bool GraphFirst { get; set; } Property Value Boolean Implements IPnPContext.GraphFirst Group Entry point for the Microsoft 365 Group Object Declaration public IGraphGroup Group { get; } Property Value IGraphGroup Implements IPnPContext.Group HasPendingRequests Are there pending requests to execute (in the case of batching) Declaration public bool HasPendingRequests { get; } Property Value Boolean Implements IPnPContext.HasPendingRequests Logger Connected logger Declaration public ILogger Logger { get; } Property Value ILogger Implements IPnPContext.Logger Me Entry point for the Me object Declaration public IMe Me { get; } Property Value IMe Implements IPnPContext.Me MicrosoftGraphAuthority Returns the Microsoft Graph authority (e.g. graph.microsoft.com) to use when Environment is set to Custom Declaration public string MicrosoftGraphAuthority { get; } Property Value String Implements IPnPContext.MicrosoftGraphAuthority Properties Collection for custom properties that you want to attach to a PnPContext Declaration public IDictionary Properties { get; } Property Value IDictionary < String , Object > Implements IPnPContext.Properties RestClient Connected SharePoint REST client Declaration public SharePointRestClient RestClient { get; } Property Value SharePointRestClient Implements IPnPContext.RestClient Site Entry point for the Site Object Declaration public ISite Site { get; } Property Value ISite Implements IPnPContext.Site Social Entry point for the social-related APIs Declaration public ISocial Social { get; } Property Value ISocial Implements IPnPContext.Social Team Entry point for the Team Object Declaration public ITeam Team { get; } Property Value ITeam Implements IPnPContext.Team TermStore Entry point for the Microsoft 365 TermStore Declaration public ITermStore TermStore { get; } Property Value ITermStore Implements IPnPContext.TermStore Uri Uri of the SharePoint site we're working against Declaration public Uri Uri { get; } Property Value Uri Implements IPnPContext.Uri Web Entry point for the Web Object Declaration public IWeb Web { get; } Property Value IWeb Implements IPnPContext.Web Methods Clone() Clones this context into a new context for the same SharePoint site Declaration public PnPContext Clone() Returns PnPContext New PnPContext Implements IPnPContext.Clone() Clone(Guid) Clones this context for another SharePoint site Declaration public PnPContext Clone(Guid groupId) Parameters Guid groupId Id of the other Microsoft 365 group to create a PnPContext for Returns PnPContext New PnPContext Implements IPnPContext.Clone(Guid) Clone(String) Clones this context for another SharePoint site provided as configuration Declaration public PnPContext Clone(string name) Parameters String name The name of the SPOContext configuration to use Returns PnPContext New PnPContext for the request config Implements IPnPContext.Clone(String) Clone(Uri) Clones this context for another SharePoint site Declaration public PnPContext Clone(Uri uri) Parameters Uri uri Uri of the other SharePoint site Returns PnPContext New PnPContext Implements IPnPContext.Clone(Uri) CloneAsync() Clones this context into a new context for the same SharePoint site Declaration public async Task CloneAsync() Returns Task < PnPContext > New PnPContext Implements IPnPContext.CloneAsync() CloneAsync(Guid) Clones this context for another SharePoint site Declaration public async Task CloneAsync(Guid groupId) Parameters Guid groupId Id of the other Microsoft 365 group to create a PnPContext for Returns Task < PnPContext > New PnPContext Implements IPnPContext.CloneAsync(Guid) CloneAsync(String) Clones this context for another SharePoint site provided as configuration Declaration public async Task CloneAsync(string name) Parameters String name The name of the SPOContext configuration to use Returns Task < PnPContext > New PnPContext for the request config Implements IPnPContext.CloneAsync(String) CloneAsync(Uri) Clones this context for another SharePoint site Declaration public async Task CloneAsync(Uri uri) Parameters Uri uri Uri of the other SharePoint site Returns Task < PnPContext > New PnPContext Implements IPnPContext.CloneAsync(Uri) Dispose() Disposes this PnPContext Declaration public void Dispose() Dispose(Boolean) Disposes this PnPContext Declaration protected virtual void Dispose(bool disposing) Parameters Boolean disposing Do we need to dispose resources Execute(Batch, Boolean) Method to execute a given batch Declaration public List Execute(Batch batch, bool throwOnError = true) Parameters Batch batch Batch to execute Boolean throwOnError Throw an exception on the first encountered error in the batch Returns PnP.Core.Model.SharePoint.List < BatchResult > The asynchronous task that will be executed Implements IPnPContext.Execute(Batch, Boolean) Execute(Boolean) Method to execute the current batch Declaration public List Execute(bool throwOnError = true) Parameters Boolean throwOnError Throw an exception on the first encountered error in the batch Returns PnP.Core.Model.SharePoint.List < BatchResult > The asynchronous task that will be executed Implements IPnPContext.Execute(Boolean) ExecuteAsync(Batch, Boolean) Method to execute a given batch Declaration public async Task> ExecuteAsync(Batch batch, bool throwOnError = true) Parameters Batch batch Batch to execute Boolean throwOnError Throw an exception on the first encountered error in the batch Returns Task < PnP.Core.Model.SharePoint.List < BatchResult >> The asynchronous task that will be executed Implements IPnPContext.ExecuteAsync(Batch, Boolean) ExecuteAsync(Boolean) Method to execute the current batch Declaration public async Task> ExecuteAsync(bool throwOnError = true) Parameters Boolean throwOnError Throw an exception on the first encountered error in the batch Returns Task < PnP.Core.Model.SharePoint.List < BatchResult >> The asynchronous task that will be executed Implements IPnPContext.ExecuteAsync(Boolean) GetLongRunningOperation(String) Gets an ongoing Graph long-running operation. Declaration public ILongRunningOperation GetLongRunningOperation(string location) Parameters String location The location of the operation Returns ILongRunningOperation An ILongRunningOperation associated with the location Implements IPnPContext.GetLongRunningOperation(String) NewBatch() Creates a new batch Declaration public Batch NewBatch() Returns Batch" + "keywords": "Class PnPContext PnP Context class...the glue between the model and the data stores Inheritance System.Object PnPContext Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class PnPContext : IDisposable, IPnPContext Properties AuthenticationProvider Connected authentication provider Declaration public IAuthenticationProvider AuthenticationProvider { get; } Property Value IAuthenticationProvider Implements IPnPContext.AuthenticationProvider AzureADLoginAuthority Returns the Azure AD Login authority (e.g. login.microsoftonline.com) to use when Environment is set to Custom Declaration public string AzureADLoginAuthority { get; } Property Value String Implements IPnPContext.AzureADLoginAuthority ContentTypeHub Entry point for the ContentTypeHub object Declaration public IContentTypeHub ContentTypeHub { get; } Property Value IContentTypeHub Implements IPnPContext.ContentTypeHub CurrentBatch Current batch, used for implicit batching Declaration public Batch CurrentBatch { get; } Property Value Batch Environment Returns the used Microsoft 365 cloud environment Declaration public Microsoft365Environment? Environment { get; } Property Value Nullable < Microsoft365Environment > Implements IPnPContext.Environment GraphAlwaysUseBeta If true than all requests to Microsoft Graph use the beta endpoint Declaration public bool GraphAlwaysUseBeta { get; set; } Property Value Boolean Implements IPnPContext.GraphAlwaysUseBeta GraphCanUseBeta If true than the Graph beta endpoint is used when there's no other option, default approach stays using the v1 endpoint Declaration public bool GraphCanUseBeta { get; set; } Property Value Boolean Implements IPnPContext.GraphCanUseBeta GraphClient Connected Microsoft Graph client Declaration public MicrosoftGraphClient GraphClient { get; } Property Value MicrosoftGraphClient Implements IPnPContext.GraphClient GraphFirst Controls whether the library will try to use Microsoft Graph over REST whenever that's defined in the model Declaration public bool GraphFirst { get; set; } Property Value Boolean Implements IPnPContext.GraphFirst Group Entry point for the Microsoft 365 Group Object Declaration public IGraphGroup Group { get; } Property Value IGraphGroup Implements IPnPContext.Group HasPendingRequests Are there pending requests to execute (in the case of batching) Declaration public bool HasPendingRequests { get; } Property Value Boolean Implements IPnPContext.HasPendingRequests Logger Connected logger Declaration public ILogger Logger { get; } Property Value ILogger Implements IPnPContext.Logger Me Entry point for the Me object Declaration public IMe Me { get; } Property Value IMe Implements IPnPContext.Me MicrosoftGraphAuthority Returns the Microsoft Graph authority (e.g. graph.microsoft.com) to use when Environment is set to Custom Declaration public string MicrosoftGraphAuthority { get; } Property Value String Implements IPnPContext.MicrosoftGraphAuthority Properties Collection for custom properties that you want to attach to a PnPContext Declaration public IDictionary Properties { get; } Property Value IDictionary < String , System.Object > Implements IPnPContext.Properties RestClient Connected SharePoint REST client Declaration public SharePointRestClient RestClient { get; } Property Value SharePointRestClient Implements IPnPContext.RestClient Site Entry point for the Site Object Declaration public ISite Site { get; } Property Value ISite Implements IPnPContext.Site Social Entry point for the social-related APIs Declaration public ISocial Social { get; } Property Value ISocial Implements IPnPContext.Social Team Entry point for the Team Object Declaration public ITeam Team { get; } Property Value ITeam Implements IPnPContext.Team TermStore Entry point for the Microsoft 365 TermStore Declaration public ITermStore TermStore { get; } Property Value ITermStore Implements IPnPContext.TermStore Uri Uri of the SharePoint site we're working against Declaration public Uri Uri { get; } Property Value Uri Implements IPnPContext.Uri Web Entry point for the Web Object Declaration public IWeb Web { get; } Property Value IWeb Implements IPnPContext.Web Methods Clone() Clones this context into a new context for the same SharePoint site Declaration public PnPContext Clone() Returns PnPContext New PnPContext Implements IPnPContext.Clone() Clone(Guid) Clones this context for another SharePoint site Declaration public PnPContext Clone(Guid groupId) Parameters Guid groupId Id of the other Microsoft 365 group to create a PnPContext for Returns PnPContext New PnPContext Implements IPnPContext.Clone(Guid) Clone(String) Clones this context for another SharePoint site provided as configuration Declaration public PnPContext Clone(string name) Parameters String name The name of the SPOContext configuration to use Returns PnPContext New PnPContext for the request config Implements IPnPContext.Clone(String) Clone(Uri) Clones this context for another SharePoint site Declaration public PnPContext Clone(Uri uri) Parameters Uri uri Uri of the other SharePoint site Returns PnPContext New PnPContext Implements IPnPContext.Clone(Uri) CloneAsync() Clones this context into a new context for the same SharePoint site Declaration public async Task CloneAsync() Returns Task < PnPContext > New PnPContext Implements IPnPContext.CloneAsync() CloneAsync(Guid) Clones this context for another SharePoint site Declaration public async Task CloneAsync(Guid groupId) Parameters Guid groupId Id of the other Microsoft 365 group to create a PnPContext for Returns Task < PnPContext > New PnPContext Implements IPnPContext.CloneAsync(Guid) CloneAsync(String) Clones this context for another SharePoint site provided as configuration Declaration public async Task CloneAsync(string name) Parameters String name The name of the SPOContext configuration to use Returns Task < PnPContext > New PnPContext for the request config Implements IPnPContext.CloneAsync(String) CloneAsync(Uri) Clones this context for another SharePoint site Declaration public async Task CloneAsync(Uri uri) Parameters Uri uri Uri of the other SharePoint site Returns Task < PnPContext > New PnPContext Implements IPnPContext.CloneAsync(Uri) Dispose() Disposes this PnPContext Declaration public void Dispose() Dispose(Boolean) Disposes this PnPContext Declaration protected virtual void Dispose(bool disposing) Parameters Boolean disposing Do we need to dispose resources Execute(Batch, Boolean) Method to execute a given batch Declaration public List Execute(Batch batch, bool throwOnError = true) Parameters Batch batch Batch to execute Boolean throwOnError Throw an exception on the first encountered error in the batch Returns PnP.Core.Model.SharePoint.List < BatchResult > The asynchronous task that will be executed Implements IPnPContext.Execute(Batch, Boolean) Execute(Boolean) Method to execute the current batch Declaration public List Execute(bool throwOnError = true) Parameters Boolean throwOnError Throw an exception on the first encountered error in the batch Returns PnP.Core.Model.SharePoint.List < BatchResult > The asynchronous task that will be executed Implements IPnPContext.Execute(Boolean) ExecuteAsync(Batch, Boolean) Method to execute a given batch Declaration public async Task> ExecuteAsync(Batch batch, bool throwOnError = true) Parameters Batch batch Batch to execute Boolean throwOnError Throw an exception on the first encountered error in the batch Returns Task < PnP.Core.Model.SharePoint.List < BatchResult >> The asynchronous task that will be executed Implements IPnPContext.ExecuteAsync(Batch, Boolean) ExecuteAsync(Boolean) Method to execute the current batch Declaration public async Task> ExecuteAsync(bool throwOnError = true) Parameters Boolean throwOnError Throw an exception on the first encountered error in the batch Returns Task < PnP.Core.Model.SharePoint.List < BatchResult >> The asynchronous task that will be executed Implements IPnPContext.ExecuteAsync(Boolean) GetLongRunningOperation(String) Gets an ongoing Graph long-running operation. Declaration public ILongRunningOperation GetLongRunningOperation(string location) Parameters String location The location of the operation Returns ILongRunningOperation An ILongRunningOperation associated with the location Implements IPnPContext.GetLongRunningOperation(String) NewBatch() Creates a new batch Declaration public Batch NewBatch() Returns Batch" }, "api/PnP.Core.Services.PnPContextExtensions.html": { "href": "api/PnP.Core.Services.PnPContextExtensions.html", "title": "Class PnPContextExtensions | PnP Core SDK", - "keywords": "Class PnPContextExtensions Extends the PnPContext with additional functionality Inheritance Object PnPContextExtensions Namespace : PnP.Core.Services Assembly : PnP.Core.Admin.dll Syntax public static class PnPContextExtensions : object Properties Implementation Allows you to replace the default implementation of IPnPContextExtensions with your own implementation. Declaration public static IPnPContextExtensions Implementation { set; } Property Value IPnPContextExtensions Methods GetMicrosoft365Admin(IPnPContext) Extends a PnPContext with Microsoft 365 admin functionality Declaration public static IMicrosoft365Admin GetMicrosoft365Admin(this IPnPContext context) Parameters IPnPContext context PnPContext to extend Returns IMicrosoft365Admin An IMicrosoft365Admin instance enabling Microsoft 365 admin operations GetSharePointAdmin(IPnPContext) Extends a IPnPContext with SharePoint admin functionality Declaration public static ISharePointAdmin GetSharePointAdmin(this IPnPContext context) Parameters IPnPContext context IPnPContext to extend Returns ISharePointAdmin An ISharePointAdmin instance enabling SharePoint admin operations GetSiteCollectionAppManager(IPnPContext) Extends a PnPContext with site collection Application Lifecycle Management (ALM) functionality Declaration public static ISiteCollectionAppManager GetSiteCollectionAppManager(this IPnPContext context) Parameters IPnPContext context PnPContext to extend Returns ISiteCollectionAppManager An ISiteCollectionAppManager instance enabling site collection app catalog operations GetSiteCollectionManager(IPnPContext) Extends a IPnPContext with site collection admin functionality Declaration public static ISiteCollectionManager GetSiteCollectionManager(this IPnPContext context) Parameters IPnPContext context IPnPContext to extend Returns ISiteCollectionManager An ISiteCollectionManager instance enabling site collection admin operations GetTeamManager(IPnPContext) Extends a PnPContext with Teams admin functionality Declaration public static ITeamManager GetTeamManager(this IPnPContext context) Parameters IPnPContext context PnPContext to extend Returns ITeamManager An ISiteCollectionManager instance enabling site collection admin operations GetTenantAppManager(IPnPContext) Extends a PnPContext with tenant Application Lifecycle Management (ALM) functionality Declaration public static ITenantAppManager GetTenantAppManager(this IPnPContext context) Parameters IPnPContext context PnPContext to extend Returns ITenantAppManager An ITenantAppManager instance enabling tenant app catalog operations RevertToDefaultImplementation() When you've replaced the default implementation of IPnPContextExtensions with your own, you can use this method to revert back to the default implementation. Declaration public static void RevertToDefaultImplementation()" + "keywords": "Class PnPContextExtensions Extends the PnPContext with additional functionality Inheritance System.Object PnPContextExtensions Namespace : PnP.Core.Services Assembly : PnP.Core.Admin.dll Syntax public static class PnPContextExtensions : object Properties Implementation Allows you to replace the default implementation of IPnPContextExtensions with your own implementation. Declaration public static IPnPContextExtensions Implementation { set; } Property Value IPnPContextExtensions Methods GetMicrosoft365Admin(IPnPContext) Extends a PnPContext with Microsoft 365 admin functionality Declaration public static IMicrosoft365Admin GetMicrosoft365Admin(this IPnPContext context) Parameters IPnPContext context PnPContext to extend Returns IMicrosoft365Admin An IMicrosoft365Admin instance enabling Microsoft 365 admin operations GetSharePointAdmin(IPnPContext) Extends a IPnPContext with SharePoint admin functionality Declaration public static ISharePointAdmin GetSharePointAdmin(this IPnPContext context) Parameters IPnPContext context IPnPContext to extend Returns ISharePointAdmin An ISharePointAdmin instance enabling SharePoint admin operations GetSiteCollectionAppManager(IPnPContext) Extends a PnPContext with site collection Application Lifecycle Management (ALM) functionality Declaration public static ISiteCollectionAppManager GetSiteCollectionAppManager(this IPnPContext context) Parameters IPnPContext context PnPContext to extend Returns ISiteCollectionAppManager An ISiteCollectionAppManager instance enabling site collection app catalog operations GetSiteCollectionManager(IPnPContext) Extends a IPnPContext with site collection admin functionality Declaration public static ISiteCollectionManager GetSiteCollectionManager(this IPnPContext context) Parameters IPnPContext context IPnPContext to extend Returns ISiteCollectionManager An ISiteCollectionManager instance enabling site collection admin operations GetTeamManager(IPnPContext) Extends a PnPContext with Teams admin functionality Declaration public static ITeamManager GetTeamManager(this IPnPContext context) Parameters IPnPContext context PnPContext to extend Returns ITeamManager An ISiteCollectionManager instance enabling site collection admin operations GetTenantAppManager(IPnPContext) Extends a PnPContext with tenant Application Lifecycle Management (ALM) functionality Declaration public static ITenantAppManager GetTenantAppManager(this IPnPContext context) Parameters IPnPContext context PnPContext to extend Returns ITenantAppManager An ITenantAppManager instance enabling tenant app catalog operations RevertToDefaultImplementation() When you've replaced the default implementation of IPnPContextExtensions with your own, you can use this method to revert back to the default implementation. Declaration public static void RevertToDefaultImplementation()" }, "api/PnP.Core.Services.PnPContextFactory.html": { "href": "api/PnP.Core.Services.PnPContextFactory.html", "title": "Class PnPContextFactory | PnP Core SDK", - "keywords": "Class PnPContextFactory Public factory service to create PnPContext object instances Inheritance Object PnPContextFactory Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class PnPContextFactory : object, IPnPContextFactory Constructors PnPContextFactory(ILogger, SharePointRestClient, MicrosoftGraphClient, IOptions, IOptions, EventHub) Default constructor for PnPContextFactory Declaration public PnPContextFactory(ILogger logger, SharePointRestClient sharePointRestClient, MicrosoftGraphClient microsoftGraphClient, IOptions contextOptions, IOptions globalOptions, EventHub eventHub) Parameters ILogger < PnPContext > logger Connected logger SharePointRestClient sharePointRestClient SharePoint REST http client to use MicrosoftGraphClient microsoftGraphClient Microsoft Graph http client to use IOptions < PnPContextFactoryOptions > contextOptions PnPContextFactory options IOptions < PnPGlobalSettingsOptions > globalOptions Global options to use EventHub eventHub EventHub instance Properties ContextOptions Options used to configure this PnPContext Declaration protected PnPContextFactoryOptions ContextOptions { get; } Property Value PnPContextFactoryOptions EventHub Gets the EventHub instance, can be used to tap into events like request retry (due to throttling) Declaration public EventHub EventHub { get; } Property Value EventHub Implements IPnPContextFactory.EventHub GlobalOptions Options used to configure this PnPContext Declaration protected PnPGlobalSettingsOptions GlobalOptions { get; } Property Value PnPGlobalSettingsOptions Log Connected logger Declaration protected ILogger Log { get; } Property Value ILogger MicrosoftGraphClient Connected Microsoft Graph http client Declaration protected MicrosoftGraphClient MicrosoftGraphClient { get; } Property Value MicrosoftGraphClient SharePointRestClient Connected SharePoint REST http client Declaration protected SharePointRestClient SharePointRestClient { get; } Property Value SharePointRestClient Methods Create(Guid, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided group and using the default Authentication Provider Declaration public virtual PnPContext Create(Guid groupId, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters Guid groupId The id of an Microsoft 365 group CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(Guid, CancellationToken, PnPContextOptions) Create(Guid, IAuthenticationProvider, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided group and Authentication Provider instance Declaration public virtual PnPContext Create(Guid groupId, IAuthenticationProvider authenticationProvider, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters Guid groupId The id of an Microsoft 365 group IAuthenticationProvider authenticationProvider The Authentication Provider to use to authenticate within the PnPContext CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(Guid, IAuthenticationProvider, CancellationToken, PnPContextOptions) Create(Guid, IAuthenticationProvider, PnPContextOptions) Creates a new instance of PnPContext based on a provided group and Authentication Provider instance Declaration public virtual PnPContext Create(Guid groupId, IAuthenticationProvider authenticationProvider, PnPContextOptions options = null) Parameters Guid groupId The id of an Microsoft 365 group IAuthenticationProvider authenticationProvider The Authentication Provider to use to authenticate within the PnPContext PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(Guid, IAuthenticationProvider, PnPContextOptions) Create(Guid, PnPContextOptions) Creates a new instance of PnPContext based on a provided group and using the default Authentication Provider Declaration public virtual PnPContext Create(Guid groupId, PnPContextOptions options = null) Parameters Guid groupId The id of an Microsoft 365 group PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(Guid, PnPContextOptions) Create(String, Action, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual PnPContext Create(string name, Action initializeAuthenticationProvider, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters String name The name of the PnPContext configuration to use Action < IAuthenticationProvider > initializeAuthenticationProvider The function to initialize the authentication provider CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(String, Action, CancellationToken, PnPContextOptions) Create(String, Action, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual PnPContext Create(string name, Action initializeAuthenticationProvider, PnPContextOptions options = null) Parameters String name The name of the PnPContext configuration to use Action < IAuthenticationProvider > initializeAuthenticationProvider The function to initialize the authentication provider PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(String, Action, PnPContextOptions) Create(String, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual PnPContext Create(string name, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters String name The name of the PnPContext configuration to use CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(String, CancellationToken, PnPContextOptions) Create(String, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual PnPContext Create(string name, PnPContextOptions options = null) Parameters String name The name of the PnPContext configuration to use PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(String, PnPContextOptions) Create(Uri, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual PnPContext Create(Uri url, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters Uri url The URL of the PnPContext as a URI CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(Uri, CancellationToken, PnPContextOptions) Create(Uri, IAuthenticationProvider, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual PnPContext Create(Uri url, IAuthenticationProvider authenticationProvider, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters Uri url The URL of the PnPContext as a URI IAuthenticationProvider authenticationProvider The Authentication Provider to use to authenticate within the PnPContext CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(Uri, IAuthenticationProvider, CancellationToken, PnPContextOptions) Create(Uri, IAuthenticationProvider, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual PnPContext Create(Uri url, IAuthenticationProvider authenticationProvider, PnPContextOptions options = null) Parameters Uri url The URL of the PnPContext as a URI IAuthenticationProvider authenticationProvider The Authentication Provider to use to authenticate within the PnPContext PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(Uri, IAuthenticationProvider, PnPContextOptions) Create(Uri, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual PnPContext Create(Uri url, PnPContextOptions options = null) Parameters Uri url The URL of the PnPContext as a URI PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(Uri, PnPContextOptions) CreateAsync(Guid, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided group and using the default Authentication Provider Declaration public virtual async Task CreateAsync(Guid groupId, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters Guid groupId The id of an Microsoft 365 group CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(Guid, CancellationToken, PnPContextOptions) CreateAsync(Guid, IAuthenticationProvider, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided group and Authentication Provider instance Declaration public virtual async Task CreateAsync(Guid groupId, IAuthenticationProvider authenticationProvider, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters Guid groupId The id of an Microsoft 365 group IAuthenticationProvider authenticationProvider The Authentication Provider to use to authenticate within the PnPContext CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(Guid, IAuthenticationProvider, CancellationToken, PnPContextOptions) CreateAsync(Guid, IAuthenticationProvider, PnPContextOptions) Creates a new instance of PnPContext based on a provided group and Authentication Provider instance Declaration public virtual async Task CreateAsync(Guid groupId, IAuthenticationProvider authenticationProvider, PnPContextOptions options = null) Parameters Guid groupId The id of an Microsoft 365 group IAuthenticationProvider authenticationProvider The Authentication Provider to use to authenticate within the PnPContext PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(Guid, IAuthenticationProvider, PnPContextOptions) CreateAsync(Guid, PnPContextOptions) Creates a new instance of PnPContext based on a provided group and using the default Authentication Provider Declaration public virtual async Task CreateAsync(Guid groupId, PnPContextOptions options = null) Parameters Guid groupId The id of an Microsoft 365 group PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(Guid, PnPContextOptions) CreateAsync(String, Action, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual async Task CreateAsync(string name, Action initializeAuthenticationProvider, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters String name The name of the PnPContext configuration to use Action < IAuthenticationProvider > initializeAuthenticationProvider The function to initialize the authentication provider CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(String, Action, CancellationToken, PnPContextOptions) CreateAsync(String, Action, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual async Task CreateAsync(string name, Action initializeAuthenticationProvider, PnPContextOptions options = null) Parameters String name The name of the PnPContext configuration to use Action < IAuthenticationProvider > initializeAuthenticationProvider The function to initialize the authentication provider PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(String, Action, PnPContextOptions) CreateAsync(String, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual async Task CreateAsync(string name, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters String name The name of the PnPContext configuration to use CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(String, CancellationToken, PnPContextOptions) CreateAsync(String, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual async Task CreateAsync(string name, PnPContextOptions options = null) Parameters String name The name of the PnPContext configuration to use PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(String, PnPContextOptions) CreateAsync(Uri, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual async Task CreateAsync(Uri url, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters Uri url The URL of the PnPContext as a URI CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(Uri, CancellationToken, PnPContextOptions) CreateAsync(Uri, IAuthenticationProvider, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual async Task CreateAsync(Uri url, IAuthenticationProvider authenticationProvider, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters Uri url The URL of the PnPContext as a URI IAuthenticationProvider authenticationProvider The Authentication Provider to use to authenticate within the PnPContext CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(Uri, IAuthenticationProvider, CancellationToken, PnPContextOptions) CreateAsync(Uri, IAuthenticationProvider, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual async Task CreateAsync(Uri url, IAuthenticationProvider authenticationProvider, PnPContextOptions options = null) Parameters Uri url The URL of the PnPContext as a URI IAuthenticationProvider authenticationProvider The Authentication Provider to use to authenticate within the PnPContext PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(Uri, IAuthenticationProvider, PnPContextOptions) CreateAsync(Uri, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual async Task CreateAsync(Uri url, PnPContextOptions options = null) Parameters Uri url The URL of the PnPContext as a URI PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(Uri, PnPContextOptions)" + "keywords": "Class PnPContextFactory Public factory service to create PnPContext object instances Inheritance System.Object PnPContextFactory Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class PnPContextFactory : object, IPnPContextFactory Constructors PnPContextFactory(ILogger, SharePointRestClient, MicrosoftGraphClient, IOptions, IOptions, EventHub) Default constructor for PnPContextFactory Declaration public PnPContextFactory(ILogger logger, SharePointRestClient sharePointRestClient, MicrosoftGraphClient microsoftGraphClient, IOptions contextOptions, IOptions globalOptions, EventHub eventHub) Parameters ILogger < PnPContext > logger Connected logger SharePointRestClient sharePointRestClient SharePoint REST http client to use MicrosoftGraphClient microsoftGraphClient Microsoft Graph http client to use IOptions < PnPContextFactoryOptions > contextOptions PnPContextFactory options IOptions < PnPGlobalSettingsOptions > globalOptions Global options to use EventHub eventHub EventHub instance Properties ContextOptions Options used to configure this PnPContext Declaration protected PnPContextFactoryOptions ContextOptions { get; } Property Value PnPContextFactoryOptions EventHub Gets the EventHub instance, can be used to tap into events like request retry (due to throttling) Declaration public EventHub EventHub { get; } Property Value EventHub Implements IPnPContextFactory.EventHub GlobalOptions Options used to configure this PnPContext Declaration protected PnPGlobalSettingsOptions GlobalOptions { get; } Property Value PnPGlobalSettingsOptions Log Connected logger Declaration protected ILogger Log { get; } Property Value ILogger MicrosoftGraphClient Connected Microsoft Graph http client Declaration protected MicrosoftGraphClient MicrosoftGraphClient { get; } Property Value MicrosoftGraphClient SharePointRestClient Connected SharePoint REST http client Declaration protected SharePointRestClient SharePointRestClient { get; } Property Value SharePointRestClient Methods Create(Guid, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided group and using the default Authentication Provider Declaration public virtual PnPContext Create(Guid groupId, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters Guid groupId The id of an Microsoft 365 group CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(Guid, CancellationToken, PnPContextOptions) Create(Guid, IAuthenticationProvider, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided group and Authentication Provider instance Declaration public virtual PnPContext Create(Guid groupId, IAuthenticationProvider authenticationProvider, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters Guid groupId The id of an Microsoft 365 group IAuthenticationProvider authenticationProvider The Authentication Provider to use to authenticate within the PnPContext CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(Guid, IAuthenticationProvider, CancellationToken, PnPContextOptions) Create(Guid, IAuthenticationProvider, PnPContextOptions) Creates a new instance of PnPContext based on a provided group and Authentication Provider instance Declaration public virtual PnPContext Create(Guid groupId, IAuthenticationProvider authenticationProvider, PnPContextOptions options = null) Parameters Guid groupId The id of an Microsoft 365 group IAuthenticationProvider authenticationProvider The Authentication Provider to use to authenticate within the PnPContext PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(Guid, IAuthenticationProvider, PnPContextOptions) Create(Guid, PnPContextOptions) Creates a new instance of PnPContext based on a provided group and using the default Authentication Provider Declaration public virtual PnPContext Create(Guid groupId, PnPContextOptions options = null) Parameters Guid groupId The id of an Microsoft 365 group PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(Guid, PnPContextOptions) Create(String, Action, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual PnPContext Create(string name, Action initializeAuthenticationProvider, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters String name The name of the PnPContext configuration to use Action < IAuthenticationProvider > initializeAuthenticationProvider The function to initialize the authentication provider CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(String, Action, CancellationToken, PnPContextOptions) Create(String, Action, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual PnPContext Create(string name, Action initializeAuthenticationProvider, PnPContextOptions options = null) Parameters String name The name of the PnPContext configuration to use Action < IAuthenticationProvider > initializeAuthenticationProvider The function to initialize the authentication provider PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(String, Action, PnPContextOptions) Create(String, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual PnPContext Create(string name, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters String name The name of the PnPContext configuration to use CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(String, CancellationToken, PnPContextOptions) Create(String, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual PnPContext Create(string name, PnPContextOptions options = null) Parameters String name The name of the PnPContext configuration to use PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(String, PnPContextOptions) Create(Uri, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual PnPContext Create(Uri url, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters Uri url The URL of the PnPContext as a URI CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(Uri, CancellationToken, PnPContextOptions) Create(Uri, IAuthenticationProvider, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual PnPContext Create(Uri url, IAuthenticationProvider authenticationProvider, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters Uri url The URL of the PnPContext as a URI IAuthenticationProvider authenticationProvider The Authentication Provider to use to authenticate within the PnPContext CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(Uri, IAuthenticationProvider, CancellationToken, PnPContextOptions) Create(Uri, IAuthenticationProvider, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual PnPContext Create(Uri url, IAuthenticationProvider authenticationProvider, PnPContextOptions options = null) Parameters Uri url The URL of the PnPContext as a URI IAuthenticationProvider authenticationProvider The Authentication Provider to use to authenticate within the PnPContext PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(Uri, IAuthenticationProvider, PnPContextOptions) Create(Uri, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual PnPContext Create(Uri url, PnPContextOptions options = null) Parameters Uri url The URL of the PnPContext as a URI PnPContextOptions options Options used to configure the created context Returns PnPContext A PnPContext object based on the provided configuration name Implements IPnPContextFactory.Create(Uri, PnPContextOptions) CreateAsync(Guid, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided group and using the default Authentication Provider Declaration public virtual async Task CreateAsync(Guid groupId, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters Guid groupId The id of an Microsoft 365 group CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(Guid, CancellationToken, PnPContextOptions) CreateAsync(Guid, IAuthenticationProvider, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided group and Authentication Provider instance Declaration public virtual async Task CreateAsync(Guid groupId, IAuthenticationProvider authenticationProvider, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters Guid groupId The id of an Microsoft 365 group IAuthenticationProvider authenticationProvider The Authentication Provider to use to authenticate within the PnPContext CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(Guid, IAuthenticationProvider, CancellationToken, PnPContextOptions) CreateAsync(Guid, IAuthenticationProvider, PnPContextOptions) Creates a new instance of PnPContext based on a provided group and Authentication Provider instance Declaration public virtual async Task CreateAsync(Guid groupId, IAuthenticationProvider authenticationProvider, PnPContextOptions options = null) Parameters Guid groupId The id of an Microsoft 365 group IAuthenticationProvider authenticationProvider The Authentication Provider to use to authenticate within the PnPContext PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(Guid, IAuthenticationProvider, PnPContextOptions) CreateAsync(Guid, PnPContextOptions) Creates a new instance of PnPContext based on a provided group and using the default Authentication Provider Declaration public virtual async Task CreateAsync(Guid groupId, PnPContextOptions options = null) Parameters Guid groupId The id of an Microsoft 365 group PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(Guid, PnPContextOptions) CreateAsync(String, Action, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual async Task CreateAsync(string name, Action initializeAuthenticationProvider, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters String name The name of the PnPContext configuration to use Action < IAuthenticationProvider > initializeAuthenticationProvider The function to initialize the authentication provider CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(String, Action, CancellationToken, PnPContextOptions) CreateAsync(String, Action, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual async Task CreateAsync(string name, Action initializeAuthenticationProvider, PnPContextOptions options = null) Parameters String name The name of the PnPContext configuration to use Action < IAuthenticationProvider > initializeAuthenticationProvider The function to initialize the authentication provider PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(String, Action, PnPContextOptions) CreateAsync(String, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual async Task CreateAsync(string name, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters String name The name of the PnPContext configuration to use CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(String, CancellationToken, PnPContextOptions) CreateAsync(String, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual async Task CreateAsync(string name, PnPContextOptions options = null) Parameters String name The name of the PnPContext configuration to use PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(String, PnPContextOptions) CreateAsync(Uri, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual async Task CreateAsync(Uri url, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters Uri url The URL of the PnPContext as a URI CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(Uri, CancellationToken, PnPContextOptions) CreateAsync(Uri, IAuthenticationProvider, CancellationToken, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual async Task CreateAsync(Uri url, IAuthenticationProvider authenticationProvider, CancellationToken cancellationToken, PnPContextOptions options = null) Parameters Uri url The URL of the PnPContext as a URI IAuthenticationProvider authenticationProvider The Authentication Provider to use to authenticate within the PnPContext CancellationToken cancellationToken The cancellation token to cancel operation PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(Uri, IAuthenticationProvider, CancellationToken, PnPContextOptions) CreateAsync(Uri, IAuthenticationProvider, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual async Task CreateAsync(Uri url, IAuthenticationProvider authenticationProvider, PnPContextOptions options = null) Parameters Uri url The URL of the PnPContext as a URI IAuthenticationProvider authenticationProvider The Authentication Provider to use to authenticate within the PnPContext PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(Uri, IAuthenticationProvider, PnPContextOptions) CreateAsync(Uri, PnPContextOptions) Creates a new instance of PnPContext based on a provided configuration name Declaration public virtual async Task CreateAsync(Uri url, PnPContextOptions options = null) Parameters Uri url The URL of the PnPContext as a URI PnPContextOptions options Options used to configure the created context Returns Task < PnPContext > A PnPContext object based on the provided configuration name Implements IPnPContextFactory.CreateAsync(Uri, PnPContextOptions)" }, "api/PnP.Core.Services.PnPContextFactoryCollectionExtensions.html": { "href": "api/PnP.Core.Services.PnPContextFactoryCollectionExtensions.html", "title": "Class PnPContextFactoryCollectionExtensions | PnP Core SDK", - "keywords": "Class PnPContextFactoryCollectionExtensions Extension class for the IServiceCollection type to provide supporting methods for the PnPContextFactory service Inheritance Object PnPContextFactoryCollectionExtensions Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public static class PnPContextFactoryCollectionExtensions : object Methods AddPnPContextFactory(IServiceCollection) Adds the PnPContextFactory to the collection of services Declaration public static IServiceCollection AddPnPContextFactory(this IServiceCollection collection) Parameters IServiceCollection collection Collection of loaded services Returns IServiceCollection Collection of loaded services AddPnPContextFactory(IServiceCollection, Action) Adds the PnPContextFactory to the collection of services with options Declaration public static IServiceCollection AddPnPContextFactory(this IServiceCollection collection, Action options) Parameters IServiceCollection collection Collection of loaded services Action < PnPContextFactoryOptions > options PnPContextFactory configuration options Returns IServiceCollection Collection of loaded services" + "keywords": "Class PnPContextFactoryCollectionExtensions Extension class for the IServiceCollection type to provide supporting methods for the PnPContextFactory service Inheritance System.Object PnPContextFactoryCollectionExtensions Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public static class PnPContextFactoryCollectionExtensions : object Methods AddPnPContextFactory(IServiceCollection) Adds the PnPContextFactory to the collection of services Declaration public static IServiceCollection AddPnPContextFactory(this IServiceCollection collection) Parameters IServiceCollection collection Collection of loaded services Returns IServiceCollection Collection of loaded services AddPnPContextFactory(IServiceCollection, Action) Adds the PnPContextFactory to the collection of services with options Declaration public static IServiceCollection AddPnPContextFactory(this IServiceCollection collection, Action options) Parameters IServiceCollection collection Collection of loaded services Action < PnPContextFactoryOptions > options PnPContextFactory configuration options Returns IServiceCollection Collection of loaded services" }, "api/PnP.Core.Services.PnPContextFactoryOptions.html": { "href": "api/PnP.Core.Services.PnPContextFactoryOptions.html", "title": "Class PnPContextFactoryOptions | PnP Core SDK", - "keywords": "Class PnPContextFactoryOptions Defines the options to configure the PnPContextFactory object Inheritance Object PnPContextFactoryOptions Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class PnPContextFactoryOptions : object Properties Configurations Collection of configurations for PnPContextFactory Declaration public List Configurations { get; } Property Value List < PnPContextFactoryOptionsConfiguration > DefaultAuthenticationProvider The Default Authentication Provider configuration Declaration public IAuthenticationProvider DefaultAuthenticationProvider { get; set; } Property Value IAuthenticationProvider GraphAlwaysUseBeta If true than all requests to Microsoft Graph use the beta endpoint Declaration public bool GraphAlwaysUseBeta { get; set; } Property Value Boolean GraphCanUseBeta If true than the Graph beta endpoint is used when there's no other option, default approach stays using the v1 endpoint Declaration public bool GraphCanUseBeta { get; set; } Property Value Boolean GraphFirst Controls whether the library will try to use Microsoft Graph over REST whenever that's defined in the model Declaration public bool GraphFirst { get; set; } Property Value Boolean" + "keywords": "Class PnPContextFactoryOptions Defines the options to configure the PnPContextFactory object Inheritance System.Object PnPContextFactoryOptions Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class PnPContextFactoryOptions : object Properties Configurations Collection of configurations for PnPContextFactory Declaration public List Configurations { get; } Property Value List < PnPContextFactoryOptionsConfiguration > DefaultAuthenticationProvider The Default Authentication Provider configuration Declaration public IAuthenticationProvider DefaultAuthenticationProvider { get; set; } Property Value IAuthenticationProvider GraphAlwaysUseBeta If true than all requests to Microsoft Graph use the beta endpoint Declaration public bool GraphAlwaysUseBeta { get; set; } Property Value Boolean GraphCanUseBeta If true than the Graph beta endpoint is used when there's no other option, default approach stays using the v1 endpoint Declaration public bool GraphCanUseBeta { get; set; } Property Value Boolean GraphFirst Controls whether the library will try to use Microsoft Graph over REST whenever that's defined in the model Declaration public bool GraphFirst { get; set; } Property Value Boolean" }, "api/PnP.Core.Services.PnPContextFactoryOptionsConfiguration.html": { "href": "api/PnP.Core.Services.PnPContextFactoryOptionsConfiguration.html", "title": "Class PnPContextFactoryOptionsConfiguration | PnP Core SDK", - "keywords": "Class PnPContextFactoryOptionsConfiguration PnPContext configuration options Inheritance Object PnPContextFactoryOptionsConfiguration Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class PnPContextFactoryOptionsConfiguration : object Properties AuthenticationProvider The Authentication Provider configuration Declaration public IAuthenticationProvider AuthenticationProvider { get; set; } Property Value IAuthenticationProvider Name The Name of the configuration Declaration public string Name { get; set; } Property Value String SiteUrl The URL of the target SPO Site Declaration public Uri SiteUrl { get; set; } Property Value Uri" + "keywords": "Class PnPContextFactoryOptionsConfiguration PnPContext configuration options Inheritance System.Object PnPContextFactoryOptionsConfiguration Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class PnPContextFactoryOptionsConfiguration : object Properties AuthenticationProvider The Authentication Provider configuration Declaration public IAuthenticationProvider AuthenticationProvider { get; set; } Property Value IAuthenticationProvider Name The Name of the configuration Declaration public string Name { get; set; } Property Value String SiteUrl The URL of the target SPO Site Declaration public Uri SiteUrl { get; set; } Property Value Uri" }, "api/PnP.Core.Services.PnPContextOptions.html": { "href": "api/PnP.Core.Services.PnPContextOptions.html", "title": "Class PnPContextOptions | PnP Core SDK", - "keywords": "Class PnPContextOptions Options used when a PnPContext is created Inheritance Object PnPContextOptions Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class PnPContextOptions : object Properties AdditionalSitePropertiesOnCreate Additional ISite properties to load when creating a new PnPContext . Declaration public IEnumerable>> AdditionalSitePropertiesOnCreate { get; set; } Property Value IEnumerable < Expression < Func < ISite , Object >>> AdditionalWebPropertiesOnCreate Additional IWeb properties to load when creating a new PnPContext . Declaration public IEnumerable>> AdditionalWebPropertiesOnCreate { get; set; } Property Value IEnumerable < Expression < Func < IWeb , Object >>> Properties Properties to set on the context during creation Declaration public IDictionary Properties { get; set; } Property Value IDictionary < String , Object >" + "keywords": "Class PnPContextOptions Options used when a PnPContext is created Inheritance System.Object PnPContextOptions Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class PnPContextOptions : object Properties AdditionalSitePropertiesOnCreate Additional ISite properties to load when creating a new PnPContext . Declaration public IEnumerable>> AdditionalSitePropertiesOnCreate { get; set; } Property Value IEnumerable < Expression < Func < ISite , System.Object >>> AdditionalWebPropertiesOnCreate Additional IWeb properties to load when creating a new PnPContext . Declaration public IEnumerable>> AdditionalWebPropertiesOnCreate { get; set; } Property Value IEnumerable < Expression < Func < IWeb , System.Object >>> Properties Properties to set on the context during creation Declaration public IDictionary Properties { get; set; } Property Value IDictionary < String , System.Object >" }, "api/PnP.Core.Services.PnPGlobalSettingsOptions.html": { "href": "api/PnP.Core.Services.PnPGlobalSettingsOptions.html", "title": "Class PnPGlobalSettingsOptions | PnP Core SDK", - "keywords": "Class PnPGlobalSettingsOptions PnP Core SDK settings class Inheritance Object PnPGlobalSettingsOptions Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class PnPGlobalSettingsOptions : object Constructors PnPGlobalSettingsOptions() Default constructor Declaration public PnPGlobalSettingsOptions() Properties AADTenantId AAD tenant id, used for telemetry purposes. Can be customized via configuration Declaration public Guid AADTenantId { get; set; } Property Value Guid AzureADLoginAuthority Returns the Azure AD Login authority (e.g. login.microsoftonline.com) to use when Environment is set to Custom Declaration public string AzureADLoginAuthority { get; set; } Property Value String DisableTelemetry Turns on/off telemetry, can be customized via configuration. Defaults to false. Declaration public bool DisableTelemetry { get; set; } Property Value Boolean Environment The Microsoft 365 cloud environment that's used Declaration public Microsoft365Environment? Environment { get; set; } Property Value Nullable < Microsoft365Environment > HttpAzureActiveDirectoryDelayInSeconds How many seconds to wait for the next retry attempt. Defaults to 3 Declaration public int HttpAzureActiveDirectoryDelayInSeconds { get; set; } Property Value Int32 HttpAzureActiveDirectoryMaxRetries When not using retry-after, how many times can a retry be made. Defaults to 10 Declaration public int HttpAzureActiveDirectoryMaxRetries { get; set; } Property Value Int32 HttpAzureActiveDirectoryUseIncrementalDelay Use an incremental strategy for the delay: each retry doubles the previous delay time. Defaults to true Declaration public bool HttpAzureActiveDirectoryUseIncrementalDelay { get; set; } Property Value Boolean HttpAzureActiveDirectoryUseRetryAfterHeader Use the Retry-After header for calculating the delay in case of a retry. Defaults to true Declaration public bool HttpAzureActiveDirectoryUseRetryAfterHeader { get; set; } Property Value Boolean HttpMicrosoftGraphDelayInSeconds How many seconds to wait for the next retry attempt. Defaults to 3 Declaration public int HttpMicrosoftGraphDelayInSeconds { get; set; } Property Value Int32 HttpMicrosoftGraphMaxRetries When not using retry-after, how many times can a retry be made. Defaults to 10 Declaration public int HttpMicrosoftGraphMaxRetries { get; set; } Property Value Int32 HttpMicrosoftGraphUseIncrementalDelay Use an incremental strategy for the delay: each retry doubles the previous delay time. Defaults to true Declaration public bool HttpMicrosoftGraphUseIncrementalDelay { get; set; } Property Value Boolean HttpMicrosoftGraphUseRetryAfterHeader Use the Retry-After header for calculating the delay in case of a retry. Defaults to true Declaration public bool HttpMicrosoftGraphUseRetryAfterHeader { get; set; } Property Value Boolean HttpRateLimiterMinimumCapacityLeft When set (e.g. to 10%) then RateLimit response headers coming from SharePoint and Graph are used: if there's less then the set value (e.g. 10%) capacity left before getting throttled the pending request will be delayed until the 1 minute window is reset. Defaults to 0 (disabled). Declaration public int HttpRateLimiterMinimumCapacityLeft { get; set; } Property Value Int32 HttpSharePointRestDefaultPageSize Defines the default page size for querying items in SharePoint REST Declaration public int HttpSharePointRestDefaultPageSize { get; set; } Property Value Int32 HttpSharePointRestDelayInSeconds How many seconds to wait for the next retry attempt. Defaults to 3 Declaration public int HttpSharePointRestDelayInSeconds { get; set; } Property Value Int32 HttpSharePointRestMaxRetries When not using retry-after, how many times can a retry be made. Defaults to 10 Declaration public int HttpSharePointRestMaxRetries { get; set; } Property Value Int32 HttpSharePointRestUseIncrementalDelay Use an incremental strategy for the delay: each retry doubles the previous delay time. Defaults to true Declaration public bool HttpSharePointRestUseIncrementalDelay { get; set; } Property Value Boolean HttpSharePointRestUseRetryAfterHeader Use the Retry-After header for calculating the delay in case of a retry. Defaults to false Declaration public bool HttpSharePointRestUseRetryAfterHeader { get; set; } Property Value Boolean HttpTimeout Max duration of a http request in seconds. Defaults to 100 seconds, set to value -1 for an infinite timeout Declaration public int HttpTimeout { get; set; } Property Value Int32 HttpUserAgent User agent value, can be customized via configuration Declaration public string HttpUserAgent { get; } Property Value String MicrosoftGraphAuthority Returns the Microsoft Graph authority (e.g. graph.microsoft.com) to use when Environment is set to Custom Declaration public string MicrosoftGraphAuthority { get; set; } Property Value String VersionTag Version tag used in telemetry Declaration public string VersionTag { get; } Property Value String" + "keywords": "Class PnPGlobalSettingsOptions PnP Core SDK settings class Inheritance System.Object PnPGlobalSettingsOptions Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class PnPGlobalSettingsOptions : object Constructors PnPGlobalSettingsOptions() Default constructor Declaration public PnPGlobalSettingsOptions() Properties AADTenantId AAD tenant id, used for telemetry purposes. Can be customized via configuration Declaration public Guid AADTenantId { get; set; } Property Value Guid AzureADLoginAuthority Returns the Azure AD Login authority (e.g. login.microsoftonline.com) to use when Environment is set to Custom Declaration public string AzureADLoginAuthority { get; set; } Property Value String DisableTelemetry Turns on/off telemetry, can be customized via configuration. Defaults to false. Declaration public bool DisableTelemetry { get; set; } Property Value Boolean Environment The Microsoft 365 cloud environment that's used Declaration public Microsoft365Environment? Environment { get; set; } Property Value Nullable < Microsoft365Environment > HttpAzureActiveDirectoryDelayInSeconds How many seconds to wait for the next retry attempt. Defaults to 3 Declaration public int HttpAzureActiveDirectoryDelayInSeconds { get; set; } Property Value Int32 HttpAzureActiveDirectoryMaxRetries When not using retry-after, how many times can a retry be made. Defaults to 10 Declaration public int HttpAzureActiveDirectoryMaxRetries { get; set; } Property Value Int32 HttpAzureActiveDirectoryUseIncrementalDelay Use an incremental strategy for the delay: each retry doubles the previous delay time. Defaults to true Declaration public bool HttpAzureActiveDirectoryUseIncrementalDelay { get; set; } Property Value Boolean HttpAzureActiveDirectoryUseRetryAfterHeader Use the Retry-After header for calculating the delay in case of a retry. Defaults to true Declaration public bool HttpAzureActiveDirectoryUseRetryAfterHeader { get; set; } Property Value Boolean HttpMicrosoftGraphDelayInSeconds How many seconds to wait for the next retry attempt. Defaults to 3 Declaration public int HttpMicrosoftGraphDelayInSeconds { get; set; } Property Value Int32 HttpMicrosoftGraphMaxRetries When not using retry-after, how many times can a retry be made. Defaults to 10 Declaration public int HttpMicrosoftGraphMaxRetries { get; set; } Property Value Int32 HttpMicrosoftGraphUseIncrementalDelay Use an incremental strategy for the delay: each retry doubles the previous delay time. Defaults to true Declaration public bool HttpMicrosoftGraphUseIncrementalDelay { get; set; } Property Value Boolean HttpMicrosoftGraphUseRetryAfterHeader Use the Retry-After header for calculating the delay in case of a retry. Defaults to true Declaration public bool HttpMicrosoftGraphUseRetryAfterHeader { get; set; } Property Value Boolean HttpRateLimiterMinimumCapacityLeft When set (e.g. to 10%) then RateLimit response headers coming from SharePoint and Graph are used: if there's less then the set value (e.g. 10%) capacity left before getting throttled the pending request will be delayed until the 1 minute window is reset. Defaults to 0 (disabled). Declaration public int HttpRateLimiterMinimumCapacityLeft { get; set; } Property Value Int32 HttpSharePointRestDefaultPageSize Defines the default page size for querying items in SharePoint REST Declaration public int HttpSharePointRestDefaultPageSize { get; set; } Property Value Int32 HttpSharePointRestDelayInSeconds How many seconds to wait for the next retry attempt. Defaults to 3 Declaration public int HttpSharePointRestDelayInSeconds { get; set; } Property Value Int32 HttpSharePointRestMaxRetries When not using retry-after, how many times can a retry be made. Defaults to 10 Declaration public int HttpSharePointRestMaxRetries { get; set; } Property Value Int32 HttpSharePointRestUseIncrementalDelay Use an incremental strategy for the delay: each retry doubles the previous delay time. Defaults to true Declaration public bool HttpSharePointRestUseIncrementalDelay { get; set; } Property Value Boolean HttpSharePointRestUseRetryAfterHeader Use the Retry-After header for calculating the delay in case of a retry. Defaults to false Declaration public bool HttpSharePointRestUseRetryAfterHeader { get; set; } Property Value Boolean HttpTimeout Max duration of a http request in seconds. Defaults to 100 seconds, set to value -1 for an infinite timeout Declaration public int HttpTimeout { get; set; } Property Value Int32 HttpUserAgent User agent value, can be customized via configuration Declaration public string HttpUserAgent { get; } Property Value String MicrosoftGraphAuthority Returns the Microsoft Graph authority (e.g. graph.microsoft.com) to use when Environment is set to Custom Declaration public string MicrosoftGraphAuthority { get; set; } Property Value String VersionTag Version tag used in telemetry Declaration public string VersionTag { get; } Property Value String" }, "api/PnP.Core.Services.RateLimitEvent.html": { "href": "api/PnP.Core.Services.RateLimitEvent.html", "title": "Class RateLimitEvent | PnP Core SDK", - "keywords": "Class RateLimitEvent Event containing information about the happened rate limit event Inheritance Object RateLimitEvent Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public sealed class RateLimitEvent : object, IRateLimitEvent Constructors RateLimitEvent(HttpRequestMessage, HttpResponseMessage) Rate limit event constructor Declaration public RateLimitEvent(HttpRequestMessage requestMessage, HttpResponseMessage responseMessage) Parameters HttpRequestMessage requestMessage Response for the retried request HttpResponseMessage responseMessage Request that's retried Properties Limit Maximum number of requests per window Declaration public int Limit { get; } Property Value Int32 Implements IRateLimitEvent.Limit Properties Event property bag Declaration public IDictionary Properties { get; } Property Value IDictionary < String , Object > Implements IRateLimitEvent.Properties Remaining The remaining requests in the current window. Declaration public int Remaining { get; } Property Value Int32 Implements IRateLimitEvent.Remaining Request Request that was retried Declaration public Uri Request { get; } Property Value Uri Implements IRateLimitEvent.Request Reset The time, in , when the current window gets reset Declaration public int Reset { get; } Property Value Int32 Implements IRateLimitEvent.Reset" + "keywords": "Class RateLimitEvent Event containing information about the happened rate limit event Inheritance System.Object RateLimitEvent Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public sealed class RateLimitEvent : object, IRateLimitEvent Constructors RateLimitEvent(HttpRequestMessage, HttpResponseMessage) Rate limit event constructor Declaration public RateLimitEvent(HttpRequestMessage requestMessage, HttpResponseMessage responseMessage) Parameters HttpRequestMessage requestMessage Response for the retried request HttpResponseMessage responseMessage Request that's retried Properties Limit Maximum number of requests per window Declaration public int Limit { get; } Property Value Int32 Implements IRateLimitEvent.Limit Properties Event property bag Declaration public IDictionary Properties { get; } Property Value IDictionary < String , System.Object > Implements IRateLimitEvent.Properties Remaining The remaining requests in the current window. Declaration public int Remaining { get; } Property Value Int32 Implements IRateLimitEvent.Remaining Request Request that was retried Declaration public Uri Request { get; } Property Value Uri Implements IRateLimitEvent.Request Reset The time, in , when the current window gets reset Declaration public int Reset { get; } Property Value Int32 Implements IRateLimitEvent.Reset" }, "api/PnP.Core.Services.RetryEvent.html": { "href": "api/PnP.Core.Services.RetryEvent.html", "title": "Class RetryEvent | PnP Core SDK", - "keywords": "Class RetryEvent Event containing information about the happened retry Inheritance Object RetryEvent Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public sealed class RetryEvent : object, IRetryEvent Constructors RetryEvent(HttpRequestMessage, Int32, Int32, Exception) Retry event constructor Declaration public RetryEvent(HttpRequestMessage requestMessage, int httpStatusCode, int waitTime, Exception exception) Parameters HttpRequestMessage requestMessage Request that's retried Int32 httpStatusCode Http status code Int32 waitTime Wait before the next try in seconds Exception exception Socket exception that triggered the retry Properties Exception SocketException that triggered the retry Declaration public Exception Exception { get; } Property Value Exception Implements IRetryEvent.Exception HttpStatusCode Http status code for the retried request Declaration public int HttpStatusCode { get; } Property Value Int32 Implements IRetryEvent.HttpStatusCode Properties Event property bag Declaration public IDictionary Properties { get; } Property Value IDictionary < String , Object > Implements IRetryEvent.Properties Request Request that was retried Declaration public Uri Request { get; } Property Value Uri Implements IRetryEvent.Request WaitTime Wait before the next try in seconds Declaration public int WaitTime { get; } Property Value Int32 Implements IRetryEvent.WaitTime" + "keywords": "Class RetryEvent Event containing information about the happened retry Inheritance System.Object RetryEvent Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public sealed class RetryEvent : object, IRetryEvent Constructors RetryEvent(HttpRequestMessage, Int32, Int32, Exception) Retry event constructor Declaration public RetryEvent(HttpRequestMessage requestMessage, int httpStatusCode, int waitTime, Exception exception) Parameters HttpRequestMessage requestMessage Request that's retried Int32 httpStatusCode Http status code Int32 waitTime Wait before the next try in seconds Exception exception Socket exception that triggered the retry Properties Exception SocketException that triggered the retry Declaration public Exception Exception { get; } Property Value Exception Implements IRetryEvent.Exception HttpStatusCode Http status code for the retried request Declaration public int HttpStatusCode { get; } Property Value Int32 Implements IRetryEvent.HttpStatusCode Properties Event property bag Declaration public IDictionary Properties { get; } Property Value IDictionary < String , System.Object > Implements IRetryEvent.Properties Request Request that was retried Declaration public Uri Request { get; } Property Value Uri Implements IRetryEvent.Request WaitTime Wait before the next try in seconds Declaration public int WaitTime { get; } Property Value Int32 Implements IRetryEvent.WaitTime" }, "api/PnP.Core.Services.SharePointRestClient.html": { "href": "api/PnP.Core.Services.SharePointRestClient.html", "title": "Class SharePointRestClient | PnP Core SDK", - "keywords": "Class SharePointRestClient Client that handles all SharePoint REST requests Inheritance Object SharePointRestClient Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class SharePointRestClient : object Constructors SharePointRestClient(HttpClient, ILogger, IOptions) Default Constructor Declaration public SharePointRestClient(HttpClient client, ILogger log, IOptions options) Parameters HttpClient client Http Client coming from the .Net http client factory ILogger < SharePointRestClient > log Logger service IOptions < PnPGlobalSettingsOptions > options Options service Properties Client Http client which needs to be used for making a SharePoint REST call Declaration public HttpClient Client { get; } Property Value HttpClient" + "keywords": "Class SharePointRestClient Client that handles all SharePoint REST requests Inheritance System.Object SharePointRestClient Namespace : PnP.Core.Services Assembly : PnP.Core.dll Syntax public class SharePointRestClient : object Constructors SharePointRestClient(HttpClient, ILogger, IOptions) Default Constructor Declaration public SharePointRestClient(HttpClient client, ILogger log, IOptions options) Parameters HttpClient client Http Client coming from the .Net http client factory ILogger < SharePointRestClient > log Logger service IOptions < PnPGlobalSettingsOptions > options Options service Properties Client Http client which needs to be used for making a SharePoint REST call Declaration public HttpClient Client { get; } Property Value HttpClient" }, "api/PnP.Core.SharePointRestError.html": { "href": "api/PnP.Core.SharePointRestError.html", "title": "Class SharePointRestError | PnP Core SDK", - "keywords": "Class SharePointRestError SharePoint Rest service error Inheritance Object BaseError ServiceError SharePointRestError Inherited Members ServiceError.HttpResponseCode ServiceError.Message ServiceError.ClientRequestId ServiceError.Code BaseError.Type BaseError.PnPCorrelationId BaseError.AdditionalData BaseError.AddAdditionalData(String, Object) Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class SharePointRestError : ServiceError Constructors SharePointRestError(ErrorType, Int32, String, Dictionary) Default constructor for the SharePointRestError error Declaration public SharePointRestError(ErrorType type, int httpResponseCode, string response, Dictionary responseHeaders = null) Parameters ErrorType type ErrorType type of the error Int32 httpResponseCode Http response code of the service request that failed String response Service request response content Dictionary < String , String > responseHeaders Optional collection of request response headers Properties ServerErrorCode SharePoint server error code Declaration public long ServerErrorCode { get; } Property Value Int64 Methods ToString() Outputs a SharePointRestError to a string representation Declaration public override string ToString() Returns String String representation" + "keywords": "Class SharePointRestError SharePoint Rest service error Inheritance System.Object BaseError ServiceError SharePointRestError Inherited Members ServiceError.HttpResponseCode ServiceError.Message ServiceError.ClientRequestId ServiceError.Code BaseError.Type BaseError.PnPCorrelationId BaseError.AdditionalData BaseError.AddAdditionalData(String, Object) Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class SharePointRestError : ServiceError Constructors SharePointRestError(ErrorType, Int32, String, Dictionary) Default constructor for the SharePointRestError error Declaration public SharePointRestError(ErrorType type, int httpResponseCode, string response, Dictionary responseHeaders = null) Parameters ErrorType type ErrorType type of the error Int32 httpResponseCode Http response code of the service request that failed String response Service request response content Dictionary < String , String > responseHeaders Optional collection of request response headers Properties ServerErrorCode SharePoint server error code Declaration public long ServerErrorCode { get; } Property Value Int64 Methods ToString() Outputs a SharePointRestError to a string representation Declaration public override string ToString() Returns String String representation" }, "api/PnP.Core.SharePointRestServiceException.html": { "href": "api/PnP.Core.SharePointRestServiceException.html", "title": "Class SharePointRestServiceException | PnP Core SDK", - "keywords": "Class SharePointRestServiceException Microsoft SharePoint REST Service exception Inheritance Object PnPException ServiceException SharePointRestServiceException Inherited Members PnPException.Error Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class SharePointRestServiceException : ServiceException Constructors SharePointRestServiceException(ErrorType, Int32, String, Dictionary) Creates a SharePointRestServiceException using the provided error type, http response code and request response Declaration public SharePointRestServiceException(ErrorType type, int httpResponseCode, string response, Dictionary responseHeaders = null) Parameters ErrorType type Type of the error Int32 httpResponseCode Http response code of the service request String response Response of the service request that errored out Dictionary < String , String > responseHeaders Optional collection of request response headers Methods ToString() Outputs a SharePointRestServiceException to a string representation Declaration public override string ToString() Returns String String representation" + "keywords": "Class SharePointRestServiceException Microsoft SharePoint REST Service exception Inheritance System.Object PnPException ServiceException SharePointRestServiceException Inherited Members PnPException.Error Namespace : PnP.Core Assembly : PnP.Core.dll Syntax public class SharePointRestServiceException : ServiceException Constructors SharePointRestServiceException(ErrorType, Int32, String, Dictionary) Creates a SharePointRestServiceException using the provided error type, http response code and request response Declaration public SharePointRestServiceException(ErrorType type, int httpResponseCode, string response, Dictionary responseHeaders = null) Parameters ErrorType type Type of the error Int32 httpResponseCode Http response code of the service request String response Response of the service request that errored out Dictionary < String , String > responseHeaders Optional collection of request response headers Methods ToString() Outputs a SharePointRestServiceException to a string representation Declaration public override string ToString() Returns String String representation" }, "contributing/configuring-for-auth-tests.html": { "href": "contributing/configuring-for-auth-tests.html", diff --git a/manifest.json b/manifest.json index bb9b055e8b..6cb3792301 100644 --- a/manifest.json +++ b/manifest.json @@ -18,7 +18,7 @@ "output": { ".html": { "relative_path": "api/Microsoft.Extensions.DependencyInjection.AuthenticationCollectionExtensions.html", - "hash": "lzH4lpa3NocvTflc4uGW6D0W2aBWqS/ppaPZGIs53aA=" + "hash": "aZfJXyZtUXZJX45ovOrJi1WOtEZ8E74lI1+YEjj6GNU=" } }, "is_incremental": false, @@ -30,7 +30,7 @@ "output": { ".html": { "relative_path": "api/Microsoft.Extensions.DependencyInjection.PnPCoreServiceCollectionExtensions.html", - "hash": "nUOzRKQaaP3kwPEZB6akPkVAN3IhNwvtceBeZO3C+W0=" + "hash": "V3UIknFOWnhKp4GcICcJsyJx1kOZA7lEBqBmOQXdRnk=" } }, "is_incremental": false, @@ -54,7 +54,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Admin.Model.Microsoft365.CreationOptions.html", - "hash": "+tWBfjHw3In78Lp+hoJglJPdOIL818Y+3HOJ5vajmBQ=" + "hash": "u5DCgUNDOf1fClRgDeuM4v/WEpVEFVubsHT+cN24zoY=" } }, "is_incremental": false, @@ -78,7 +78,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Admin.Model.Microsoft365.GraphGroupOptions.html", - "hash": "9kTxfkV0jZnnpsmEX308zcQ8/k0jJ3mUOj30EBV5/es=" + "hash": "mvskpW1Wwuq6Uviq4omvFwZl2P+cbWZvRkQcD0ly8r0=" } }, "is_incremental": false, @@ -174,7 +174,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Admin.Model.SharePoint.ClassicSiteOptions.html", - "hash": "Ni4tmKq47CUu7QMuHcMUbJNF18Ux+ztOjsXEcCSWzi8=" + "hash": "Gcz2ky49mpThClY8oFwjeRL/CKkZgfkrsFt58SwhLYc=" } }, "is_incremental": false, @@ -198,7 +198,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Admin.Model.SharePoint.CommonGroupSiteOptions.html", - "hash": "P1/Aac3J12P0LPNbaGMZY9EMYdk5zs3n0ZQH9QGzz4w=" + "hash": "VWFp8laZzg/Q/Gio6blJrAq4C+wkjdQoFtpU47YlJgM=" } }, "is_incremental": false, @@ -210,7 +210,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Admin.Model.SharePoint.CommonNoGroupSiteOptions.html", - "hash": "1uQdAf33RizFXS2mBnw1QIRw2DAKW8HGcgee/zYiUzc=" + "hash": "Hp9AKh+eaRD0hLr/0/DHddo9QA7L5goeWCcvtGfCzIE=" } }, "is_incremental": false, @@ -222,7 +222,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Admin.Model.SharePoint.CommonSiteOptions.html", - "hash": "HhafVX7BL/0XKKRhU7JDotv0jAiPDhvH7wb/3tIWmYo=" + "hash": "fpeeIvKpLcWcp60xrkSVbfBO2KKRGWanqoURnQPGFZk=" } }, "is_incremental": false, @@ -246,7 +246,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Admin.Model.SharePoint.CommunicationSiteOptions.html", - "hash": "zOTV7GEfy41vl+1PP16Bj6ujCyledQhyyU34J94bdT4=" + "hash": "7PJXQjf5NzT1GFP0VVoFtkbtftSTaOtg5rxKSJzBvJw=" } }, "is_incremental": false, @@ -270,7 +270,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Admin.Model.SharePoint.ConnectSiteToGroupOptions.html", - "hash": "AqGu4kSN4IeHvgnMWx4Dspwir3ClFox5mar9Ibyelek=" + "hash": "ftk+BxCvsYMPyuwbQ6z5AqvaGQl0Ej1hbm+dpSSVsc4=" } }, "is_incremental": false, @@ -282,7 +282,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Admin.Model.SharePoint.CreationOptions.html", - "hash": "dJaVA6ExjhxOl4zvgbsQKGuy5DlNQCy5sf0G2AKOw2A=" + "hash": "RZfXRDHGqBxpVJ/NlYv++wZOlCqdJACnytrm9Nb/LvA=" } }, "is_incremental": false, @@ -930,7 +930,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Admin.Model.SharePoint.SiteCreationOptions.html", - "hash": "ogwvZAvMJwLBuhc9JB8k2QrTjGNsySBFEH0ylrtyN8E=" + "hash": "lrdodGAW3BQzmUpkPlcEDyBBgD9movG1wlf5f+otQWQ=" } }, "is_incremental": false, @@ -966,7 +966,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Admin.Model.SharePoint.TeamSiteOptions.html", - "hash": "GFZzuKTHikj7qFzcEha1TEWpjl+P6bIwflZU300Xsi0=" + "hash": "vW1EtkXIGYkE7grhAEnn+oP/uVVVBhIEDqiFzLz/Mjw=" } }, "is_incremental": false, @@ -978,7 +978,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Admin.Model.SharePoint.TeamSiteWithoutGroupOptions.html", - "hash": "TmDF8mlIU602cZU8RLyC1pA+7oaTEacatkz/lQ4xrqg=" + "hash": "U/tc23FEwS5ScyVROsSvwdfqFttR/kf6joPE79rqea8=" } }, "is_incremental": false, @@ -1026,7 +1026,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Admin.Model.SharePoint.VanityUrlOptions.html", - "hash": "BIV0I8ktSzk4UfR7v7LvnV/GlPnDkcjiRd6DsVLdLb0=" + "hash": "kWIcVpjLKmWg11jmx6/yvio/bB7DxPMBRsNkBcLhFFw=" } }, "is_incremental": false, @@ -1074,7 +1074,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Admin.Model.Teams.TeamCreationOptions.html", - "hash": "e07xl1aqJX/Kj10PrdkivyLlaLx9bo0k6zKBkZD7wNs=" + "hash": "OAZ9pwDANz8ZJUOhq2fKSsmmj2ag6gp2EKFUYVyqw2I=" } }, "is_incremental": false, @@ -1086,7 +1086,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Admin.Model.Teams.TeamForGroupOptions.html", - "hash": "UqiFvCxN9XeGZVK8xXoXbhlif4vcFXc1BSzKvfT0Cj0=" + "hash": "wdz//83ms9iiTFlrZppw0hYUHjz/PzPlpt78s9LmYAY=" } }, "is_incremental": false, @@ -1098,7 +1098,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Admin.Model.Teams.TeamOptions.html", - "hash": "IzrnB5KOuE2eolf4aKFH+zqUSdnhdEUwvm/ECYrEonI=" + "hash": "1qePKapPtvP+O2vjvsFPrRqHwWEBnlTdOio5S/33JrM=" } }, "is_incremental": false, @@ -1122,7 +1122,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.CredentialManagerAuthenticationProvider.html", - "hash": "SGu2k/ke0PsM6d3T0vWJ8NgC4uX92/992jvzAGgWawI=" + "hash": "EzqcPMF8E+oCX1OPEw/bXmqzhPRJb63uY2/FsvSfUb4=" } }, "is_incremental": false, @@ -1134,7 +1134,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.DeviceCodeAuthenticationProvider.html", - "hash": "eJXkPzKkjasxQLZAcCNxoCbKhis4pz7Ti2434iYAcSE=" + "hash": "vBlxYMLOk1m1Y7ZUbAdVP/pvQ9YD77PDJxTBwh8Jp0w=" } }, "is_incremental": false, @@ -1146,7 +1146,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.DeviceCodeNotification.html", - "hash": "suQzpEy5DbRpkluU0flus3nQWaxCwmJ2mWo3FDqt+IU=" + "hash": "cQZ4ZK3RIveVEJobovqkuUJv/Xw+uSsqkcJCEIBeoXA=" } }, "is_incremental": false, @@ -1158,7 +1158,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.ExternalAuthenticationProvider.html", - "hash": "hs/NLp813RP4Di3+ye3nbnS4xypummWODn0PlaOhKDU=" + "hash": "OiZ3EyumTvZq0ap9NHmtpTal5MZILYP0unVR4ucNIcY=" } }, "is_incremental": false, @@ -1170,7 +1170,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.InteractiveAuthenticationProvider.html", - "hash": "PMbbzpySBWz9DFWTO47O/niRv+uXVyfsVdE3yktxUgA=" + "hash": "tBRvHsPcaDjGxVkf5JaZzRDySHHod2EeHXGu3lwpb1o=" } }, "is_incremental": false, @@ -1182,7 +1182,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.OAuthAuthenticationProvider.html", - "hash": "T0g6Di9Znb63HtREvH06ruDZVyCKyubbDn5DFYR3Ows=" + "hash": "RDiQ23ofJ2ASxM1OpjxxdWmYL7sibWLjDpnX6bpu3ks=" } }, "is_incremental": false, @@ -1194,7 +1194,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.OnBehalfOfAuthenticationProvider.html", - "hash": "/8fOEA79UAwZax1ODtZbfiTo/1bzimET8fVs8p8y9cs=" + "hash": "gr54bUoX+myFJeaaNWKKGTgdXh87kADsdQ22BDWy3n4=" } }, "is_incremental": false, @@ -1206,7 +1206,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.Services.AuthenticationProviderFactory.html", - "hash": "4VA2Chq5oE6snm52UH3f28JzAabGc+Gs89/B3YH0+24=" + "hash": "I/D7tWpdCjBjVIaO6PZ1HrW1+AG8ku1ZrB/jX+XSgjY=" } }, "is_incremental": false, @@ -1218,7 +1218,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.Services.Builder.Configuration.AuthenticationProvidersOptionsConfigurator.html", - "hash": "32BTLLrOdAPxTafxCtIyGwqz3Edm8gJ9NHVGHwZhIi8=" + "hash": "o7aXHE3jPhkqaU/+uP6344Bvpt7+Juu2aTwOid9hEyc=" } }, "is_incremental": false, @@ -1230,7 +1230,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationBaseOptions.html", - "hash": "VZ1iNt2HndKlMETpYDJrwTG8MPDHlN6012IuDmIQYAk=" + "hash": "Ua5PuhqELb90kBxOJnt8HouoCWuXIEVQVZi188IP8DU=" } }, "is_incremental": false, @@ -1242,7 +1242,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialConfigurationOptions.html", - "hash": "kahioMvJIIDR0pTz1ur+NTOvttmL/kc9P8FssE2hMfQ=" + "hash": "6Go5OOcSqoawYY5PyfUt4pUJyT/saR4uqTYxdwyUhCc=" } }, "is_incremental": false, @@ -1254,7 +1254,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialManagerOptions.html", - "hash": "K8/w50JX3s6agMuZnehJG1L5G5i4lqumh/cH3wKY/hc=" + "hash": "3aMBNddDtThUSPqEc89JvV+cA1CyP3P7T0mJyvxYbTo=" } }, "is_incremental": false, @@ -1266,7 +1266,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialsConfigurationsOptions.html", - "hash": "lgxiU4i82DJ+0+kDfrRKqU5KvbdtwUD1LXePOAEU/pc=" + "hash": "nET/+k+6SjYKZLAEM4PRQsnd9ZZCwWWr5l0Rnau2FoI=" } }, "is_incremental": false, @@ -1278,7 +1278,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationCredentialsOptions.html", - "hash": "6ZcYISvOJodOcB42xxLFr9+jQ8XeMUohW6i3Bl7/n2Q=" + "hash": "RuO/AUFMxZBovBvMPkWihPA2HonrA+F6d3EzESF6DyQ=" } }, "is_incremental": false, @@ -1290,7 +1290,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationDeviceCodeOptions.html", - "hash": "aqx39UM1EyWBGPPxLKFnksbujmMXOHURAaoIWIMRD5o=" + "hash": "r9uS+OZkBGcnnR9qpkGzECt5Q5Z9rPL2m3DFz33O/xQ=" } }, "is_incremental": false, @@ -1302,7 +1302,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationInteractiveOptions.html", - "hash": "b20QpGE7O7XtbFWRsSW7xkPMj0OGMtQknKjcycGzwsA=" + "hash": "24kHXAgpcdkYDYn9OFxjsrgFPyy902wuM8Oo8HXDKPk=" } }, "is_incremental": false, @@ -1314,7 +1314,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationOnBehalfOfOptions.html", - "hash": "YOlm1U7z+x6+GOB9DvmnP2uxHaFHCf8Npjo1hy4vhoo=" + "hash": "VgRBSwciJKHXmsuvLUP1bEP9kM0av4Q96edO0+FeSe0=" } }, "is_incremental": false, @@ -1326,7 +1326,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationOptions.html", - "hash": "owGi1HQPBzDSbaQvMrzxzIRa+ksKKxNvImYR287vxQk=" + "hash": "KMutRw4UI+s9AWPxagfnCyazcbyUl4P5zmkGnpGoP5Y=" } }, "is_incremental": false, @@ -1338,7 +1338,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationSiteOptions.html", - "hash": "3FP5sH8ziqUjOlRJ6bbYYesWBj2lVLBm3Vh4M8V4Qag=" + "hash": "q2X8FXu2SyPwtHnBCyrZvklvQpxccqLZD5gdAjeZmVc=" } }, "is_incremental": false, @@ -1350,7 +1350,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationSitesOptions.html", - "hash": "atWdEiH5YG3C3VN3id0mwmaCmTZcLNdPFvtwKjvsYKY=" + "hash": "SGjii+ynD02vkUBw6r/SK13Iry7ZrMy0AjNawrqsVjo=" } }, "is_incremental": false, @@ -1362,7 +1362,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationUsernamePasswordOptions.html", - "hash": "Z6W2Q3B+40vvfZyVatnklcmBV+WCMQ8yrHG8L8ckY48=" + "hash": "DjYH2Ihbo0PtLlXWQ33BUV+Qd5onzRuAQb/XCpzk+WI=" } }, "is_incremental": false, @@ -1374,7 +1374,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.Services.Builder.Configuration.PnPCoreAuthenticationX509CertificateOptions.html", - "hash": "O521tZWqqjhogDOvX0lKV2dsLDOT2qcVTTrn8WQjkE0=" + "hash": "nMJ4FRQoCnQm+YAh7A4r5vHZESrLjmCRBRgqh4kC07c=" } }, "is_incremental": false, @@ -1398,7 +1398,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.Services.Http.MsalHttpClientFactory.html", - "hash": "zHjpYgq0Kz/BlV+0exWzzjISiuWSb1XVK5Zp3GhBdIw=" + "hash": "C8LhiGGc5jp9J7mc7zZleMMzo/Y7OufmHD+wVAi4rNU=" } }, "is_incremental": false, @@ -1458,7 +1458,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.UsernamePasswordAuthenticationProvider.html", - "hash": "OOEFx/bWbs0FzefnWSUuFIZEcn+v4kFBB145U3jPK6Y=" + "hash": "xSCELbzYE1H887OzwX3RJIlQDHxmG46+R9aBN/tLzZ8=" } }, "is_incremental": false, @@ -1470,7 +1470,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Auth.X509CertificateAuthenticationProvider.html", - "hash": "BewfE4pGvFy6EUE0lAlQaAmGjhtuxmf0A0eYgQQ/hNw=" + "hash": "d+1juSOJtQheegdvotod1n6c+1sdXAfvGvjyIKejhBM=" } }, "is_incremental": false, @@ -1494,7 +1494,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.AuthenticationError.html", - "hash": "0iceqR5o9RWv9+B++/hKPnbO+G3A8LimU0kUqGSs09I=" + "hash": "CJusesNgO7fypYSOBBdLvoPrDJ+aCQQDpglt17E0oEA=" } }, "is_incremental": false, @@ -1506,7 +1506,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.AuthenticationException.html", - "hash": "xE1Ztpy4XdxgJ7Sts3v33RpBvOel8VVnN5G2GdiOUFM=" + "hash": "+Sk2BFgQXAcuyXndtlRN2Hd8msxsWPPKLzGjz9CbGIg=" } }, "is_incremental": false, @@ -1518,7 +1518,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.BaseError.html", - "hash": "CChA4Fxxg3Dlf4A68bZGld8V5A9NG3I+WQnkl4CUWYA=" + "hash": "Obi7yxpfPT5dk9nziAVxdujG0QJ5UHaPycM/qoq7nvo=" } }, "is_incremental": false, @@ -1530,7 +1530,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.ClientError.html", - "hash": "b/t0OVv6RbIK6BX3rqr9BJ3yQpFBvFirPLJ6YiBKbRw=" + "hash": "xaJibvwiQNFRUQLZZO/+Pn8DGUCYkHHS7tOW179hwx8=" } }, "is_incremental": false, @@ -1542,7 +1542,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.ClientException.html", - "hash": "LI2+p+dBQfaZPw16YPnISkK2AHqA4WJrjUEE2tcIHmg=" + "hash": "J8DYnJakU043ToOAJsqtIja5yE0lYro7140DRTKFqhg=" } }, "is_incremental": false, @@ -1554,7 +1554,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.CsomError.html", - "hash": "k2bKz8nMqiK216f1nC1JHtYYyavL5W8fPIW0Ox9mk4U=" + "hash": "GKSl3+CCP8ov42RZK2VQSj0bgiGAjC238G/tYXaLv6k=" } }, "is_incremental": false, @@ -1566,7 +1566,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.CsomServiceException.html", - "hash": "HJ4YcxKBBQi8PmpZOTiQrwHefAeDL+t05q+F3u7dkaE=" + "hash": "e/l3B0MHmtQN7OpT7iyaHqgQ/i0iNi8/gFKOEsQuQAU=" } }, "is_incremental": false, @@ -1590,7 +1590,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.MicrosoftGraphError.html", - "hash": "om0LHMYJpKfsJqsh1OJ3abzVCKZxwKA1fOgB0jMCbIY=" + "hash": "vGOXP9VE2MlgkFg7Bh1wCLEdLezRPkQPmyaauhK/ZNo=" } }, "is_incremental": false, @@ -1602,7 +1602,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.MicrosoftGraphServiceException.html", - "hash": "TMoB9xT1i0SRsYqcvHZ0oh2O8TMMVkm2yXId2abnVIc=" + "hash": "2TYK/4VdTA1keMF/mWEZMZK1qgK7pmM+XiiUy8N9DTk=" } }, "is_incremental": false, @@ -1614,7 +1614,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.DataModelCollectionLoadExtensions.html", - "hash": "Jge60ZgVpIGt9mXlviP6/eoyKlHibSL9vGOOjBmcedI=" + "hash": "QJjzTdRIFOHs+QMVhZVbQnsc6O9kY2lzGgc/6ucHL8A=" } }, "is_incremental": false, @@ -1626,7 +1626,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.DataModelGetExtensions.html", - "hash": "oxSvPu6lPnKMcJPDwYRq0t6AJ+8VzIHWcxstDdIESa4=" + "hash": "9FD4RcgCV6PP13APh045/eXFEytkWGxoF0Bfw4eNUgI=" } }, "is_incremental": false, @@ -1638,7 +1638,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.DataModelLoadExtensions.html", - "hash": "nXLe8UqwNCb0jzyvAOjc8NltJupVBE/4ui+BbB+luUo=" + "hash": "8QUzXyeQWjf1GWRbexNGgUg9+KjIvKhuetcNEo8BJmg=" } }, "is_incremental": false, @@ -1650,7 +1650,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.FollowDocumentData.html", - "hash": "O1pJzDvm+3/fQCbBLJKJQ7sHia/NovEGkYlyaZAqFz8=" + "hash": "GNDnJ6sIwPOkmBDChWWb09nTc3A5DuUwJnoYcCymG0A=" } }, "is_incremental": false, @@ -1662,7 +1662,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.FollowPersonData.html", - "hash": "HEc64BfTQZRdoIcBJRktAIef1qmm1S787Iqaw9ZVIY8=" + "hash": "hm7+zwSeT6jKjO4+HNfajNgVK3gJPPRGE8ePq6BeSAg=" } }, "is_incremental": false, @@ -1674,7 +1674,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.FollowSiteData.html", - "hash": "Dyz+EjH2BpNykX1f0ZPBA2RJkV+wI5Cfz7eqVEr8O64=" + "hash": "g8D4mU3FnbM10dD74Vfzf1k8PGg+T2Nk22M/qSv7Fxo=" } }, "is_incremental": false, @@ -1686,7 +1686,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.FollowTagData.html", - "hash": "zGKuc+48VOsOss9R6b37n/WPLpRr6L2Mu2sdJwxC+z0=" + "hash": "lkyEJI315qyrBNMgClO6loZdig85/d5tnblHJP5rDT0=" } }, "is_incremental": false, @@ -1722,7 +1722,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.IBatchSingleResult.html", - "hash": "k4k2qs0GqlnQWBzCY1VU1A3byr1y09I+FOgvHrOzFEw=" + "hash": "D+X2iVtIqSOT0+JDm9RJbXKbHKLFT1XwX0OwgEh6AVs=" } }, "is_incremental": false, @@ -1734,7 +1734,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.IDataModel-1.html", - "hash": "CxsjoIXrwfgbahl9H3krhpqJ9V0aU0jK0xK9PPOOTSk=" + "hash": "ZTlzhkCF01ZH3C5u3Qb1EBmnsG6q0OSFR7Y8SuQHtPE=" } }, "is_incremental": false, @@ -1794,7 +1794,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.IDataModelCollectionLoad-1.html", - "hash": "pFDkr7kTWAjtkO3DbJh6KaS9zxQw1u3NMDHBroQL1hQ=" + "hash": "vlJVPnQUEepR9UQQseWzupktmHOllDNGGST8O1DXyLU=" } }, "is_incremental": false, @@ -1818,7 +1818,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.IDataModelGet-1.html", - "hash": "6K0OJ5KgE5VycWp0h4RJJRPMq+ROMrlLSRp5w1vHsUA=" + "hash": "o6e+Q/0Pw1KDUVUdn8FG3Smu6DyN98LeeCRcNd8Or7I=" } }, "is_incremental": false, @@ -1830,7 +1830,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.IDataModelLoad-1.html", - "hash": "wDlEvmg2lANtD+VXaqqEnSVhA6Cunt+3kQnCqx85xSM=" + "hash": "r6liIWmstD2a5h43Y/81FFtQwZRlAtGBqYNlL8EiMAA=" } }, "is_incremental": false, @@ -1842,7 +1842,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.IDataModelMappingHandler.html", - "hash": "lRABBLcKlbsl76cBPLlpeY+3FL1s1mk4PL1vQO77UYs=" + "hash": "2Fn/bYYMbwTT7xm5S8zSrDt2K/0qThLF7Ohql9mJaPU=" } }, "is_incremental": false, @@ -1902,7 +1902,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.IDataModelWithKey.html", - "hash": "UpzbeHhfX2UmFkWjeUfH5jfxChE/x4kItuLdvJSicn0=" + "hash": "JmZxf5gwhki+4sELZF7nuLkLxv2GTpS0Ieuf4hQEBN4=" } }, "is_incremental": false, @@ -1938,7 +1938,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.IExpandoDataModel.html", - "hash": "gD5ieUj/AQvDDMpEEb3frAT5GmJnL5PDQabrokHxImY=" + "hash": "7RBeZgh6prXklRZJW7jX4Q9JKzmOdhLZ4gIIr71qKno=" } }, "is_incremental": false, @@ -1962,7 +1962,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.IManageableCollection.html", - "hash": "tpHZwQ/LTolzcj+r3AkKgq9IDQJM9lnD+ig/UyEvcHY=" + "hash": "M8GIauSc34b2QhjxQGvI0lfuaDMNOC2g/1qzuWJV/8A=" } }, "is_incremental": false, @@ -2046,7 +2046,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Me.ChatMemberOptions.html", - "hash": "bMoQK20YnYz6JnVqxZ4yst3aK50cAGDi5C6MuOxbFzQ=" + "hash": "s9dHlAMi/ojaLWm2zc7LXSf7slsQMeq+BAZqhwWV4YM=" } }, "is_incremental": false, @@ -2058,7 +2058,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Me.ChatOptions.html", - "hash": "WwH0CmbMiWfZ/y31+E4umvpHVHMYPf3zKmB+5qMXPyA=" + "hash": "KkmLLjlNX17iPdpQj3ud565J8ge3ri9/DajxEImw1t0=" } }, "is_incremental": false, @@ -2298,7 +2298,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.RequestModuleExtensions.html", - "hash": "ZW+WcQ7ELzN3ogd417+BSFcwkRmVK20MOV5wlsjjDq0=" + "hash": "XBMIOlA7j/ArnQtkTJ1DIbA4GdS+9/fopoWq/6o1wh8=" } }, "is_incremental": false, @@ -2310,7 +2310,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Security.AnonymousLinkOptions.html", - "hash": "VcRDC8cqgNU2kF4Y5LxEO9a8fxc5gswTAsE2kLSxgjc=" + "hash": "lP1SBe9yqEq5A5X5pRiDB83l/na6V8svNo+/rTY2pvo=" } }, "is_incremental": false, @@ -2454,7 +2454,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Security.IRoleAssignment.html", - "hash": "8GV7SQQEp4FwKLrSjzkuc/iK43Fwwjy5crmo69d3c58=" + "hash": "SXQxmx4o4YLharVzoyv2AE6TemXnx/OG20WaA8P5rAw=" } }, "is_incremental": false, @@ -2478,7 +2478,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Security.IRoleDefinition.html", - "hash": "2KJwPZu6OZgQSlr+Nqwu0R3XoeAOVvpm0uvw7JCIROE=" + "hash": "iuBn9Yonbb21Lf3eXDuPlvtIm/f4fPg6rA/FEzH1zMY=" } }, "is_incremental": false, @@ -2502,7 +2502,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Security.ISharePointGroup.html", - "hash": "lhM8qpCBccr90BsNHeP9bYx13Nv/xbjadU8s1YhOT/U=" + "hash": "YrjhHUXSykHSn0iD7KQsLXgyQgTU/vw6j9KAXKQ+RZg=" } }, "is_incremental": false, @@ -2574,7 +2574,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Security.ISharePointUser.html", - "hash": "t2BgKI+WQFCRmrKRxOqQU//iFahVqr7+rIBEsRrKPb4=" + "hash": "o501a8G58OCNpGXSCq038Dy3hxCOy/3ZJFDLz/nZUlk=" } }, "is_incremental": false, @@ -2622,7 +2622,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Security.InviteOptions.html", - "hash": "txn+RS3/UQtIztTb42UjMZ3rW5FuupLzQV80qww/i2s=" + "hash": "hn+vejVxvlAkymY/ugE3FRjiVni1vVq6UW4zpFTtGE0=" } }, "is_incremental": false, @@ -2634,7 +2634,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Security.InviteOptionsBase.html", - "hash": "WmAG6xAakFHfavgCSJ01gXK6rRVgmJsIubnxluaXZhs=" + "hash": "LlL/rQHGAUQb3eoKivJG4wmGR7PxU622MPRiwMKh9wY=" } }, "is_incremental": false, @@ -2646,7 +2646,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Security.MailOptions.html", - "hash": "HK8h/9gmOsKYy9Or4SF3YRczcIs4oS+RVVDZJjvkzYY=" + "hash": "BuLqYctio1So8cQHOmQX6vmkbwhIph7jn3p+x4CNhak=" } }, "is_incremental": false, @@ -2658,7 +2658,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Security.MessageAttachmentOptions.html", - "hash": "eQ5vHprCY9vfAwbs8lEU/g/hIupNtb/DELpEiZcHivI=" + "hash": "4YwtCqEA0wAfbs05m8i71n52RErfVSv6gJwxlKLHTvU=" } }, "is_incremental": false, @@ -2694,7 +2694,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Security.MessageOptions.html", - "hash": "fQDPYCuf7PxkChw/f6yU30t25gkFqFzdIfmNzqyZb7s=" + "hash": "ey2ny7O65GsYdkLfKQmWpvcRjHykcYKkqjPMhw4N1BI=" } }, "is_incremental": false, @@ -2706,7 +2706,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Security.OrganizationalLinkOptions.html", - "hash": "kj/HUwPPr7yNfIVGZapeM/aOrOidaV9b7RWl39VUfzI=" + "hash": "FrGPjPzYvL6HiWWBW4QdKi2mXYIlGQ36yLVlgGBidKw=" } }, "is_incremental": false, @@ -2742,7 +2742,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Security.RecipientOptions.html", - "hash": "lJi1M2M5Fsm96jljZTSve+zDTsgGhGddJ3qAiRE8gbw=" + "hash": "BGktCX7WVmhXM4lNJWT9NsxbAv81OfBTFDB1tKSeh68=" } }, "is_incremental": false, @@ -2778,7 +2778,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Security.UserLinkOptions.html", - "hash": "VYTicX6RUCDttBEMcDEJRRv8G4LtILpcO/NeCEdnEP4=" + "hash": "h2r2gbs2lo5wsktcwyN6nQDP1BS0nO3hux3x6TzxM8Y=" } }, "is_incremental": false, @@ -2802,7 +2802,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ACEData.html", - "hash": "R+8DXnkMrUTAAdKqErQfAQpHosWuXTfBLlxpn7MYpyo=" + "hash": "Z1C/119u2a0PTBvbzgoxCDX+S/geYUh3AIhxRIkFfBE=" } }, "is_incremental": false, @@ -2814,7 +2814,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ACEFactory.html", - "hash": "806xGsaaGFEGrjROuKnP/03cLJh074iPm0CrdBM8JBU=" + "hash": "Z0IBkUrDn0mnVwfjNr/e0KpP5CBwxTv7CjlJbkcjpkk=" } }, "is_incremental": false, @@ -2826,7 +2826,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ACEProperties.html", - "hash": "amRngb7Umw7RMXdRoNm15SL8h2i/XVye+o4zgzFYSp4=" + "hash": "+EgIJTIufJ0C+5Pu6ylt00scvkRJCjWHHGz8KUSzve4=" } }, "is_incremental": false, @@ -2850,7 +2850,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.AdaptiveCardAction-1.html", - "hash": "maCnhWmXNVlfaBcTLlI/kWFFH5HoH/umBj9VVuZ94pA=" + "hash": "rLDGcGFH9gBwMAQ8XlZZln4/qY9qeWTYOsxf9Het4Kg=" } }, "is_incremental": false, @@ -2862,7 +2862,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.AdaptiveCardAction.html", - "hash": "GYQ+vKiQ+lcPkesYRe/xGmCyM5Tdp11kfHf/vvZgrFM=" + "hash": "ygHI0Ri83gTR2fFcDXxjmG4AL5fY2jtShG+7UDAmUMY=" } }, "is_incremental": false, @@ -2874,7 +2874,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.AdaptiveCardControl.html", - "hash": "z1ErOUOMdFMGI53bSMmvNmAsJEHA4cvHJnIES2WwGo4=" + "hash": "FswRxW57goo4N01LuGm6F9Ke7jljuOvgXecfUwwQbQo=" } }, "is_incremental": false, @@ -2886,7 +2886,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.AdaptiveCardExtension-1.html", - "hash": "roGX2Gzyd345tlsrr46iDlwlrDEU4sFZCARYAr1/YEc=" + "hash": "64nsdHE9Uet1ZNBqdyA2e/Xzvf6VeZ/JjaSoVLNy2rg=" } }, "is_incremental": false, @@ -2898,7 +2898,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.AdaptiveCardExtension.html", - "hash": "6PMIFNDocaW1fTM5Vlrhp1YvoeRwB9+fCJ027s5QM9o=" + "hash": "ACJtv5H5JgAbsuPadQUD7NYVmxsKmTcISOfi3rBuewk=" } }, "is_incremental": false, @@ -2910,7 +2910,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.AdaptiveCardTemplate.html", - "hash": "dbnvu3RcfsJEB6fMW0Y2J0GQy2MUysW8g99U+a7wMnA=" + "hash": "v43/aCmIcDZnPjsCNXQPrAZXcI2R6s4JRF/degJtyFI=" } }, "is_incremental": false, @@ -2922,7 +2922,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.AddContentTypeFromHubOptions.html", - "hash": "xCBRyFPC4NRO/6WVgBW0i7lIb1OuZxzG4weiRMT4/uY=" + "hash": "nE/FzQzOe+cbEmbQE4lbJW3mq4DWuesxtXsZtFbSyHg=" } }, "is_incremental": false, @@ -2946,7 +2946,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.AddUserCustomActionOptions.html", - "hash": "I735gTcqjEJwRD2X0aenCQAaeFyjaGpACLYwBD9K2C0=" + "hash": "rGa88HOEL530kSnDRrg2RxH3qamjbef/Mu8eWQHT+bs=" } }, "is_incremental": false, @@ -2982,7 +2982,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.AnalyticsOptions.html", - "hash": "FQ7Dxm0V/lf5AC1VNp/G+MaDaav1GvlsCElg+yZw37A=" + "hash": "OQIy21M/HpFcZgrbWAskAwPCgkbZ4oLAN4S9tbBO0JE=" } }, "is_incremental": false, @@ -2994,7 +2994,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.AssignedTasksACE.html", - "hash": "A2bjL2AplRAMwiuNKel6SjLtIZ89v+ySlDl8KByz7k0=" + "hash": "heZPFSBwvu8hvszQeQ9qFNfH53t1JkSaITc5FsTEL0Y=" } }, "is_incremental": false, @@ -3006,7 +3006,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.AssignedTasksACEFactory.html", - "hash": "2iW0zQkua6cq8DTSxxFssO4w7THXK8TROrywOp/Mvts=" + "hash": "hA6pp8FyuDPgwAnh78PEGx0cAgTisn+VCYRtfxegl6I=" } }, "is_incremental": false, @@ -3018,7 +3018,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ButtonAction.html", - "hash": "pIoFeGRLsKDX4QPMhJXOyPGKCThjQIGZPlBucBQUqAI=" + "hash": "pnF5HwL1S3EbW2QjZEBRbWWwY3WZctxiTWnNCFKFobs=" } }, "is_incremental": false, @@ -3042,7 +3042,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.CamlQueryOptions.html", - "hash": "5mYmgRGEUUcNBPX+pN/04ZK0+uONjnKyM/GXdGa4tM0=" + "hash": "/cq9+oiZIOJL5JOMJqeZbJpFoZv7VB9fYWgEWxpqagk=" } }, "is_incremental": false, @@ -3066,7 +3066,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.CardDesignerACE.html", - "hash": "WjxVGyrzT9ErMv5LaXmxerfWg3JdjLkwQRWMfDDOfaw=" + "hash": "DXwZBV3+WoHlamlcfs+m7YyCzPaoZr8K6mmJDI5ildI=" } }, "is_incremental": false, @@ -3078,7 +3078,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.CardDesignerACEFactory.html", - "hash": "PhXslSIAbbdXh6CWQn7+V7oVmECod4PEnJ8ct8OUEuk=" + "hash": "suotF1BjZ34kFiaW1mpj6jlmjYJnCD8O3WHYZK4iZD4=" } }, "is_incremental": false, @@ -3090,7 +3090,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.CardDesignerProps.html", - "hash": "rLsU2P0p1QLs/3cnl+Vv+skDA2AHyPIW5IuRDhSM/F8=" + "hash": "MCDCaECcvjb4dXBpvNosYTbryMt0mfPfo7dKY3vrbBU=" } }, "is_incremental": false, @@ -3126,7 +3126,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ChangeQueryOptions.html", - "hash": "7Bg6Llf3oKix3yRMMXt8XA1csm0QLpdyItMB44Rs5ws=" + "hash": "jzKCagI2RvP4wmufWPg6uWjMQXOvW531DkDrw/2n4iw=" } }, "is_incremental": false, @@ -3138,7 +3138,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ChangeTokenOptions.html", - "hash": "pTaiK+phcSKv8XzgZVOvujX6cN5OeDMrAl/ahG75aoQ=" + "hash": "4e8153YG+n5S1hFhvkI/6FNF2SM1j+RxL32edm4LDUU=" } }, "is_incremental": false, @@ -3210,7 +3210,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.CommonFieldOptions.html", - "hash": "uEwOGjxRGsVeZMwFuBZ9HBWEPrDC/+X4d29DFLJEQ9g=" + "hash": "8EjDO9wi55JGNhe4X8rc2Q6C/JIMsauBAiCVZcFj2fA=" } }, "is_incremental": false, @@ -3234,7 +3234,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ConvertToOptions.html", - "hash": "DQGT+AJYjoPEXUbZ6kpibGmf1x5ZTkBr3QX4t191sQk=" + "hash": "wX329jhTfbkT8yUBKxf4eC4b+J34LQe7T5zJe595yx8=" } }, "is_incremental": false, @@ -3246,7 +3246,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.CopyMigrationOptions.html", - "hash": "gAXHIH6nypdv7bJlfpyggHaqPPFr23at3fqQRMJp/MA=" + "hash": "NQ51Rvm+g11/2OAv8vAVG2VTnv68E5dwyM+dub3ZuFc=" } }, "is_incremental": false, @@ -3258,7 +3258,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.CustomImageSettings.html", - "hash": "FXWtDVhHwv/NY9CaHvKDX0AlNmuHD1OcNlz0b1+jkVM=" + "hash": "ZzyGtnjlR5GgrfGyThnzwkf6OPOeqoiQgKGy4c4FFNc=" } }, "is_incremental": false, @@ -3270,7 +3270,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.CustomThumbnailOptions.html", - "hash": "LXO3iEPiJixGC8DpwAmqhPVwik1qm8/2a5BMn74OpS4=" + "hash": "dmKVtc1IYtGQx1KL2iOU+NLvX3UfVWTTCfgPdOj44sM=" } }, "is_incremental": false, @@ -3330,7 +3330,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.DefaultColumnValueOptions.html", - "hash": "cufDz7oBUorbv6Jo1jNeHWYjC3gSiJOavHGm5+D0L/A=" + "hash": "16nhlnQYq9VOS5IbaXg3RdWT3+x42pZKe7QxLUi715I=" } }, "is_incremental": false, @@ -3354,7 +3354,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.DocumentSetContentOptions.html", - "hash": "0jnRpYuRk5cMEv2x1kj2qaLDvwE2JFBZZfmJARB3MRI=" + "hash": "6wCvUxMrBhW9f0xOMb/BFkHUjzPy45qXxMvVw+W1qqQ=" } }, "is_incremental": false, @@ -3366,7 +3366,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.DocumentSetOptions.html", - "hash": "YghdRAatmwXNH5Fl7rkoEI0oCkoaUQ5ES0C7mxoAqdk=" + "hash": "hJ5xAIm3RcnvHUHqSYgqoWTf7xRQe1ukwugurG5HSJk=" } }, "is_incremental": false, @@ -3402,7 +3402,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.EventReceiverOptions.html", - "hash": "o04HhXGQGGYqCv1qQGpCzTnJdUr1Nc7y2nSXumL/lFQ=" + "hash": "jCDw1fKPIypOB7jFydKTebHLXjUbfnEMSW24N81CK1c=" } }, "is_incremental": false, @@ -3438,7 +3438,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ExternalLinkAction.html", - "hash": "ylKvwPX3jYWIUeOG33jnHkQ3183qEPy8z1jYGzVDWso=" + "hash": "C+hvy93oI9DvElPisBCYcdpLplYdgE4gEPZaisEdrZo=" } }, "is_incremental": false, @@ -3450,7 +3450,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ExternalLinkActionParameter.html", - "hash": "fLIoD2t1jfgh2uWxZeFSzFKpxppzdwuJwYrdp2D6S4A=" + "hash": "nfifGD0J+dKjVL0HWhOabQb46J8iXT2QXejoBvM5Z1o=" } }, "is_incremental": false, @@ -3462,7 +3462,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldBooleanOptions.html", - "hash": "hAKK779R5m9eK2QiKZ8Bf7VEmzpnHXoPudRaSKgpGC0=" + "hash": "EH4TXgnPUCNGlI3nLDvo4oBdH+yDi4YVO3AVBCU7omM=" } }, "is_incremental": false, @@ -3474,7 +3474,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldCalculatedOptions.html", - "hash": "dal1CzpKccHa/qeYRlgVl+8MfxZqiiymF8ZYaS3oCyk=" + "hash": "iHLYJ/v3tvfq/g84KTqcga1gvM2yrmwXUguhYC1pbTY=" } }, "is_incremental": false, @@ -3486,7 +3486,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldChoiceMultiOptions.html", - "hash": "WxQW4GaxHrDy9ORQm8rFYRC+Rl4J8trpIkmybodomJo=" + "hash": "5/VaeUaTxADlG64xVvK0+xTJs6OhjM09RLwLUPk4aZ4=" } }, "is_incremental": false, @@ -3498,7 +3498,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldChoiceOptions.html", - "hash": "ybDh81u5K4VDiBYVkR+eYH/vVbhZcPpxJ8O2YnqtV54=" + "hash": "HCHTzbDvDg8xfGw+gY5bNOR5ui5H915ldech/bGxtlc=" } }, "is_incremental": false, @@ -3510,7 +3510,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldCurrencyOptions.html", - "hash": "YHG2Ir6JPP39glX/NvgH5HVgeBBEKQuwB4BFNdMdc+A=" + "hash": "l/W+NrLP59IICPDJJQB3nVebp9YnVOIlAbIlLPH6sLY=" } }, "is_incremental": false, @@ -3522,7 +3522,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldDateTimeOptions.html", - "hash": "5nIq/ir3b51TeTjGXhC9vwomTQydS2mEiDRSyVOwiJA=" + "hash": "9QdX+A4fx5tJE36UShsp0sNvv7+pt/B5+hZF0WC3CWk=" } }, "is_incremental": false, @@ -3546,7 +3546,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldLocationValue.html", - "hash": "GprZH0hVpFI6XSfanvYa7jzrmUXrqUwIzM1qzcAnNA4=" + "hash": "CLeAKve+O0+uv/FzHeXeUFzBqv2ZIvK6is49HJldLmY=" } }, "is_incremental": false, @@ -3558,7 +3558,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldLookupOptions.html", - "hash": "Ho0+8WWiPEGFVA2mvqM2ceT58+eLPCVy6I4r9hRIUFE=" + "hash": "hpvSY0NDoi7zEbqSWV9nCEU2z3Y/WC3yESJUuejdCiw=" } }, "is_incremental": false, @@ -3570,7 +3570,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldLookupValue.html", - "hash": "0ZodSOwGCXcPVw0V3HSf9xgOAUadxezLm7CVNKnyWV4=" + "hash": "gFDdPNAxbwMRRAbrKHY60GkyEWeaqrOuBCOIQgeLQSA=" } }, "is_incremental": false, @@ -3582,7 +3582,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldMultilineTextOptions.html", - "hash": "JvGPe5NmBTBLncgSp6CwDJ19d2YfgQZeacYBlypsS1I=" + "hash": "hTaiM2zXzsa7+Jg6MDN0rffK+Fshfjz+Fm6tA/nNUUQ=" } }, "is_incremental": false, @@ -3594,7 +3594,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldNumberOptions.html", - "hash": "A7vgSWI7UAyvQ3RqtVUW4PSzZOqER+8lWzo3CWqDxog=" + "hash": "uGV1CIWhZofAZxtotAjG3XAfIiUHpoFJYELjLvLie6A=" } }, "is_incremental": false, @@ -3606,7 +3606,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldTaxonomyOptions.html", - "hash": "VALgv+2ujG+8CGSeEjtANYFS18VXDKwC7FJ2/fO0Csg=" + "hash": "Y+VIEV4l97h4ErbEnCl8kHweVsNxnmKmb9OVZ2HJLzc=" } }, "is_incremental": false, @@ -3618,7 +3618,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldTaxonomyValue.html", - "hash": "eZgazyHBE/Ro6ML96uBG4VCIePe9XTtjqnXNZITmJeI=" + "hash": "5/icrvx1uEidebT+UrZIwGwR87nugAMrYBzlYfuqslQ=" } }, "is_incremental": false, @@ -3630,7 +3630,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldTextOptions.html", - "hash": "xVZNWUK98Tu9Dy8QPGJHCxKZcnh3JEtPLkQ13wL3LSc=" + "hash": "/jjfePcFDuePqq/bkAzw1qoKIIimPdJZNtkEMLq09TU=" } }, "is_incremental": false, @@ -3654,7 +3654,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldUrlOptions.html", - "hash": "aZpOKdlIqewd2stJqhB8HiVNSSzIKw07sj+jQTifM4M=" + "hash": "uDm+Uu76XAWPTUCeyg0M7FCodzmJQUnBFYmngraDLQU=" } }, "is_incremental": false, @@ -3666,7 +3666,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldUrlValue.html", - "hash": "p/H8mnryNVzRTrjghW371Xe0glpOKjPSDLmSxT8uxuE=" + "hash": "kBYBmiVaDZJkyX97eot87LNzg8d3M1FYWENV6whJZG0=" } }, "is_incremental": false, @@ -3678,7 +3678,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldUserOptions.html", - "hash": "k6sxtxWJ7ehumE9djV7Bt7IZLfJYXr26JnSzRNui2WM=" + "hash": "ROikAF1vDRUczFzdGiepHF1BnbLUCmCYtKeuZuJ5AGQ=" } }, "is_incremental": false, @@ -3702,7 +3702,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldUserValue.html", - "hash": "qTBQy1pOuNZnaOgdPr8cB1xnok4cxWubP5KRI5xDcJw=" + "hash": "jZhF5u0eN3+fY/gUf/+NyBrzG3gSrp8QmdD+p4/Qa/E=" } }, "is_incremental": false, @@ -3714,7 +3714,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldValue.html", - "hash": "Nbs985JdP0wrQWdfCiHPH8rxhaaq8a/5Ml5WslrsgSE=" + "hash": "biiKHj/xkhwWi31rYf6uayRg7xQCgiQ6gVt8gdl60fY=" } }, "is_incremental": false, @@ -3726,7 +3726,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldValueCollection.html", - "hash": "loNhRah0WlJIBF3yWvL3QC5rrotydC8u65O7c/8Jqx8=" + "hash": "W5pPTka4Sx/Gulz7VCZix2GdkvCchwRK4jEjDKrUpcE=" } }, "is_incremental": false, @@ -3762,7 +3762,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FollowData.html", - "hash": "oGqCUpT+GQqfM0kgflAZxzBMvjHa9gDGCPOuXTryeF8=" + "hash": "FC/Ij9KXTL3Rj4zAX2mjRI6/CQHTqOIuD3td58txpqQ=" } }, "is_incremental": false, @@ -3798,7 +3798,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.GenericAdaptiveCardExtension.html", - "hash": "KRbsUUe6VVVIK142CNPdSe+mR0nEHoroOA0eoIbnuMM=" + "hash": "jgTuboUvnf0flJhUnlr/0yiZZRFx9NZbGq0NCtd8CLE=" } }, "is_incremental": false, @@ -3858,7 +3858,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IAttachment.html", - "hash": "Yn/F3fdZYLXQvyHUY2jkEgLViWO4BfnTCm5Wb1Csr3w=" + "hash": "fuuGVvn8rTRIpkdXRYRLe4CT1J5rCnjoph0Hm+DEGiU=" } }, "is_incremental": false, @@ -3882,7 +3882,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IBasePermissions.html", - "hash": "yeyS59J7Mzqqu3bVosrAjRKO0r4jTi9ql2QXRJn2EkM=" + "hash": "k6WFY/3SN7Q05kJrlvpU4EHb2crPPmgBv09yQ5IrXqE=" } }, "is_incremental": false, @@ -3942,7 +3942,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IChange.html", - "hash": "S9kAtWEZOqIRkNl5uoz39NDeTzuaGUW+7UHkIDM63+w=" + "hash": "rTfIRGhmCcJhbBm8wqSGruBIT/0IEIjMigpxIRynPic=" } }, "is_incremental": false, @@ -4122,7 +4122,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IComment.html", - "hash": "FNnSL+zRvrCg5BBQdajQqSsKf39yPHEIuBH+0m3lins=" + "hash": "YXizPGY1AiccYIEHKUpyRNDZZHOKyMTtZrQWE7gINSo=" } }, "is_incremental": false, @@ -4182,7 +4182,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IContentType.html", - "hash": "O5Ldc42EWi+AAayQv86HdLQ0sYLqdWusIoXSYAdLgy0=" + "hash": "HwzIe4NY9XbBlUbgvAH/CuC1bANRFOUk3kaHdFu6Q1o=" } }, "is_incremental": false, @@ -4314,7 +4314,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IEventReceiverDefinition.html", - "hash": "Z0WjMC34E8B6nwgdWywXi++QKbS3KbQrCtwpX6U52gA=" + "hash": "idX7NWozwR9fz79IWfp/0BNluxuUiu/7M1YRiUDi4oc=" } }, "is_incremental": false, @@ -4338,7 +4338,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IFeature.html", - "hash": "sznm5ApqD0R4IOd1GNTvZkOsVqBmRRAERWwGoqHs5jQ=" + "hash": "f5vBR1Lj9KUXc3Y62xooNEAlGVfZjthKHMNM40IJBjE=" } }, "is_incremental": false, @@ -4362,7 +4362,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IField.html", - "hash": "zLFNUNUA34AxNuiUnX22RXrVh063f/wFpBsI8OEXLCA=" + "hash": "g/lZ2TH6wUCEvhXGKw+0ah8r9vayvnmP9d2gUjiDYN4=" } }, "is_incremental": false, @@ -4386,7 +4386,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IFieldLink.html", - "hash": "hgSuGIircC4LOiv/u32b5SVZrBbC7Oa7lr3yM6lNanI=" + "hash": "jQCs3IzNypblKVXyyzYhDFUAGWmhwZP6vXSgQiaQ/vA=" } }, "is_incremental": false, @@ -4506,7 +4506,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IFile.html", - "hash": "vr/8/zp36VyLx/dneT7nDoVEOCniblQmDMPyLkoaCXM=" + "hash": "w7glLkqjH2TUgvNnfAfKUeOIyMx+4ifX3ezZckbLg1k=" } }, "is_incremental": false, @@ -4542,7 +4542,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IFileVersion.html", - "hash": "fcS0Vbn+sVE4WxIDeFIPJU3pVNP21+inml6Am30WA/Q=" + "hash": "0tMh3kdxpnnWuFeCW5Lsz+PZdewvWORNf6nD/IEgD54=" } }, "is_incremental": false, @@ -4554,7 +4554,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IFileVersionCollection.html", - "hash": "xORsoR7QZYmLPwHOKNJnIvPirK8jxJGVo8ulzotdD1g=" + "hash": "I3ku2QX7a5jsI9uGJmUqM5zXl/62CwhNh9tSi8OZBWI=" } }, "is_incremental": false, @@ -4602,7 +4602,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IFolder.html", - "hash": "x3fGaG6y/ZOCGaMA/uy2s+fXAdlBcQKGR/EA7OCfD5E=" + "hash": "6iLbvK+x1bfhFwNZgERuJFRFttg+9y1qdMpVHMDsm3k=" } }, "is_incremental": false, @@ -4626,7 +4626,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IFollowing.html", - "hash": "6qSwLIobmp3utaiGnJY/tDkrrHDGrkmzPbKb9km6/zE=" + "hash": "2Rny1K1YqGyYr4PetDFGMZi3xGHu2cxVU0PBJbRWA+M=" } }, "is_incremental": false, @@ -4674,7 +4674,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IHubSite.html", - "hash": "9YI9aruSTlglMaWRVM9ohOxBIheHlul3jGekr5jCPX0=" + "hash": "ta1ZtsI43xxfNs0KdNA6JbFjYrCj0uMIOeYCvzFMERQ=" } }, "is_incremental": false, @@ -4698,7 +4698,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IInformationRightsManagementSettings.html", - "hash": "O+qalCFe//46aYIARHHRGhdySXgjDDrHtLafajKj5PU=" + "hash": "wdJUrMtkdKnCSUoSqCkz1uQvbgiw6Q+tAvvRTjTpB5A=" } }, "is_incremental": false, @@ -4722,7 +4722,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IList.html", - "hash": "LmzSThoo6uDC/4a8de2RoRhzwFvQ1/xqT0iHG1M7FKY=" + "hash": "yrBNCrrSQbw8YnNuY5+cT6V4XxMPLpqUgzV4fS+wfPY=" } }, "is_incremental": false, @@ -4734,7 +4734,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IListCollection.html", - "hash": "XhSv9i5lgtNrXb80F3e1InB+ksrYsxRyAggFePiGOYw=" + "hash": "WcsQ8O1E9lQwO5fzSosSPFmzxFM9yfp4sgIG5KoZRVY=" } }, "is_incremental": false, @@ -4746,7 +4746,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IListItem.html", - "hash": "F4x1BtZyKVd4VubjS/ygLdxLW3T/ta1jVm8vYepqeYY=" + "hash": "gMMFsmiSRdW4uAvzlbDzoOTwEdRrSMxKKcp5znbQngk=" } }, "is_incremental": false, @@ -4758,7 +4758,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IListItemCollection.html", - "hash": "pHyUH9YwDll1E3l4l+NcR8xbf0DIay/zAbWaSXRGack=" + "hash": "EtKmTiuXaYEWMnHD6ypw6KKs8UUnDFmDTJe0aiI90o4=" } }, "is_incremental": false, @@ -4770,7 +4770,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IListItemVersion.html", - "hash": "kaJ5JoZhvkHJdS+g/ENjgM3c4/3AJEC6NJFo3n0ASY4=" + "hash": "VMJ8X5LamY3koFBwkCJ9sbNwcktfoO5Tr3I8cNiXsbs=" } }, "is_incremental": false, @@ -4782,7 +4782,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IListItemVersionCollection.html", - "hash": "GKvTys6DvHQfj7uABb5SHBLTyhxlno2VzNV9DBC77x4=" + "hash": "YMbFBCwwLcwqAOvPrm1VZQDAiQINevSKAv8AZQqjObQ=" } }, "is_incremental": false, @@ -4842,7 +4842,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.INavigation.html", - "hash": "rn4/4hWnyUy7eAa9DT6GwPZetbCAtpoJMPN1w0hAAS8=" + "hash": "1cRn4teXri671rUnNeyQNmtKk24QXAbQOgFT65eYBNw=" } }, "is_incremental": false, @@ -4854,7 +4854,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.INavigationNode.html", - "hash": "YEgzU0cukRElDlqCjedt5uqBnghYf1I9nXnBkd4hPcQ=" + "hash": "zqm1HVeCsQeYMiTkhWfsA9v3yCfIQaMq94YmkwUtpwM=" } }, "is_incremental": false, @@ -4866,7 +4866,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.INavigationNodeCollection.html", - "hash": "6aj6NDuK3RBc/SWfyUcHCWdKJ6MjNHbRC9bERcMTPOM=" + "hash": "gB9PrSttj/zSpMai8lOZBY9h+FxmPrfV4N7Ck2w2aps=" } }, "is_incremental": false, @@ -4890,7 +4890,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IPage.html", - "hash": "9Txu3o0Iw0tXv2oDGeclcFXPOjz2L4u7WS5Iu5X3Mo4=" + "hash": "/uUWgO84orGhyqOtIW9I1ny7lUUuv4L209uPJtBOuOc=" } }, "is_incremental": false, @@ -4974,7 +4974,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IPersonProperties.html", - "hash": "Dfx0ZW+PGrBn7+ONrasVxWfO/C6rTzcvL6KeDvBxyKs=" + "hash": "gllU8xDzaR1WJRC49ato/s9V62s7JlqGfnqzy/xXx8Q=" } }, "is_incremental": false, @@ -4998,7 +4998,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IRecycleBinItem.html", - "hash": "gvMfB5NcfpDHN79wQbBXb9UnoBwDKAK5LlIs6v6gXjM=" + "hash": "sCviqvxL/LpBfYjUO1PHsrEUqprrcDAFUxtH43x3W90=" } }, "is_incremental": false, @@ -5010,7 +5010,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IRecycleBinItemCollection.html", - "hash": "uyf9UcAM4kX+SBPbls9q3a6KL6u1EJdnuT8thDpdz58=" + "hash": "/tg1TVeBcJRmgYrA23MfWTzBl8kdgu3rlIbD6XdN2bY=" } }, "is_incremental": false, @@ -5022,7 +5022,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IRegionalSettings.html", - "hash": "suhBcc2acH7kFdPhK/4928k/5yEeA8kRoZZz1jUNh3I=" + "hash": "MSzS/zzOk+VK6be1Th7EM8Cd+Cj5RNZAn90yxS86ND4=" } }, "is_incremental": false, @@ -5046,7 +5046,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ISearchResult.html", - "hash": "iWT0Wkmgnv5ua5eFg9QCy7HN+Og36Oe9H1FN3mT06A0=" + "hash": "Y5UiZUuRr4dWU78TT3j+tcrKVOWrkkJ75a81xtm7Uk8=" } }, "is_incremental": false, @@ -5070,7 +5070,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ISite.html", - "hash": "L+HH2bl0FmU2nxnDvY6eJ+4eDX3ZZNQA2s/R2p+Am+k=" + "hash": "QXMwOvSOh4A6Z7YFe67pUpCBQlb6ZHZxpGz0Nxwq2Pw=" } }, "is_incremental": false, @@ -5106,7 +5106,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IStorageMetrics.html", - "hash": "zpBJAOCTo3uM6nD9x6NNm05tmljNXCWecTcD+oeZchg=" + "hash": "EAqnJSGheAikwiQpTBdoo3MSi1wZULzNYkSD0edqbjQ=" } }, "is_incremental": false, @@ -5214,7 +5214,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ITermGroupCollection.html", - "hash": "r8xRsJu5GhyVC6A5wx6JJvSHOnODePs58t4pwp+4VxM=" + "hash": "HK69rJhLieN7YR2V1qfzTr8txXu1odoCl55NywuAZhA=" } }, "is_incremental": false, @@ -5334,7 +5334,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ITermSetCollection.html", - "hash": "Ccafdk+YYFSmE7TP6sUxjAS7yqy8yJ6Bj5zQbWx6xgA=" + "hash": "4apv02kYCjVvOBI58NSq/MAxs6dnB4Jk00FIjG5tMhU=" } }, "is_incremental": false, @@ -5394,7 +5394,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ITermStore.html", - "hash": "dw1/5aLnPCSxmsYxKI2nmxH11jdz1/sZsuvr20ytsng=" + "hash": "ue/E+lnlsLiLe70w/Ep/ZgQqKCyUH16BruOhcePs34M=" } }, "is_incremental": false, @@ -5430,7 +5430,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ITimeZone.html", - "hash": "92wQK3jeee8v4pRch4rleGvVUkz2u3Ocbog+y9VIp/Q=" + "hash": "ibIhZ/oKpPh1nXv8y++IGnG6Z17GnasA6sdUdX1ukbg=" } }, "is_incremental": false, @@ -5466,7 +5466,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IUserCustomAction.html", - "hash": "mO09MA8vLh2ZihpRvR6b81Sv3h63T8y3K5s6VbPBt9Q=" + "hash": "IjpuPn6I+yzTzflMIISDfkcA5HlYvbWHG2ivV7jvoh8=" } }, "is_incremental": false, @@ -5490,7 +5490,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IUserProfile.html", - "hash": "VaRNBOt8ntYRdmUKEleEdD7LlITz2juMb6bex7Bz4x4=" + "hash": "5IgHKJtyG9f4H/GSqKGljm/tmQGaEG3gdyncASzVaiQ=" } }, "is_incremental": false, @@ -5502,7 +5502,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IView.html", - "hash": "WU2wTmczkMcYr+8e/Op3CJB/PpbvbN2wF1J2Z4GM4zQ=" + "hash": "EFPOVTF0XA1muG7N5OSDO9eKAjPFlBHwIN0ivAeqPkk=" } }, "is_incremental": false, @@ -5550,7 +5550,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IWeb.html", - "hash": "9Rx79DboDUbIkUd93XjaEYwD4yw7ryrV5rOqrVr64No=" + "hash": "b4aru6XcIQA8o5gM8WlH9FNw7KIGA4hFMIjpx5dR8ZM=" } }, "is_incremental": false, @@ -5658,7 +5658,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.LongRunningOperationOptions.html", - "hash": "oLXOjxnu2R99N8xeaIMS2CQdh3dB4S690Khu6QW9x1Y=" + "hash": "uThKtrXVvd0tNXyoWGoNJOQj+Fh3LzHEJw6P0QsTvF4=" } }, "is_incremental": false, @@ -5694,7 +5694,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.MoveCopyOptions.html", - "hash": "MgO9Zd/0xUMIlses73iTgFzJXTtHbRMq6Bei8z+YhKo=" + "hash": "os8cKIrfNuZwlouMjOx69s4DF1VwkOGQ7V7a/fhtWhc=" } }, "is_incremental": false, @@ -5718,7 +5718,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.NavigationNodeOptions.html", - "hash": "lys7TzFxv4HwKs+PVpDn3gxaTPvOQP7Uy8l7HganWLg=" + "hash": "TOg7Vd5l7RYJCTKea2+zdruEmMtL+2CVGodms270HMM=" } }, "is_incremental": false, @@ -5790,7 +5790,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.PageImageOptions.html", - "hash": "klCBOCrKzaFo8vBwVqj4jEejIOX0mAmNBZvyAP0wI6M=" + "hash": "Zytw8T8IweIPstWrdUZcPABtmgF7AomXCXgDazN8ynQ=" } }, "is_incremental": false, @@ -5814,7 +5814,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.PageTranslationOptions.html", - "hash": "WQB7v3Iy3gQGiEJ/1cnOFmNemUX9bWvhmgOquLwH33s=" + "hash": "uwA5vJfRKk++fww50rzqwaNPcrv0wo74y1Gw08ZiJss=" } }, "is_incremental": false, @@ -5838,7 +5838,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.PreviewOptions.html", - "hash": "v8hzHm9gXipJnGWfKXicIXm5DYb57hjx112ppjion5A=" + "hash": "qu7VOtIxkGttNv/RWKLmNRyWXcU8FQjMnpyBqLXPky8=" } }, "is_incremental": false, @@ -5874,7 +5874,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.QuickView.html", - "hash": "WOKCSVNhGCc1ecmyal5W+rq0XL/qB5jURz6ktTjzQTY=" + "hash": "ZXpq8fA8/ixKbxpOGS/zz3lDIH/0XHlx8JdjuFhYep4=" } }, "is_incremental": false, @@ -5886,7 +5886,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.QuickViewAction.html", - "hash": "OX2KOesRLepTJsA7IcoKXjXEq97x3uUTJJgty7MNba0=" + "hash": "WrqK58Uu+AjWu3tpSESOGRLWIEIrQD/+DMK8WIyH3Rc=" } }, "is_incremental": false, @@ -5898,7 +5898,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.QuickViewActionParameter.html", - "hash": "Xt+lhFkgJtTeyhEgGmNNKtMVWze9VaOXha7E+IGKDts=" + "hash": "t5TX3XPmz5YbbmYTarZAdOcN+5xzWsfvZtjVPv4agHU=" } }, "is_incremental": false, @@ -5946,7 +5946,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.RecycleBinQueryOptions.html", - "hash": "OHFxSzb1GvGoLqRnykdf79Fw/cniRyBrgD1yp4hUzfM=" + "hash": "ia0Bul6PHIFaBnZrQQkYVohaBxrbI0bYzsi49nsJ/PY=" } }, "is_incremental": false, @@ -5970,7 +5970,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.RenderListDataOptions.html", - "hash": "etnVnNfq6gtkb4yinJOlgeLfDek48yg4kZS0kKE5F1Q=" + "hash": "YAn0rvUBzhRpvuIps6XCVGFhpq6O02D9CedyZq/wYig=" } }, "is_incremental": false, @@ -6054,7 +6054,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.SearchOptions.html", - "hash": "FuxQuC+m78lkeMLBuxFTJcm04aZhdaIdo89T/SwCPBI=" + "hash": "u0bjk9vNdhzTyviNIlyG19kXQFJZPeEG2wtRjoVRPSo=" } }, "is_incremental": false, @@ -6174,7 +6174,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.SortOption.html", - "hash": "5SyyErAFIJJTxlNxhd4bKIIGYYuXRVIzRmhuX4RMpPw=" + "hash": "f63cR/HY0cEEvxZuR1uqx+/kllYbDxX/RyawjQZ513o=" } }, "is_incremental": false, @@ -6186,7 +6186,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.SyntexModelPublishOptions.html", - "hash": "aQOA93hosiETXPyccjOr74gx2Zdbw/MWYzZbOJMBWdY=" + "hash": "cb6W8mqgj4wLlEou7Ms6avRnTjbXE7MT3PswizLrluA=" } }, "is_incremental": false, @@ -6198,7 +6198,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.SyntexModelUnPublishOptions.html", - "hash": "1hiqqrXXSZ3yEhmmG0a25Bpx0b5/Lwt4xfn/1jD5imc=" + "hash": "5NP5GdZdJAWD6iR/NI+Gi8CcwqGB7Pm/IJjE8e6elQU=" } }, "is_incremental": false, @@ -6210,7 +6210,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.TeamsACE.html", - "hash": "gWeD1hmB7/sDsJozycn/T8WaqoY3N50qkHFI/ThiXjk=" + "hash": "ds+4wYhwjVFMPAnC1feWz0OEvUmr0todPR0yis2Y9hU=" } }, "is_incremental": false, @@ -6222,7 +6222,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.TeamsACEApp.html", - "hash": "vou0BXSMr6zz2+opTjGgSyX6IBcsyeUHJF36C2MeqoM=" + "hash": "jvpC7qOMcSwulL43IEBQ2Fhv67VwbmkOBdL+KUx1nB4=" } }, "is_incremental": false, @@ -6234,7 +6234,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.TeamsACEAppIconProperties.html", - "hash": "zoEigqgixWUFqWIug6t87igGTH//ew6VkOIFZtb9Mxw=" + "hash": "BGUt3P1qNpgmkcx8XzWwdWbEsewBybGtvJd32PqQDVs=" } }, "is_incremental": false, @@ -6246,7 +6246,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.TeamsACEFactory.html", - "hash": "c2FP3XzJZ4WnMDpMDC26jjcFGgG4syOvdqgn4uHwawE=" + "hash": "lMkuXp623LQUzUjFp6IQljqCnShBYnp8FIY1y1ZssLs=" } }, "is_incremental": false, @@ -6258,7 +6258,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.TeamsACEProperties.html", - "hash": "w27TeRf1ronWxbsU9WNr4rp0baJYUWj3c3tQBJsssrQ=" + "hash": "qACn3oOASpS/ddRu1b1HkQtsh536R8SPGPeRFbUxigA=" } }, "is_incremental": false, @@ -6306,7 +6306,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ThumbnailOptions.html", - "hash": "y+dtKUNzS7vSq22RKrZdsdeUX5Qjt0kf6R3EdbpMs+U=" + "hash": "Ix7HcC8cYKOnUt2AKlAsUOKCcVjQQOoooXwHRe8K6IE=" } }, "is_incremental": false, @@ -6342,7 +6342,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.UnfurlOptions.html", - "hash": "1yXyndW7HEPGjb9yhTTA8Jo7yqmcJEG5Hkt+fEYSp9c=" + "hash": "PCE8/t6GWxpFyqPY5hKxmBfOqqVTH1O0lhTBUVAFoGw=" } }, "is_incremental": false, @@ -6402,7 +6402,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.ViewOptions.html", - "hash": "TzMVuyL7UYp8TTChko72Xnet0igAAbWSrF3rv+njdJM=" + "hash": "ZRYemN3PwXFOuSne6UfVe7UExnZBiNClF+ZPcAGCVfw=" } }, "is_incremental": false, @@ -6462,7 +6462,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.WebOptions.html", - "hash": "gh+O+x/xjbGiLTz+2Y2Yt1tgeREkaMjIzlMDIy13hZ4=" + "hash": "su2Vn4w4GQCjfC9gJkwA05V5h0DA/xmkiN4mt8lyb+M=" } }, "is_incremental": false, @@ -6486,7 +6486,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.ChatMessageAttachmentOptions.html", - "hash": "ICqMQ/hbtEsPkKRiGb9NFDB5W26qmAYpx/4uTjzJCaA=" + "hash": "l8Z6VZvRRXqLB9/mCmMtOgtc6QKi397WD8QAbN9z0Bc=" } }, "is_incremental": false, @@ -6510,7 +6510,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.ChatMessageHostedContentOptions.html", - "hash": "Yh2cqahv/yeLjvhseSXZchsXwcH75+rHffsVHd0MgPo=" + "hash": "oJgMSQz8ClzzJa+gYDXhF1T9jcRJLxqJP6N7zTcjrr8=" } }, "is_incremental": false, @@ -6534,7 +6534,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.ChatMessageMentionOptions.html", - "hash": "0C0yOvY61r79+9qjOtZJWR9gl0Vrm197XHYIYeNG0Oc=" + "hash": "ahMz6qJ1RBpoKP78a4pC4N9Z5/7CdzXQO2q9Mf8pXvQ=" } }, "is_incremental": false, @@ -6546,7 +6546,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.ChatMessageOptions.html", - "hash": "kNTGOqRTywlZMNFNBsQ7Hj4iZTKbSezprp3Q7VIjbc8=" + "hash": "UXd9WNW2T2OFe1I+CGgsREjZ5e1l42WezBpHTHtt9jQ=" } }, "is_incremental": false, @@ -6582,7 +6582,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.EventAddressOptions.html", - "hash": "TlEeaW2D7298hxGO1V5bzBoybAhu55WjJazDOIJE4WY=" + "hash": "Rq/GHbIzeT71mcOkKzRqdTTtpAgQIYV362JbLkB+E6g=" } }, "is_incremental": false, @@ -6594,7 +6594,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.EventAttendeeOptions.html", - "hash": "/wF5cCYGguaAzHybknEl5Vs3Sk79yi9MNHq86hS3xtE=" + "hash": "WY0mOYbcoCrt+87LFgkAlqoUa3UtT5u5PioZ1eCsHZ8=" } }, "is_incremental": false, @@ -6630,7 +6630,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.EventCoordinateOptions.html", - "hash": "ieuMNbuBuWM9EMy++bnpQNQ+YMqX2OFfGP5qYEGOEqo=" + "hash": "ItcdS6v9/40S22Dw/gEiXw/Pl8JuizAdCi06YbrmTY8=" } }, "is_incremental": false, @@ -6642,7 +6642,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.EventCreateOptions.html", - "hash": "cuHkImetXFhIQvHGphrIzJBCdCjwgSbVhVxhDt6JnRw=" + "hash": "YTA2+d44ONbZCGd8zAX1mwwgsxGMD02dj5M16Bnvrxs=" } }, "is_incremental": false, @@ -6666,7 +6666,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.EventLocationOptions.html", - "hash": "J4XsS7qGc/b7bb4v/0OLce/4GJ81HVidJQrBfZvpZqs=" + "hash": "88vcG3Bjbam9Q7iFo1Dum1OhrNvw+FrdzM3cXmcsN/s=" } }, "is_incremental": false, @@ -6714,7 +6714,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.EventRecipientOptions.html", - "hash": "DeVkuIObj/Ei6XjcuM/RBdyk6cIi7QOuzesbJ6Sj2gg=" + "hash": "R4BN4TNESzFbIlTqXQ+sccfbRYQiFUPhMCrMReogRfo=" } }, "is_incremental": false, @@ -6726,7 +6726,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.EventRecurrenceOptions.html", - "hash": "JR5U34MEGGGw//DEQPXD74lCoU0P4IF20ELtqxzzE64=" + "hash": "niaZJCNN+Dk9s0uj4fFu1B9l21Y4L3gftu5ygPEtpns=" } }, "is_incremental": false, @@ -6738,7 +6738,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.EventRecurrencePatternOptions.html", - "hash": "VngTBoAv8bxie72onzbl0tEoVypMaN0R7dUnDk/3u2A=" + "hash": "e2/CgKiU6lwXPqzOD4K2UD1OIJxHD/duVM0MBgWpRo4=" } }, "is_incremental": false, @@ -6750,7 +6750,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.EventRecurrenceRangeOptions.html", - "hash": "k4N5nHhEOlqjf1VgIX26SU6/oMFnZlLqZ+zYYtD3Bk0=" + "hash": "YQ7GMubPhIMFV6t53eXFPyUk9lKT9dJqiR8Bu35ua0o=" } }, "is_incremental": false, @@ -6846,7 +6846,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.EventUpdateOptions.html", - "hash": "SF5F5/3XO7TGkH7b3cdbagl7+HpnkFt/LjkUWVMmyrY=" + "hash": "ahJAiw6s9oBiwEc7I/QQIRrPRPwNDzbTHTUazi0KL0g=" } }, "is_incremental": false, @@ -7170,7 +7170,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.ITeamChannel.html", - "hash": "wLJiCqZKOkX6L0RPw/TloxYnPXyxsYww8LxTv1FMaZw=" + "hash": "ckaBj73nDigVOwUHpT60WI4vnN6n8oUpQQbjFUYsVUE=" } }, "is_incremental": false, @@ -7182,7 +7182,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.ITeamChannelCollection.html", - "hash": "PYXFR6sY+9SWSHAVRbN1yQ4VRTsOy6p13bkKOEXy0vA=" + "hash": "RyZP8poLxViv7XWux+wfq2QB8WesG3sDj+10f+hYqe8=" } }, "is_incremental": false, @@ -7578,7 +7578,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.TeamChannelOptions.html", - "hash": "7jBkzzKzjIlHTr5QJe0zHYnDVVPiZCG5w/0HelkLr2w=" + "hash": "e9x3rOXvB4yvNkquP0g2OY2c0oUKA50YSqwBwfL1UHI=" } }, "is_incremental": false, @@ -7590,7 +7590,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.TeamChannelTabConstants.html", - "hash": "yt/Q+bLboOw31drrQLGBa1EzDC6Ax052/EKbQeMDlKE=" + "hash": "qKqHdjwDnQg0HDrEZ6+BcU6vtx2dM17/b75uxUACTN8=" } }, "is_incremental": false, @@ -7638,7 +7638,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.TeamTagOptions.html", - "hash": "DD15bL+lpgAm6AqkfYZTrb5PZEdNjTEL/eBfAvv7v7I=" + "hash": "O6Um7KWiTCTGJNVxQrxMK3EoYhAhpZCEQq2b5l6aS8w=" } }, "is_incremental": false, @@ -7662,7 +7662,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.TeamTagUserOptions.html", - "hash": "YWjmZizqfNE18m7gpy31x586vcP9HdlRtLP7kzf+1gQ=" + "hash": "B4R+qKzIIStSgvLIQ8UFeqEulUJIAF7eZo3430UPHT4=" } }, "is_incremental": false, @@ -7722,7 +7722,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.TransientDictionary.html", - "hash": "AB/S49B/44cFiHJZmLDa++jsY7heWcZmdfTfJgzg06I=" + "hash": "w7rHRCVyNvTPlP2bUwpP9+o3zuCfjiy7Np8iZCDYhlc=" } }, "is_incremental": false, @@ -7746,7 +7746,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.PnPException.html", - "hash": "4gU05HzHpD+zXVJ2UstsJpLp70GKk0AnNwhRiVBkrTA=" + "hash": "FRyD0672/ye6TZARCbCBvafw+D6+B+OzgjkTxWx7kIM=" } }, "is_incremental": false, @@ -7758,7 +7758,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.QueryModel.BaseDataModelExtensions.html", - "hash": "LrChjM9ZvaDZxsZOnnHiBnAoia2XgnGP3DNd1S7FAI0=" + "hash": "F5S5Y7DwGWz7Cg/Kolmq8UPk0DP20/3fRpmmyFuI0d4=" } }, "is_incremental": false, @@ -7770,7 +7770,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.QueryModel.BaseQueryProvider.html", - "hash": "GmBLstYKG+4kLiSvXcOcN1WVCk07BoFOfxSnu1kJZ10=" + "hash": "ckUfEnk7wQdpToylusMl2WiBkmqgTLLsL+aq9OTqVcw=" } }, "is_incremental": false, @@ -7782,7 +7782,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.QueryModel.FilterItem.html", - "hash": "t7+/2kg9RoeljdlGsadHZ7rQ219tWPVMzL5LS15u4yA=" + "hash": "vlrqVU2bakxau/2JYjpvu8Ac7na32GSKy+BpenNxxYA=" } }, "is_incremental": false, @@ -7818,7 +7818,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.QueryModel.FiltersGroup.html", - "hash": "VeiKq5hcwsFF1tMBmdf2zUEmJJ1U717XyRmDBMlEjNE=" + "hash": "5tI7thrMjepmGE5CWJZSfeB19EGMscG3epZK4/WUPtI=" } }, "is_incremental": false, @@ -7842,7 +7842,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.QueryModel.ODataFilter.html", - "hash": "Xb36SUZc4ZW2tpyCG7s6tD13J1ClXSeuu2PayWEq/xs=" + "hash": "qZJ4pbILn85luUEX5jyzSkb7xdZckUQBf69Aki0e6Xs=" } }, "is_incremental": false, @@ -7878,7 +7878,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.QueryModel.OrderByItem.html", - "hash": "jLeW6nkxVg8hMKLm2tQaiyG7LXxOoUanrphdozyGsgU=" + "hash": "pL60gcQ2RFwk5G7fLwMNxYl9aTReJe3xuqGmOr/5zbM=" } }, "is_incremental": false, @@ -7890,7 +7890,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.QueryModel.QueryableExtensions.html", - "hash": "ShugcDZtQ/Wfk1hXXMA+E7Q/vEncLC8QTLGe5xwcFwU=" + "hash": "cobhSslQM1gRxxcyhyQh+qOv0M15pTN27cEaXqr5+mE=" } }, "is_incremental": false, @@ -7914,7 +7914,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.ServiceError.html", - "hash": "dnw6S70EUADNmdodS/nG16QaTGZODuweEswox10fUqo=" + "hash": "11my24FPsheMqqDqbwNvrqyo7D/RJp01bcgLWxo9hq4=" } }, "is_incremental": false, @@ -7926,7 +7926,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.ServiceException.html", - "hash": "2yDtYGqMmVNgZ+/G4NELQQMtwP0qeAw6YgIqWbP5sFA=" + "hash": "ucs2YT3NdYWdqqL/WrCCrkj0YLYjSfTt9ABCQ9Batr4=" } }, "is_incremental": false, @@ -7938,7 +7938,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.ApiRequest.html", - "hash": "5+msz0hNATKe0uYcTtKrB7SLLbXCUVRCptFXF16mUQI=" + "hash": "r96cLSwuLtVexJQ0c/uI8AfRiWsC0iO94B82QswxiJQ=" } }, "is_incremental": false, @@ -7950,7 +7950,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.ApiRequestResponse.html", - "hash": "2yh8iwe/VQ8glPpqdXD85KalYYVykIuYJCKl/2nIpmE=" + "hash": "0VDX18LlcLbpL88GlJt2cYJlyc+XPBxmE/2BLnFJ3F0=" } }, "is_incremental": false, @@ -7986,7 +7986,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.Batch.html", - "hash": "6p9/XYATYfy7r0E+plICL6W8W8/rc1fbcGBCY8fZSYc=" + "hash": "++Tqrxu1BFB6YdEn9c51yExt5FYU5LFFVHuWQUPp9o4=" } }, "is_incremental": false, @@ -7998,7 +7998,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.BatchRequest.html", - "hash": "9seQgOlyZgkBUncHIHJcw0LEPOW5IMEKHlTzx6v/ehA=" + "hash": "wy4Gt7v7auiIjBi97PRNckH6rEKzXLVq6o7cIhZi+ME=" } }, "is_incremental": false, @@ -8010,7 +8010,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.BatchResult.html", - "hash": "Rzsl/IOjsO8BxjK8I/WXdU0PXf8iCrtswqs9dVwBSqs=" + "hash": "qBtPX2ZeGJM5NiyXERLsawelC+s35FnMrJm6f6qjjjQ=" } }, "is_incremental": false, @@ -8022,7 +8022,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.BatchResultValue-1.html", - "hash": "tEybPFU29Pf5sWJTUjSP/I+f9C5rRCftHXSVyKNchV8=" + "hash": "vyF7AFkJV3703z1uWwikvGLdAETUWrw5nHoNT1OZzfw=" } }, "is_incremental": false, @@ -8034,7 +8034,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.Builder.Configuration.PnPCoreContextOptions.html", - "hash": "QpgYPmiC6ZqJhDPklVHjm83AI5TsHvyKjWtZDsgPBa8=" + "hash": "jDhEKAAPOSiApYdDjVaP0skzA2s2jvRHnzSZpxJef38=" } }, "is_incremental": false, @@ -8046,7 +8046,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsAzureActiveDirectoryOptions.html", - "hash": "dEVvYU4sSkQtawSca1dHgS0BUzhsM9/KaFH7X5q/1MI=" + "hash": "jY1gt2G0cVYokcbEApIVEYx/7A02Ib90Yj5puMFEcCA=" } }, "is_incremental": false, @@ -8058,7 +8058,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsGraphOptions.html", - "hash": "ROfwILL53szKq9bdCqx3W2VXGfywpeio7gSrqVTvqaA=" + "hash": "Wa4J2/qi1kv2Sz0fbRqOGo4MObLGpauUYTNL0AUIdjg=" } }, "is_incremental": false, @@ -8070,7 +8070,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsOptions.html", - "hash": "jUhsMI+u21onNdzWOnvj2JmFo9Id2Z0o8j2iwU6+YIs=" + "hash": "b9uJ7TfKSxRQtD0vaZobQOAXIeaMqLiZh9of1w/Jlyo=" } }, "is_incremental": false, @@ -8082,7 +8082,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.Builder.Configuration.PnPCoreHttpRequestsSharePointRestOptions.html", - "hash": "+dL0UPeO2z/+mUcXcMMFKwkTgturLxjqq3tdCTxfJBc=" + "hash": "h35k+mN0XBiyuF6eyClMGSywDE/7bGnul8+pBrbQIOc=" } }, "is_incremental": false, @@ -8094,7 +8094,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.Builder.Configuration.PnPCoreOptions.html", - "hash": "3QEZ9xFB3BU2FtvadxJ6fYSsfpbKm0VUEUhfTkAzQPo=" + "hash": "2bWRMItmtt/Tk1RnaKmBAU0sSaTAjxXLZrn98gtOwZo=" } }, "is_incremental": false, @@ -8106,7 +8106,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.Builder.Configuration.PnPCoreSiteOptions.html", - "hash": "3QraLvjPtRGnVEVXy/AXsNexw2OsFcgfgsoCQQv2Yfc=" + "hash": "noeX349EO35Sd1CXPDces2qiaX0PaBkKkIW9tgsJEpc=" } }, "is_incremental": false, @@ -8118,7 +8118,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.Builder.Configuration.PnPCoreSitesOptions.html", - "hash": "wvkB4lhuWjkNfv5UIXzu6z4ZGexGs9dDK6V3J4lEnfg=" + "hash": "Ph/QD6LblwCdTbqh0sCxs15aFA6+en4CksossXT/+58=" } }, "is_incremental": false, @@ -8154,7 +8154,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.Builder.PnPCoreBuilder.html", - "hash": "upMt3Onj1/xGifmN2cszcSxAnJvx/yL9N6eEaXup728=" + "hash": "rxUnsUaOlJ/KsZsKLDD7C2XMbfYtZqT8+edarAjIUc4=" } }, "is_incremental": false, @@ -8190,7 +8190,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.EventHub.html", - "hash": "XmhqVxgsZSVd++ljueg1xonMT/rKghGOAFj4eJUIDC0=" + "hash": "eXJ1pR+m7C4wg5BfL1YPsxvedjQ/kUrD5yAqzU4Imho=" } }, "is_incremental": false, @@ -8202,7 +8202,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.FromJson.html", - "hash": "eb8DmZ9N+6WXAEban05C1WQDH8RQFLkCYApp88EY2NA=" + "hash": "8pWNt8Up3I+wKYb/nxefk1zZLG+hcjxAR6dImY8SwQY=" } }, "is_incremental": false, @@ -8238,7 +8238,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.IPnPContext.html", - "hash": "wrlv/T66B4zr1jY8XQLM5Na4kihVuy6+hmx4LfZeY64=" + "hash": "8LRwSvCv0ysJMus+pmSv15dY5PcezUu6xZWOAQ+oHeM=" } }, "is_incremental": false, @@ -8262,7 +8262,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.IPnPContextExtensionsImplementation.html", - "hash": "rHqFNJlWC1fGJnFQeUG4mMlfParQMaP8oeiekI4qja0=" + "hash": "BrURbjSZ8r/XhpLw3M+ffl20dhpckoJ4GtEweuv7RnA=" } }, "is_incremental": false, @@ -8286,7 +8286,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.IRateLimitEvent.html", - "hash": "MOYw2CKf8aVnEaz4ESJweJ5b6sILyk6waZjvz+luM1c=" + "hash": "0HM3f9DRO2E5OAZIpyVPAw3xDKUFgtVAld+gfdUndpk=" } }, "is_incremental": false, @@ -8298,7 +8298,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.IRetryEvent.html", - "hash": "xPWiFsoHS/h2c3N5LtP98t/1nOH1sTp798ewhAqiyjc=" + "hash": "ZfhMyeggaMpWCV0szfeckgvhtEO5xep26jTNKSwAqJo=" } }, "is_incremental": false, @@ -8322,7 +8322,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.MicrosoftGraphClient.html", - "hash": "4GbMHyVhg97f7+z5Eio7kv/m9Mp+darW89J9ioNEJGo=" + "hash": "WU/O3m9fwu2B0+Y/QtWGEw3cW5dgeCiN+8HETPGAhWA=" } }, "is_incremental": false, @@ -8334,7 +8334,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.PnPContext.html", - "hash": "weP3YRklnbGoewyoQBHnffZgYXif4c/tu5asG7CfTqI=" + "hash": "/TaJ4q4sjSHmnPgj3UZZ0sRdNySXueS8/HPzlEJ+958=" } }, "is_incremental": false, @@ -8346,7 +8346,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.PnPContextExtensions.html", - "hash": "RR2QtRdL7d9pYAf4Vkbiw3MoW1IF02xzt/6ShlC5AA0=" + "hash": "hoNS/9cFE2gFBVfHkHmr8xBIYP+E+s0KP0896SOhR20=" } }, "is_incremental": false, @@ -8358,7 +8358,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.PnPContextFactory.html", - "hash": "rKOVUWlpgulvH/HB9qqLboACE+ehnQKLCQN2pVB91cg=" + "hash": "pNpTe50s5bf+DVwb3wecVTW8sxukMJaeh5jI+Rs/QaM=" } }, "is_incremental": false, @@ -8370,7 +8370,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.PnPContextFactoryCollectionExtensions.html", - "hash": "WIkn0CJll8NaFhWjTyBpODusHFOT7pb3IyeuGvYzTDA=" + "hash": "L6gqi4PXl/1eZJooy4t3ns4ZEah3Hzewd/djfSkYfIc=" } }, "is_incremental": false, @@ -8382,7 +8382,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.PnPContextFactoryOptions.html", - "hash": "6wLGbBmhKyhA04kevQfYZoMqJgSgAXr77KOLW1jmnzA=" + "hash": "ZBdi711UpNnCpWFVbfXlSajslPNULrKyPkkWPoip+84=" } }, "is_incremental": false, @@ -8394,7 +8394,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.PnPContextFactoryOptionsConfiguration.html", - "hash": "vCTHC2pQIeHiQxqW6m2XisAL8/vGBWViNhWjqQfUPQI=" + "hash": "AF97lBkVNaU3/xU1c+UqZ+IIjXl1rvUi1AG0i5mwoms=" } }, "is_incremental": false, @@ -8406,7 +8406,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.PnPContextOptions.html", - "hash": "pSwXO9HiTLZ28m/yYYF7CtnoOKw6alhEaQp9y1wST44=" + "hash": "CZS/OHBUMNnf7auIaq8bfH1cxlOBI0bjNPcLwRUacc4=" } }, "is_incremental": false, @@ -8418,7 +8418,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.PnPGlobalSettingsOptions.html", - "hash": "GkxzNQp4nAxO4yaYVxZ2wgBbSgo0k14yGzKDvbw10Tc=" + "hash": "G3bR92RfMzSLbuUFqGozyAKZmB4aAOIawdtgrGCoL1k=" } }, "is_incremental": false, @@ -8430,7 +8430,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.RateLimitEvent.html", - "hash": "SH9RHxuV1gji6r0kDe4HDE8NuEILpktqFkV/g49viJo=" + "hash": "46710RyZeaQiIUwvas9zIuxGW+yzcPCJ4Zv6vC5McY8=" } }, "is_incremental": false, @@ -8442,7 +8442,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.RetryEvent.html", - "hash": "DOwAi30oe5IK7mgwOrTSEh1spCF3VieoWVVlRtRrPv8=" + "hash": "IqX16RqlTIdo4UC4WWn468eM4zuu+bWZZtV5/IR/4WI=" } }, "is_incremental": false, @@ -8454,7 +8454,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Services.SharePointRestClient.html", - "hash": "9lfj7/N47nNORgjdfW6exH83L238y/PT34aqHrKZTkc=" + "hash": "pJpCjOGL3Ht6SuVfv4d8MNkCrXvoFMiqlOU4D7pLnv4=" } }, "is_incremental": false, @@ -8478,7 +8478,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.SharePointRestError.html", - "hash": "4Kvg+Uu/Pb3GUWhBmVY7DiB9gv3mL8H5HXclANY6L9o=" + "hash": "iViSWEswwC+eaYO5+Wj6N3P+DYr7VZZa4XmdkLrmrWM=" } }, "is_incremental": false, @@ -8490,7 +8490,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.SharePointRestServiceException.html", - "hash": "k9lGdCE4OFVk2mSTb4CVxju4DG78A0g64ZDxYJwpc+g=" + "hash": "caJsNJx8nN56p1rxxfvSerL5tcnhFBkN2DtZcbv1Q4w=" } }, "is_incremental": false,

- IDictionary<String, Object> + IDictionary<String, System.Object>