Properties   AuthenticationProvider  AzureADLoginAuthority  ContentTypeHub  CurrentBatch  Environment  GraphAlwaysUseBeta  GraphCanUseBeta  GraphClient  GraphFirst  Group  HasPendingRequests  Logger  Me  MicrosoftGraphAuthority  Properties  RestClient  Site  Social  Team  TermStore  Uri  WebMethods   Clone()  Clone(Guid)  Clone(String)  Clone(Uri)  CloneAsync()  CloneAsync(Guid)  CloneAsync(String)  CloneAsync(Uri)  Execute(Batch, Boolean)  Execute(Boolean)  ExecuteAsync(Batch, Boolean)  ExecuteAsync(Boolean)  GetLongRunningOperation(String)  NewBatch()Extension Methods

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

System.String

ContentTypeHub

Entry point for the ContentTypeHub Object

Declaration

IContentTypeHub ContentTypeHub { get; }

Property Value

IContentTypeHub

CurrentBatch

Current batch, used for implicit batching

Declaration

Batch CurrentBatch { get; }

Property Value

Batch

Environment

Returns the used Microsoft 365 cloud environment

Declaration

Microsoft365Environment? Environment { get; }

Property Value

System.Nullable<Microsoft365Environment>

GraphAlwaysUseBeta

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

Declaration

bool GraphAlwaysUseBeta { get; set; }

Property Value

System.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

System.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

System.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

System.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

System.String

Properties

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

Declaration

IDictionary<string, object> Properties { get; }

Property Value

IDictionary<System.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

System.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<PnPContext> CloneAsync()

Returns

Task<PnPContext> New PnPContext

CloneAsync(Guid)

Clones this context for another SharePoint site

Declaration

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

CloneAsync(String)

Clones this context for another SharePoint site provided as configuration

Declaration

Task<PnPContext> CloneAsync(string name)

Parameters

System.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<PnPContext> 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<BatchResult> Execute(Batch batch, bool throwOnError = true)

Parameters

Batch batch Batch to execute

System.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<BatchResult> Execute(bool throwOnError = true)

Parameters

System.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<List<BatchResult>> ExecuteAsync(Batch batch, bool throwOnError = true)

Parameters

Batch batch Batch to execute

System.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<List<BatchResult>> ExecuteAsync(bool throwOnError = true)

Parameters

System.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

System.String location The location of the operation

Returns

ILongRunningOperation An ILongRunningOperation associated with the location

NewBatch()

Creates a new batch

Declaration

Batch NewBatch()

Returns

Batch A new Batch instance for batching.

Extension Methods

PnPContextExtensions.GetSharePointAdmin(IPnPContext)

PnPContextExtensions.GetSiteCollectionManager(IPnPContext)

PnPContextExtensions.GetTeamManager(IPnPContext)

PnPContextExtensions.GetTenantAppManager(IPnPContext)

PnPContextExtensions.GetSiteCollectionAppManager(IPnPContext)

PnPContextExtensions.GetMicrosoft365Admin(IPnPContext)