Class AppManager

Allows Application Lifecycle Management for Apps

Inheritance
System.Object
AppManager
Namespace: PnP.Framework.ALM
Assembly: PnP.Framework.dll
Syntax
public class AppManager : object

Constructors

AppManager(ClientContext)

Declaration
public AppManager(ClientContext context)
Parameters
ClientContext context

Methods

Add(Byte[], String, Boolean, AppCatalogScope, Int32)

Uploads a file to the Tenant App Catalog

Declaration
public AppMetadata Add(byte[] file, string filename, bool overwrite = false, AppCatalogScope scope = default(AppCatalogScope), int timeoutSeconds = 200)
Parameters
System.Byte[] file

A byte array containing the file
System.String filename

The filename (e.g. myapp.sppkg) of the file to upload
System.Boolean overwrite

If true will overwrite an existing entry
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
System.Int32 timeoutSeconds

If specified will set the timeout on the request. Defaults to 200 seconds.
Returns
AppMetadata

Add(String, Boolean, AppCatalogScope, Int32)

Uploads an app file to the Tenant App Catalog

Declaration
public AppMetadata Add(string path, bool overwrite = false, AppCatalogScope scope = default(AppCatalogScope), int timeoutSeconds = 200)
Parameters
System.String path

System.Boolean overwrite

If true will overwrite an existing entry
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
System.Int32 timeoutSeconds

If specified will set the timeout on the request. Defaults to 200 seconds.
Returns
AppMetadata

AddAsync(Byte[], String, Boolean, AppCatalogScope, Int32)

Uploads a file to the Tenant App Catalog

Declaration
public async Task<AppMetadata> AddAsync(byte[] file, string filename, bool overwrite = false, AppCatalogScope scope = default(AppCatalogScope), int timeoutSeconds = 200)
Parameters
System.Byte[] file

A byte array containing the file
System.String filename

The filename (e.g. myapp.sppkg) of the file to upload
System.Boolean overwrite

If true will overwrite an existing entry
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
System.Int32 timeoutSeconds

If specified will set the timeout on the request. Defaults to 200 seconds.
Returns
Task<AppMetadata>

AddAsync(String, Boolean, AppCatalogScope, Int32)

Uploads an app file to the Tenant App Catalog

Declaration
public async Task<AppMetadata> AddAsync(string path, bool overwrite = false, AppCatalogScope scope = default(AppCatalogScope), int timeoutSeconds = 200)
Parameters
System.String path

System.Boolean overwrite

If true will overwrite an existing entry
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
System.Int32 timeoutSeconds

If specified will set the timeout on the request. Defaults to 200 seconds.
Returns
Task<AppMetadata>

Deploy(Guid, Boolean, AppCatalogScope)

Deploys/trusts an app in the app catalog

Declaration
public bool Deploy(Guid id, bool skipFeatureDeployment = true, AppCatalogScope scope = default(AppCatalogScope))
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 deployed for tenant scoped apps.
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
System.Boolean

Deploy(AppMetadata, Boolean, AppCatalogScope)

Deploys/trusts an app in the app catalog

Declaration
public bool Deploy(AppMetadata appMetadata, bool skipFeatureDeployment = true, AppCatalogScope scope = default(AppCatalogScope))
Parameters
AppMetadata appMetadata

The app metadata object of the app to deploy.
System.Boolean skipFeatureDeployment

If set to true will skip the feature deployed for tenant scoped apps.
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
System.Boolean

DeployAsync(Guid, Boolean, AppCatalogScope)

Deploys/trusts an app in the app catalog

Declaration
public async Task<bool> DeployAsync(Guid id, bool skipFeatureDeployment = true, AppCatalogScope scope = default(AppCatalogScope))
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 deployed for tenant scoped apps.
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
Task<System.Boolean>

DeployAsync(AppMetadata, Boolean, AppCatalogScope)

Deploys/trusts an app in the app catalog

Declaration
public async Task<bool> DeployAsync(AppMetadata appMetadata, bool skipFeatureDeployment = true, AppCatalogScope scope = default(AppCatalogScope))
Parameters
AppMetadata appMetadata

The app metadata object of the app to deploy.
System.Boolean skipFeatureDeployment

If set to true will skip the feature deployed for tenant scoped apps.
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
Task<System.Boolean>

GetAvailable(Guid, AppCatalogScope)

Returns an available app

Declaration
public AppMetadata GetAvailable(Guid id, AppCatalogScope scope = default(AppCatalogScope))
Parameters
Guid id

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

