Class PnPContext

PnP Context class...the glue between the model and the data stores

Inheritance
object
PnPContext
Inherited Members
Namespace: PnP.Core.Services
Assembly: PnP.Core.dll
Syntax
public class PnPContext : IPnPContext, IDisposable

Properties

AuthenticationProvider

Connected authentication provider

Declaration
public IAuthenticationProvider AuthenticationProvider { get; }
Property Value
IAuthenticationProvider

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
string

Implements

ContentTypeHub

Entry point for the ContentTypeHub object

Declaration
public IContentTypeHub ContentTypeHub { get; }
Property Value
IContentTypeHub

Implements

CurrentBatch

Current batch, used for implicit batching

Declaration
public Batch CurrentBatch { get; }
Property Value
Batch

Implements

Environment

Returns the used Microsoft 365 cloud environment

Declaration
public Microsoft365Environment? Environment { get; }
Property Value
Microsoft365Environment?

Implements

GraphAlwaysUseBeta

If true than all requests to Microsoft Graph use the beta endpoint

Declaration
public bool GraphAlwaysUseBeta { get; set; }
Property Value
bool

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
bool

Implements

GraphClient

Connected Microsoft Graph client

Declaration
public MicrosoftGraphClient GraphClient { get; }
Property Value
MicrosoftGraphClient

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
bool

Implements

Group

Entry point for the Microsoft 365 Group Object

Declaration
public IGraphGroup Group { get; }
Property Value
IGraphGroup

Implements

HasPendingRequests

Are there pending requests to execute (in the case of batching)

Declaration
public bool HasPendingRequests { get; }
Property Value
bool

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
IMe

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
string

Implements

Properties

Collection for custom properties that you want to attach to a PnPContext

Declaration
public IDictionary<string, object> Properties { get; }
Property Value
IDictionary<string, object>

Implements

RestClient

Connected SharePoint REST client

Declaration
public SharePointRestClient RestClient { get; }
Property Value
SharePointRestClient

Implements

Site

Entry point for the Site Object

Declaration
public ISite Site { get; }
Property Value
ISite

Implements

Social

Entry point for the social-related APIs

Declaration
public ISocial Social { get; }
Property Value
ISocial

Implements

Team

Entry point for the Team Object

Declaration
public ITeam Team { get; }
Property Value
ITeam

Implements

TermStore

Entry point for the Microsoft 365 TermStore

Declaration
public ITermStore TermStore { get; }
Property Value
ITermStore

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
IWeb

Implements

Methods

Clone()

Clones this context into a new context for the same SharePoint site

Declaration
public PnPContext Clone()
Returns
PnPContext

New PnPContext
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 PnPContext for
Returns
PnPContext

New PnPContext
Implements

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

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

CloneAsync()

Clones this context into a new context for the same SharePoint site

Declaration
public Task<PnPContext> CloneAsync()
Returns
Task<PnPContext>

New PnPContext
Implements

CloneAsync(Guid)

Clones this context for another SharePoint site

Declaration
public Task<PnPContext> CloneAsync(Guid groupId)
Parameters
Guid groupId

Id of the other Microsoft 365 group to create a PnPContext for
Returns
Task<PnPContext>

New PnPContext
Implements

CloneAsync(string)

Clones this context for another SharePoint site provided as configuration

Declaration
public Task<PnPContext> CloneAsync(string name)
Parameters
string name

The name of the SPOContext configuration to use
Returns
Task<PnPContext>

New PnPContext for the request config
Implements

CloneAsync(Uri)

Clones this context for another SharePoint site

Declaration
public Task<PnPContext> CloneAsync(Uri uri)
Parameters
Uri uri

Uri of the other SharePoint site
Returns
Task<PnPContext>

New PnPContext
Implements

Dispose()

Disposes this PnPContext

Declaration
public void Dispose()
Implements

Dispose(bool)

Disposes this PnPContext

Declaration
protected virtual void Dispose(bool disposing)
Parameters
bool disposing

Do we need to dispose resources

Execute(Batch, bool)

Method to execute a given batch

Declaration
public List<BatchResult> Execute(Batch batch, bool throwOnError = true)
Parameters
Batch batch

Batch to execute
bool throwOnError

Throw an exception on the first encountered error in the batch
Returns
List<BatchResult>

The asynchronous task that will be executed
Implements

Execute(bool)

Method to execute the current batch

Declaration
public List<BatchResult> Execute(bool throwOnError = true)
Parameters
bool throwOnError

Throw an exception on the first encountered error in the batch
Returns
List<BatchResult>

The asynchronous task that will be executed
Implements

ExecuteAsync(Batch, bool)

Method to execute a given batch

Declaration
public Task<List<BatchResult>> ExecuteAsync(Batch batch, bool throwOnError = true)
Parameters
Batch batch

Batch to execute
bool throwOnError

Throw an exception on the first encountered error in the batch
Returns
Task<List<BatchResult>>

The asynchronous task that will be executed
Implements

ExecuteAsync(bool)

Method to execute the current batch

Declaration
public Task<List<BatchResult>> ExecuteAsync(bool throwOnError = true)
Parameters
bool throwOnError

Throw an exception on the first encountered error in the batch
Returns
Task<List<BatchResult>>

The asynchronous task that will be executed
Implements

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

NewBatch()

Creates a new batch

Declaration
public Batch NewBatch()
Returns
Batch

Implements

Extension Methods