Class PnPContext
PnP Context class...the glue between the model and the data stores
Inheritance
Namespace: PnP.Core.Services
Assembly: PnP.Core.dll
Syntax
public class PnPContext : object, IPnPContextProperties
AuthenticationProvider
Connected authentication provider
Declaration
public IAuthenticationProvider AuthenticationProvider { get; }Property Value
Implements
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
|
System.
|
Implements
ContentTypeHub
Entry point for the ContentTypeHub object
Declaration
public IContentTypeHub ContentTypeHub { get; }Property Value
Implements
CurrentBatch
Current batch, used for implicit batching
Declaration
public Batch CurrentBatch { get; }Property Value
Implements
Environment
Returns the used Microsoft 365 cloud environment
Declaration
public Microsoft365Environment? Environment { get; }Property Value
|
System.
|
Implements
GraphAlwaysUseBeta
If true than all requests to Microsoft Graph use the beta endpoint
Declaration
public bool GraphAlwaysUseBeta { get; set; }Property Value
|
System.
|
Implements
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
|
System.
|
Implements
GraphClient
Connected Microsoft Graph client
Declaration
public MicrosoftGraphClient GraphClient { get; }Property Value
Implements
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
|
System.
|
Implements
Group
Entry point for the Microsoft 365 Group Object
Declaration
public IGraphGroup Group { get; }Property Value
Implements
HasPendingRequests
Are there pending requests to execute (in the case of batching)
Declaration
public bool HasPendingRequests { get; }Property Value
|
System.
|
Implements
Logger
Connected logger
Declaration
public ILogger Logger { get; }Property Value
|
ILogger
|
Implements
Me
Entry point for the Me object
Declaration
public IMe Me { get; }Property Value
Implements
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
|
System.
|
Implements
Properties
Collection for custom properties that you want to attach to a Pn
Declaration
public IDictionary<string, object> Properties { get; }Property Value
|
IDictionary<System.
|
Implements
RestClient
Connected SharePoint REST client
Declaration
public SharePointRestClient RestClient { get; }Property Value
Implements
Site
Entry point for the Site Object
Declaration
public ISite Site { get; }Property Value
Implements
Social
Entry point for the social-related APIs
Declaration
public ISocial Social { get; }Property Value
Implements
Team
Entry point for the Team Object
Declaration
public ITeam Team { get; }Property Value
Implements
TermStore
Entry point for the Microsoft 365 TermStore
Declaration
public ITermStore TermStore { get; }Property Value
Implements
Uri
Uri of the SharePoint site we're working against
Declaration
public Uri Uri { get; }Property Value
|
Uri
|
Implements
Web
Entry point for the Web Object
Declaration
public IWeb Web { get; }Property Value
Implements
Methods
Clone()
Clones this context into a new context for the same SharePoint site
Declaration
public PnPContext Clone()Returns
|
Pn New Pn |
Implements
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 Pn |
Returns
|
Pn New Pn |
Implements
Clone(String)
Clones this context for another SharePoint site provided as configuration
Declaration
public PnPContext Clone(string name)Parameters
|
System. The name of the SPOContext configuration to use |
Returns
|
Pn New Pn |
Implements
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
|
Pn New Pn |
Implements
CloneAsync()
Clones this context into a new context for the same SharePoint site
Declaration
public async Task<PnPContext> CloneAsync()Returns
|
Task<Pn New Pn |
Implements
CloneAsync(Guid)
Clones this context for another SharePoint site
Declaration
public async Task<PnPContext> CloneAsync(Guid groupId)Parameters
|
Guid
groupId
Id of the other Microsoft 365 group to create a Pn |
Returns
|
Task<Pn New Pn |
Implements
CloneAsync(String)
Clones this context for another SharePoint site provided as configuration
Declaration
public async Task<PnPContext> CloneAsync(string name)Parameters
|
System. The name of the SPOContext configuration to use |
Returns
|
Task<Pn New Pn |
Implements
CloneAsync(Uri)
Clones this context for another SharePoint site
Declaration
public async Task<PnPContext> CloneAsync(Uri uri)Parameters
|
Uri
uri
Uri of the other SharePoint site |
Returns
|
Task<Pn New Pn |
Implements
Dispose()
Dispose(Boolean)
Disposes this Pn
Declaration
protected virtual void Dispose(bool disposing)Parameters
|
System. Do we need to dispose resources |
Execute(Batch, Boolean)
Method to execute a given batch
Declaration
public List<BatchResult> Execute(Batch batch, bool throwOnError = true)Parameters
|
Batch
batch
Batch to execute |
|
System. Throw an exception on the first encountered error in the batch |
Returns
|
Pn The asynchronous task that will be executed |
Implements
Execute(Boolean)
Method to execute the current batch
Declaration
public List<BatchResult> Execute(bool throwOnError = true)Parameters
|
System. Throw an exception on the first encountered error in the batch |
Returns
|
Pn The asynchronous task that will be executed |
Implements
ExecuteAsync(Batch, Boolean)
Method to execute a given batch
Declaration
public async Task<List<BatchResult>> ExecuteAsync(Batch batch, bool throwOnError = true)Parameters
|
Batch
batch
Batch to execute |
|
System. Throw an exception on the first encountered error in the batch |
Returns
|
Task<Pn The asynchronous task that will be executed |
Implements
ExecuteAsync(Boolean)
Method to execute the current batch
Declaration
public async Task<List<BatchResult>> ExecuteAsync(bool throwOnError = true)Parameters
|
System. Throw an exception on the first encountered error in the batch |
Returns
|
Task<Pn The asynchronous task that will be executed |
Implements
GetLongRunningOperation(String)
Gets an ongoing Graph long-running operation.
Declaration
public ILongRunningOperation GetLongRunningOperation(string location)Parameters
|
System. The location of the operation |
Returns
|
ILong An ILong |
Implements
NewBatch()
Creates a new batch
Declaration
public Batch NewBatch()