Specifies the app catalog to work with. Defaults to Tenant
Returns
AppMetadata

GetAvailable(AppCatalogScope)

Returns all available apps.

Declaration
public List<AppMetadata> GetAvailable(AppCatalogScope scope = default(AppCatalogScope))
Parameters
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
List<AppMetadata>

GetAvailable(String, AppCatalogScope)

Returns an available app

Declaration
public AppMetadata GetAvailable(string title, AppCatalogScope scope = default(AppCatalogScope))
Parameters
System.String title

The title of the app.
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
AppMetadata

GetAvailableAsync(Guid, AppCatalogScope)

Returns an available app

Declaration
public async Task<AppMetadata> GetAvailableAsync(Guid id, AppCatalogScope scope = default(AppCatalogScope))
Parameters
Guid id

The id of the app
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
Task<AppMetadata>

GetAvailableAsync(AppCatalogScope)

Returns all available apps.

Declaration
public async Task<List<AppMetadata>> GetAvailableAsync(AppCatalogScope scope = default(AppCatalogScope))
Parameters
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
Task<List<AppMetadata>>

GetAvailableAsync(String, AppCatalogScope)

Returns an avialable app

Declaration
public async Task<AppMetadata> GetAvailableAsync(string title, AppCatalogScope scope = default(AppCatalogScope))
Parameters
System.String title

The title of the app.
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
Task<AppMetadata>

Install(Guid, AppCatalogScope)

Installs an available app from the app catalog in a site.

Declaration
public bool Install(Guid id, AppCatalogScope scope = default(AppCatalogScope))
Parameters
Guid id

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

Specifies the app catalog to work with. Defaults to Tenant
Returns
System.Boolean

Install(AppMetadata, AppCatalogScope)

Installs an available app from the app catalog in a site.

Declaration
public bool Install(AppMetadata appMetadata, AppCatalogScope scope = default(AppCatalogScope))
Parameters
AppMetadata appMetadata

The app metadata object of the app to install
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
System.Boolean

InstallAsync(Guid, AppCatalogScope)

Installs an available app from the app catalog in a site.

Declaration
public async Task<bool> InstallAsync(Guid id, AppCatalogScope scope = default(AppCatalogScope))
Parameters
Guid id

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

Specifies the app catalog to work with. Defaults to Tenant
Returns
Task<System.Boolean>

InstallAsync(AppMetadata, AppCatalogScope)

Installs an available app from the app catalog in a site.

Declaration
public async Task<bool> InstallAsync(AppMetadata appMetadata, AppCatalogScope scope = default(AppCatalogScope))
Parameters
AppMetadata appMetadata

The app metadata object of the app to install
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
Task<System.Boolean>

Remove(Guid, AppCatalogScope)

Removes an app from the app catalog

Declaration
public bool Remove(Guid id, AppCatalogScope scope = default(AppCatalogScope))
Parameters
Guid id

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

Specifies the app catalog to work with. Defaults to Tenant
Returns
System.Boolean

Remove(AppMetadata, AppCatalogScope)

Removes an app from the app catalog

Declaration
public bool Remove(AppMetadata appMetadata, AppCatalogScope scope = default(AppCatalogScope))
Parameters
AppMetadata appMetadata

The app metadata object of the app to remove.
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
System.Boolean

RemoveAsync(Guid, AppCatalogScope)

Removes an app from the app catalog

Declaration
public async Task<bool> RemoveAsync(Guid id, AppCatalogScope scope = default(AppCatalogScope))
Parameters
Guid id

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

Specifies the app catalog to work with. Defaults to Tenant
Returns
Task<System.Boolean>

RemoveAsync(AppMetadata, AppCatalogScope)

Removes an app from the app catalog

Declaration
public async Task<bool> RemoveAsync(AppMetadata appMetadata, AppCatalogScope scope = default(AppCatalogScope))
Parameters
AppMetadata appMetadata

The app metadata object of the app to remove.
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
Task<System.Boolean>

Retract(Guid, AppCatalogScope)

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

Declaration
public bool Retract(Guid id, AppCatalogScope scope = default(AppCatalogScope))
Parameters
Guid id

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

Specifies the app catalog to work with. Defaults to Tenant
Returns
System.Boolean

Retract(AppMetadata, AppCatalogScope)

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

Declaration
public bool Retract(AppMetadata appMetadata, AppCatalogScope scope = default(AppCatalogScope))
Parameters
AppMetadata appMetadata

The app metadata object of the app to retract.
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
System.Boolean

