Interface IAppOperations

Interface for base app operations, like Deploy, Install, etc.

Namespace: PnP.Core.Admin.Model.SharePoint

Assembly: PnP.Core.Admin.dll

Syntax

public interface IAppOperations

Methods

ApproveAsync(String)

Approves all permissions requested by the app.

Declaration

Task<IPermissionGrant2[]> ApproveAsync(string aadPermissions)

Parameters

System.String aadPermissions The requested AAD permissions, e.g.

Returns

Task<IPermissionGrant2[]>

Deploy(Guid, Boolean)

Deploys / trusts an app in the app catalog.

Declaration

bool Deploy(Guid id, bool skipFeatureDeployment = true)

Parameters

Guid id The unique id of the app. Notice that this is not the product id as listed in the app catalog.

System.Boolean skipFeatureDeployment If set to true will skip the feature deployment for tenant scoped apps.

Returns

System.Boolean true if deployment was successful.

DeployAsync(Guid, Boolean)

Deploys / trusts an app in the app catalog.

Declaration

Task<bool> DeployAsync(Guid id, bool skipFeatureDeployment = true)

Parameters

Guid id The unique id of the app. Notice that this is not the product id as listed in the app catalog.

System.Boolean skipFeatureDeployment If set to true will skip the feature deployment for tenant scoped apps.

Returns

Task<System.Boolean> true if deployment was successful.

Install(Guid)

Installs the app from the app catalog in a site.

Declaration

bool Install(Guid id)

Parameters

Guid id The unique id of the app. Notice that this is not the product id as listed in the app catalog.

Returns

System.Boolean true if installation was successful.

InstallAsync(Guid)

Installs the app from the app catalog in a site.

Declaration

Task<bool> InstallAsync(Guid id)

Parameters

Guid id The unique id of the app. Notice that this is not the product id as listed in the app catalog.

Returns

Task<System.Boolean> true if installation was successful.

Remove(Guid)

Removes the app from the app catalog.

Declaration

bool Remove(Guid id)

Parameters

Guid id The unique id of the app. Notice that this is not the product id as listed in the app catalog.

Returns

System.Boolean true if remove was successful.

RemoveAsync(Guid)

Removes the app from the app catalog.

Declaration

Task<bool> RemoveAsync(Guid id)

Parameters

Guid id The unique id of the app. Notice that this is not the product id as listed in the app catalog.

Returns

Task<System.Boolean> true if remove was successful.

Retract(Guid)

Retracts the app in the app catalog. Notice that this will not remove the app from the app catalog.

Declaration

bool Retract(Guid id)

Parameters

Guid id The unique id of the app. Notice that this is not the product id as listed in the app catalog.

Returns

System.Boolean true if retract was successful.

RetractAsync(Guid)

Retracts the app in the app catalog. Notice that this will not remove the app from the app catalog.

Declaration

Task<bool> RetractAsync(Guid id)

Parameters

Guid id The unique id of the app. Notice that this is not the product id as listed in the app catalog.

Returns

Task<System.Boolean> true if retract was successful.

Uninstall(Guid)

Uninstalls the app from a site.

Declaration

bool Uninstall(Guid id)

Parameters

Guid id The unique id of the app. Notice that this is not the product id as listed in the app catalog.

Returns

System.Boolean true if uninstall was successful.

UninstallAsync(Guid)

Uninstalls the app from a site.

Declaration

Task<bool> UninstallAsync(Guid id)

Parameters

Guid id The unique id of the app. Notice that this is not the product id as listed in the app catalog.

Returns

Task<System.Boolean> true if uninstall was successful.

Upgrade(Guid)

Upgrades the app in a site.

Declaration

bool Upgrade(Guid id)

Parameters

Guid id The unique id of the app. Notice that this is not the product id as listed in the app catalog.

Returns

System.Boolean true if upgrade was successful.

UpgradeAsync(Guid)

Upgrades the app in a site.

Declaration

Task<bool> UpgradeAsync(Guid id)

Parameters

Guid id The unique id of the app. Notice that this is not the product id as listed in the app catalog.

Returns

Task<System.Boolean> true if upgrade was successful.