Interface ITenantAppManager

Namespace

PnP.Core.Admin.Model.SharePoint

Assembly

PnP.Core.Admin.dll

Represents an interface to work with Application Lifecycle Management (ALM) for the tenant app catalog.

public interface ITenantAppManager : IAppManager<ITenantApp>, IAppOperations

Inherited Members

IAppManager<ITenantApp>.GetAvailable(Guid)

IAppManager<ITenantApp>.GetAvailableAsync(Guid)

IAppManager<ITenantApp>.GetAvailable(string)

IAppManager<ITenantApp>.GetAvailableAsync(string)

IAppManager<ITenantApp>.GetAvailable()

IAppManager<ITenantApp>.GetAvailableAsync()

IAppManager<ITenantApp>.Add(byte[], string, bool)

IAppManager<ITenantApp>.AddAsync(byte[], string, bool)

IAppManager<ITenantApp>.Add(string, bool)

IAppManager<ITenantApp>.AddAsync(string, bool)

IAppManager<ITenantApp>.ServicePrincipal

IAppOperations.Deploy(Guid, bool)

IAppOperations.DeployAsync(Guid, bool)

IAppOperations.Retract(Guid)

IAppOperations.RetractAsync(Guid)

IAppOperations.Remove(Guid)

IAppOperations.RemoveAsync(Guid)

IAppOperations.Install(Guid)

IAppOperations.InstallAsync(Guid)

IAppOperations.Upgrade(Guid)

IAppOperations.UpgradeAsync(Guid)

IAppOperations.Uninstall(Guid)

IAppOperations.UninstallAsync(Guid)

IAppOperations.ApproveAsync(string)

Methods

AddAndDeployStoreApp(string, string, bool, bool)

Uploads SharePoint Store app to the tenant app catalog and deploys it.

ITenantApp AddAndDeployStoreApp(string storeAssetId, string cultureName, bool skipFeatureDeployment = true, bool overwrite = true)

Parameters

storeAssetId string

A unique store asset id. If you open the SharePoint Store app's home page, the url will be ...appStore.aspx/appDetail/WA200001111. The last part WA200001111 will be your store asset id.

cultureName string

4-letters culture name, i.e. "en-us", "de-de", etc.

skipFeatureDeployment bool

If set to true will skip the feature deployment and will install the app globally.

overwrite bool

Whether to overwrite if the app is already exisits in the tenant app catalog.

Returns

ITenantApp

AddAndDeployStoreAppAsync(string, string, bool, bool)

Uploads SharePoint Store app to the tenant app catalog and deploys it.

Task<ITenantApp> AddAndDeployStoreAppAsync(string storeAssetId, string cultureName, bool skipFeatureDeployment = true, bool overwrite = true)

Parameters

storeAssetId string

A unique store asset id. If you open the SharePoint Store app's home page, the url will be ...appStore.aspx/appDetail/WA200001111. The last part WA200001111 will be your store asset id.

cultureName string

4-letters culture name, i.e. "en-us", "de-de", etc.

skipFeatureDeployment bool

If set to true will skip the feature deployment and will install the app globally.

overwrite bool

Whether to overwrite if the app is already exisits in the tenant app catalog.

Returns

Task<ITenantApp>

AddSiteCollectionAppCatalog(Uri, VanityUrlOptions)

Add a site collection app catalogs to the site collection.

void AddSiteCollectionAppCatalog(Uri siteCollectionAbsoluteUri, VanityUrlOptions vanityUrlOptions = null)

Parameters

siteCollectionAbsoluteUri Uri

Fully qualified url of the site collection to add the app catalog to

vanityUrlOptions VanityUrlOptions

Optionally specify the custom vanity URI's used by this tenant

AddSiteCollectionAppCatalogAsync(Uri, VanityUrlOptions)

Add a site collection app catalogs to the site collection.

Task AddSiteCollectionAppCatalogAsync(Uri siteCollectionAbsoluteUri, VanityUrlOptions vanityUrlOptions = null)

Parameters

siteCollectionAbsoluteUri Uri

Fully qualified url of the site collection to add the app catalog to

vanityUrlOptions VanityUrlOptions

Optionally specify the custom vanity URI's used by this tenant

Returns

Task

DownloadTeamsSolution(Guid)

Downloads MS Teams package from SPFx solution as a stream. You can save the stream to a file with a .zip extension later on.

Stream DownloadTeamsSolution(Guid id)

Parameters

id Guid

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

Returns

Stream

Stream with the MS Teams binary package.

DownloadTeamsSolution(int)

Downloads MS Teams package from SPFx solution as a stream. You can save the stream to a file with a .zip extension later on.

Stream DownloadTeamsSolution(int id)

Parameters

id int

List item id of the app in the AppCatalog list.

Returns

Stream

Stream with the MS Teams binary package.

DownloadTeamsSolutionAsync(Guid)

Downloads MS Teams package from SPFx solution as a stream. You can save the stream to a file with a .zip extension later on.

Task<Stream> DownloadTeamsSolutionAsync(Guid id)

Parameters

id Guid

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

Returns

Task<Stream>

Stream with the MS Teams binary package.

DownloadTeamsSolutionAsync(int)

Downloads MS Teams package from SPFx solution as a stream. You can save the stream to a file with a .zip extension later on.

Task<Stream> DownloadTeamsSolutionAsync(int id)

Parameters

id int

List item id of the app in the AppCatalog list.