RetractAsync(Guid, AppCatalogScope)

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

Declaration
public async Task<bool> RetractAsync(Guid id, AppCatalogScope scope = default(AppCatalogScope))
Parameters
Guid id

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

Specifies the app catalog to work with. Defaults to Tenant
Returns
Task<System.Boolean>

RetractAsync(AppMetadata, AppCatalogScope)

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

Declaration
public async Task<bool> RetractAsync(AppMetadata appMetadata, AppCatalogScope scope = default(AppCatalogScope))
Parameters
AppMetadata appMetadata

The app metadata object of the app to retract.
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
Task<System.Boolean>

SyncToTeams(Guid)

Synchronize an app from the tenant app catalog with the teams app catalog

Declaration
public bool SyncToTeams(Guid id)
Parameters
Guid id

The unique id of the app. Notice that this is not the product id as listen in the app catalog
Returns
System.Boolean

SyncToTeams(AppMetadata)

Synchronize an app from the tenant app catalog with the teams app catalog

Declaration
public bool SyncToTeams(AppMetadata appMetadata)
Parameters
AppMetadata appMetadata

The app metadata object of the app to remove.
Returns
System.Boolean

SyncToTeamsAsync(Guid)

Synchronize an app from the tenant app catalog with the teams app catalog

Declaration
public async Task<bool> SyncToTeamsAsync(Guid id)
Parameters
Guid id

The unique id of the app. Notice that this is not the product id as listen in the app catalog
Returns
Task<System.Boolean>

SyncToTeamsAsync(AppMetadata)

Synchronize an app from the tenant app catalog with the teams app catalog

Declaration
public async Task<bool> SyncToTeamsAsync(AppMetadata appMetadata)
Parameters
AppMetadata appMetadata

The app metadata object of the app to remove.
Returns
Task<System.Boolean>

Uninstall(Guid, AppCatalogScope)

Uninstalls an app from a site.

Declaration
public bool Uninstall(Guid id, AppCatalogScope scope = default(AppCatalogScope))
Parameters
Guid id

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

Specifies the app catalog to work with. Defaults to Tenant
Returns
System.Boolean

Uninstall(AppMetadata, AppCatalogScope)

Uninstalls an app from a site.

Declaration
public bool Uninstall(AppMetadata appMetadata, AppCatalogScope scope = default(AppCatalogScope))
Parameters
AppMetadata appMetadata

The app metadata object of the app to uninstall.
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
System.Boolean

UninstallAsync(Guid, AppCatalogScope)

Uninstalls an app from a site.

Declaration
public async Task<bool> UninstallAsync(Guid id, AppCatalogScope scope = default(AppCatalogScope))
Parameters
Guid id

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

Specifies the app catalog to work with. Defaults to Tenant
Returns
Task<System.Boolean>

UninstallAsync(AppMetadata, AppCatalogScope)

Uninstalls an app from a site.

Declaration
public async Task<bool> UninstallAsync(AppMetadata appMetadata, AppCatalogScope scope = default(AppCatalogScope))
Parameters
AppMetadata appMetadata

The app metadata object of the app to uninstall.
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
Task<System.Boolean>

Upgrade(Guid, AppCatalogScope)

Upgrades an app in a site

Declaration
public bool Upgrade(Guid id, AppCatalogScope scope = default(AppCatalogScope))
Parameters
Guid id

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

Specifies the app catalog to work with. Defaults to Tenant
Returns
System.Boolean

Upgrade(AppMetadata, AppCatalogScope)

Upgrades an app in a site

Declaration
public bool Upgrade(AppMetadata appMetadata, AppCatalogScope scope = default(AppCatalogScope))
Parameters
AppMetadata appMetadata

The app metadata object of the app to upgrade.
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
System.Boolean

UpgradeAsync(Guid, AppCatalogScope)

Upgrades an app in a site

Declaration
public async Task<bool> UpgradeAsync(Guid id, AppCatalogScope scope = default(AppCatalogScope))
Parameters
Guid id

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

Specifies the app catalog to work with. Defaults to Tenant
Returns
Task<System.Boolean>

UpgradeAsync(AppMetadata, AppCatalogScope)

Upgrades an app in a site

Declaration
public async Task<bool> UpgradeAsync(AppMetadata appMetadata, AppCatalogScope scope = default(AppCatalogScope))
Parameters
AppMetadata appMetadata

The app metadata object of the app to upgrade.
AppCatalogScope scope

Specifies the app catalog to work with. Defaults to Tenant
Returns
Task<System.Boolean>

Extension Methods