Class that deals with cloning client context object, getting access token and validates server version
public static class ClientContextExtensions : objectChecks if an alias is already used for an office 365 group or not
public static async Task<bool> AliasExistsAsync(this ClientContext clientContext, string alias)|
Client ClientContext of the site to operate against |
|
System. Alias to verify |
|
Task<System. True if in use, false otherwise |
Clones a ClientContext object while "taking over" the security context of the existing ClientContext instance
public static ClientContext Clone(this ClientRuntimeContext clientContext, string siteUrl, Dictionary<string, string> accessTokens = null)|
Client ClientContext to be cloned |
|
System. Site URL to be used for cloned ClientContext |
|
Dictionary<System. Dictionary of access tokens for sites URLs |
|
Client A ClientContext object created for the passed site URL |
Clones a ClientContext object while "taking over" the security context of the existing ClientContext instance
public static ClientContext Clone(this ClientRuntimeContext clientContext, Uri siteUrl, Dictionary<string, string> accessTokens = null)|
Client ClientContext to be cloned |
|
Uri
siteUrl
Site URL to be used for cloned ClientContext |
|
Dictionary<System. Dictionary of access tokens for sites URLs |
|
Client A ClientContext object created for the passed site URL |
BETA: Creates a Communication Site Collection
public static async Task<ClientContext> CreateSiteAsync(this ClientContext clientContext, CommunicationSiteCollectionCreationInformation siteCollectionCreationInformation)|
Client
|
|
Communication
|
|
Task<Client
|
BETA: Creates a Team Site Collection with no group
public static async Task<ClientContext> CreateSiteAsync(this ClientContext clientContext, TeamNoGroupSiteCollectionCreationInformation siteCollectionCreationInformation)|
Client
|
|
Team
|
|
Task<Client
|
BETA: Creates a Team Site Collection
public static async Task<ClientContext> CreateSiteAsync(this ClientContext clientContext, TeamSiteCollectionCreationInformation siteCollectionCreationInformation)|
Client
|
|
Team
|
|
Task<Client
|
Deletes a Communication site or a group-less Modern team site
public static async Task<bool> DeleteSiteAsync(this ClientContext clientContext)|
Client
|
|
Task<System.
|
Executes the current set of data retrieval queries and method invocations and retries it if needed.
public static void ExecuteQueryRetry(this ClientRuntimeContext clientContext, int retryCount = 10, string userAgent = null)|
Client clientContext to operate on |
|
System. Number of times to retry the request |
|
System. UserAgent string value to insert for this request. You can define this value in your app's config file using key="SharePointPnPUserAgent" value="PnPRocks"> |
Executes the current set of data retrieval queries and method invocations and retries it if needed using the Task Library.
public static Task ExecuteQueryRetryAsync(this ClientRuntimeContext clientContext, int retryCount = 10, string userAgent = null)|
Client clientContext to operate on |
|
System. Number of times to retry the request |
|
System. UserAgent string value to insert for this request. You can define this value in your app's config file using key="SharePointPnPUserAgent" value="PnPRocks"> |
|
Task
|
Gets an access token from a
public static string GetAccessToken(this ClientRuntimeContext clientContext)|
Client |
|
System. Access token for the given |
public static async Task<string> GetRequestDigestAsync(this ClientContext context)|
Client
|
|
Task<System.
|
Returns the request digest from the current session/site given cookie based auth
public static async Task<string> GetRequestDigestAsync(this ClientContext context, CookieContainer cookieContainer)|
Client
|
|
Cookie A cookiecontainer containing FedAuth cookies |
|
Task<System.
|
Gets a site collection context for the passed web. This site collection client context uses the same credentials as the passed client context
public static ClientContext GetSiteCollectionContext(this ClientRuntimeContext clientContext)|
Client Client context to take the credentials from |
|
Client A site collection client context object for the site collection |
BETA: Groupifies a classic Team Site Collection
public static async Task<ClientContext> GroupifySiteAsync(this ClientContext clientContext, TeamSiteCollectionGroupifyInformation siteCollectionGroupifyInformation)|
Client ClientContext instance of the site to be groupified |
|
Team Information needed to groupify this site |
|
Task<Client The clientcontext of the groupified site |
Checks the server library version of the context for a minimally required version
public static bool HasMinimalServerLibraryVersion(this ClientRuntimeContext clientContext, string minimallyRequiredVersion)|
Client clientContext to operate on |
|
System. provide version to validate |
|
System. True if it has minimal required version, false otherwise |
Checks the server library version of the context for a minimally required version
public static bool HasMinimalServerLibraryVersion(this ClientRuntimeContext clientContext, Version minimallyRequiredVersion)|
Client clientContext to operate on |
|
Version
minimallyRequiredVersion
provide version to validate |
|
System. True if it has minimal required version, false otherwise |
Hide the teamify prompt displayed in O365 group connected sites
public static async Task<bool> HideTeamifyPromptAsync(this ClientContext clientContext)|
Client ClientContext of the site to operate against |
|
Task<System.
|
Checks if the used ClientContext is app-only
public static bool IsAppOnly(this ClientRuntimeContext clientContext)|
Client The ClientContext to inspect |
|
System. True if app-only, false otherwise |
public static async Task<bool> IsTeamifyPromptHidden(this ClientContext clientContext)|
Client
|
|
Task<System.
|
Checks whether the teamify prompt is hidden in O365 Group connected sites
public static async Task<bool> IsTeamifyPromptHiddenAsync(this ClientContext clientContext)|
Client ClientContext of the site to operate against |
|
Task<System.
|
Returns the number of pending requests
public static int PendingRequestCount(this ClientRuntimeContext clientContext)|
Client Client context to check the pending requests for |
|
System. The number of pending requests |
Enable MS Teams team on a group connected team site
public static async Task<string> TeamifyAsync(this ClientContext clientContext, string graphAccessToken = null)|
Client
|
|
System.
|
|
Task<System.
|