Interface ITenantAppManager

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

Inherited Members
Namespace: PnP.Core.Admin.Model.SharePoint
Assembly: PnP.Core.Admin.dll
Syntax
public interface ITenantAppManager : IAppManager<ITenantApp>, IAppOperations

Methods

AddAndDeployStoreApp(String, String, Boolean, Boolean)

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

Declaration
ITenantApp AddAndDeployStoreApp(string storeAssetId, string cultureName, bool skipFeatureDeployment = true, bool overwrite = true)
Parameters
System.String storeAssetId

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

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

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

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

AddAndDeployStoreAppAsync(String, String, Boolean, Boolean)

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

Declaration
Task<ITenantApp> AddAndDeployStoreAppAsync(string storeAssetId, string cultureName, bool skipFeatureDeployment = true, bool overwrite = true)
Parameters
System.String storeAssetId

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

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

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

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.

Declaration
void AddSiteCollectionAppCatalog(Uri siteCollectionAbsoluteUri, VanityUrlOptions vanityUrlOptions = null)
Parameters
Uri siteCollectionAbsoluteUri

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.

Declaration
Task AddSiteCollectionAppCatalogAsync(Uri siteCollectionAbsoluteUri, VanityUrlOptions vanityUrlOptions = null)
Parameters
Uri siteCollectionAbsoluteUri

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.

Declaration
Stream DownloadTeamsSolution(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
Stream

with the MS Teams binary package.

DownloadTeamsSolution(Int32)

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

Declaration
Stream DownloadTeamsSolution(int id)
Parameters
System.Int32 id

List item id of the app in the AppCatalog list.
Returns
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.

Declaration
Task<Stream> DownloadTeamsSolutionAsync(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<Stream>

with the MS Teams binary package.

DownloadTeamsSolutionAsync(Int32)

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

Declaration
Task<Stream> DownloadTeamsSolutionAsync(int id)
Parameters
System.Int32 id

List item id of the app in the AppCatalog list.
Returns
Task<Stream>

with the MS Teams binary package.

EnsureSiteCollectionAppCatalog(Uri, VanityUrlOptions)

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

Declaration
void EnsureSiteCollectionAppCatalog(Uri siteCollectionAbsoluteUri, VanityUrlOptions vanityUrlOptions = null)
Parameters
Uri siteCollectionAbsoluteUri

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.

Declaration
Task EnsureSiteCollectionAppCatalogAsync(Uri siteCollectionAbsoluteUri, VanityUrlOptions vanityUrlOptions = null)
Parameters
Uri siteCollectionAbsoluteUri

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.

Declaration
bool EnsureTenantAppCatalog()
Returns
System.Boolean

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.

Declaration
Task<bool> EnsureTenantAppCatalogAsync()
Returns
Task<System.Boolean>

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.

Declaration
IList<IAppCatalogSite> GetSiteCollectionAppCatalogs()
Returns
IList<IAppCatalogSite>

A list of IAppCatalogSite

GetSiteCollectionAppCatalogsAsync()

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

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

Declaration
IList<ITenantApp> GetStoreApps()
Returns
IList<ITenantApp>

A list of ITenantApp

GetStoreAppsAsync()

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

Declaration
Task<IList<ITenantApp>> GetStoreAppsAsync()
Returns
Task<IList<ITenantApp>>

A list of ITenantApp

GetTenantAppCatalogUri()

Returns the URI of the current tenant app catalog.

Declaration
Uri GetTenantAppCatalogUri()
Returns
Uri

GetTenantAppCatalogUriAsync()

Returns the URI of the current tenant app catalog.

Declaration
Task<Uri> GetTenantAppCatalogUriAsync()
Returns
Task<Uri>

IsAppUpgradeAvailable(Guid)

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

Declaration
bool IsAppUpgradeAvailable(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 update is available.

IsAppUpgradeAvailable(Int32)

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

Declaration
bool IsAppUpgradeAvailable(int id)
Parameters
System.Int32 id

List item id of the app in the AppCatalog list.
Returns
System.Boolean

true if update is available.

IsAppUpgradeAvailableAsync(Guid)

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

Declaration
Task<bool> IsAppUpgradeAvailableAsync(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 update is available.

IsAppUpgradeAvailableAsync(Int32)

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

Declaration
Task<bool> IsAppUpgradeAvailableAsync(int id)
Parameters
System.Int32 id

List item id of the app in the AppCatalog list.
Returns
Task<System.Boolean>

true if update is available.

RemoveSiteCollectionAppCatalog(Uri, VanityUrlOptions)

Removes a site collection app catalog from a site collection.

Declaration
void RemoveSiteCollectionAppCatalog(Uri siteCollectionAbsoluteUri, VanityUrlOptions vanityUrlOptions = null)
Parameters
Uri siteCollectionAbsoluteUri

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.

Declaration
Task RemoveSiteCollectionAppCatalogAsync(Uri siteCollectionAbsoluteUri, VanityUrlOptions vanityUrlOptions = null)
Parameters
Uri siteCollectionAbsoluteUri

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.

Declaration
bool SolutionContainsTeamsComponent(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 the solution contains teams component.

SolutionContainsTeamsComponentAsync(Guid)

Indicates whether a solution contains MS Teams component.

Declaration
Task<bool> SolutionContainsTeamsComponentAsync(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 the solution contains teams component.