Returns

Task<Stream>

Stream with the MS Teams binary package.

EnsureSiteCollectionAppCatalog(Uri, VanityUrlOptions)

Ensures a site collection app catalogs exists for provided site collection.

void EnsureSiteCollectionAppCatalog(Uri siteCollectionAbsoluteUri, VanityUrlOptions vanityUrlOptions = null)

Parameters

siteCollectionAbsoluteUri Uri

Fully qualified url of the site collection to ensure the app catalog exists for

vanityUrlOptions VanityUrlOptions

Optionally specify the custom vanity URI's used by this tenant

EnsureSiteCollectionAppCatalogAsync(Uri, VanityUrlOptions)

Ensures a site collection app catalogs exists for provided site collection.

Task EnsureSiteCollectionAppCatalogAsync(Uri siteCollectionAbsoluteUri, VanityUrlOptions vanityUrlOptions = null)

Parameters

siteCollectionAbsoluteUri Uri

Fully qualified url of the site collection to ensure the app catalog exists for

vanityUrlOptions VanityUrlOptions

Optionally specify the custom vanity URI's used by this tenant

Returns

Task

EnsureTenantAppCatalog()

Ensures there's a tenant app catalog, if not present it will be created.

bool EnsureTenantAppCatalog()

Returns

bool

True if the app catalog was created, false if the app catalog already existed.

EnsureTenantAppCatalogAsync()

Ensures there's a tenant app catalog, if not present it will be created.

Task<bool> EnsureTenantAppCatalogAsync()

Returns

Task<bool>

True if the app catalog was created, false if the app catalog already existed.

GetSiteCollectionAppCatalogs()

Returns a list of site collection app catalogs in the tenant.

IList<IAppCatalogSite> GetSiteCollectionAppCatalogs()

Returns

IList<IAppCatalogSite>

A list of IAppCatalogSite

GetSiteCollectionAppCatalogsAsync()

Returns a list of site collection app catalogs in the tenant.

Task<IList<IAppCatalogSite>> GetSiteCollectionAppCatalogsAsync()

Returns

Task<IList<IAppCatalogSite>>

A list of IAppCatalogSite

GetStoreApps()

A list of apps, added to the tenant from the SharePoint Store.

IList<ITenantApp> GetStoreApps()

Returns

IList<ITenantApp>

A list of ITenantApp

GetStoreAppsAsync()

A list of apps, added to the tenant from the SharePoint Store.

Task<IList<ITenantApp>> GetStoreAppsAsync()

Returns

Task<IList<ITenantApp>>

A list of ITenantApp

GetTenantAppCatalogUri()

Returns the URI of the current tenant app catalog.

Uri GetTenantAppCatalogUri()

Returns

Uri

GetTenantAppCatalogUriAsync()

Returns the URI of the current tenant app catalog.

Task<Uri> GetTenantAppCatalogUriAsync()

Returns

Task<Uri>

IsAppUpgradeAvailable(Guid)

Indicates whether the upgrade is available for the specific app on a site.

bool IsAppUpgradeAvailable(Guid id)

Parameters

id Guid

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

Returns

bool

true if update is available.

IsAppUpgradeAvailable(int)

Indicates whether the upgrade is available for the specific app on a site.

bool IsAppUpgradeAvailable(int id)

Parameters

id int

List item id of the app in the AppCatalog list.

Returns

bool

true if update is available.

IsAppUpgradeAvailableAsync(Guid)

Indicates whether the upgrade is available for the specific app on a site.

Task<bool> IsAppUpgradeAvailableAsync(Guid id)

Parameters

id Guid

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

Returns

Task<bool>

true if update is available.

IsAppUpgradeAvailableAsync(int)

Indicates whether the upgrade is available for the specific app on a site.

Task<bool> IsAppUpgradeAvailableAsync(int id)

Parameters

id int

List item id of the app in the AppCatalog list.

Returns

Task<bool>

true if update is available.

RemoveSiteCollectionAppCatalog(Uri, VanityUrlOptions)

Removes a site collection app catalog from a site collection.

void RemoveSiteCollectionAppCatalog(Uri siteCollectionAbsoluteUri, VanityUrlOptions vanityUrlOptions = null)

Parameters

siteCollectionAbsoluteUri Uri

Fully qualified url of the site collection to remove the app catalog for

vanityUrlOptions VanityUrlOptions

Optionally specify the custom vanity URI's used by this tenant

RemoveSiteCollectionAppCatalogAsync(Uri, VanityUrlOptions)

Removes a site collection app catalog from a site collection.

Task RemoveSiteCollectionAppCatalogAsync(Uri siteCollectionAbsoluteUri, VanityUrlOptions vanityUrlOptions = null)

Parameters

siteCollectionAbsoluteUri Uri

Fully qualified url of the site collection to remove the app catalog for

vanityUrlOptions VanityUrlOptions

Optionally specify the custom vanity URI's used by this tenant

Returns

Task

SolutionContainsTeamsComponent(Guid)

Indicates whether a solution contains MS Teams component.

bool SolutionContainsTeamsComponent(Guid id)

Parameters

id Guid

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

Returns

bool

true if the solution contains teams component.

SolutionContainsTeamsComponentAsync(Guid)

Indicates whether a solution contains MS Teams component.

Task<bool> SolutionContainsTeamsComponentAsync(Guid id)

Parameters

id Guid

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

Returns

Task<bool>

true if the solution contains teams component.