Represents a base interface for an app stored either in tenant or site collection app catalog.
public interface IApp : IDataModelWithContextAzure Active Directory Id of the SharePoint Online Client Extensibility Web Application Principal. It's not empty if your SPFx solution requests any AAD permissions.
string AadAppId { get; set; }|
System.String
|
The list of Azure Active Directory permissions your SPFx solution requests.
string AadPermissions { get; set; }|
System.String
|
Returns version of the app in the app catalog.
Version AppCatalogVersion { get; set; }|
Version
|
Returns whether an existing instance of the app can be upgraded. True if there's newer version available in the app catalog compared to the instance in the site.
bool CanUpgrade { get; set; }|
System.Boolean
|
Returns the url of CDN if your app is hosted on CDN. If it's hosted inside SharePoint, it returns "SharePoint Online".
string CDNLocation { get; set; }|
System.String
|
Indicates whether your app contains tenant wide extensions.
bool ContainsTenantWideExtension { get; set; }|
System.Boolean
|
Indicates whether the current version of the app is deployed.
bool CurrentVersionDeployed { get; set; }|
System.Boolean
|
Indicates whether the app has been deployed to the context site. True if particular app has been installed to the site.
bool Deployed { get; set; }|
System.Boolean
|
Contains an error message if the app contains any problems during deployment.
string ErrorMessage { get; set; }|
System.String
|
Unique ID of the library list item of the app.
Guid Id { get; set; }|
Guid
|
Returns a version of the installed app in the site context.
Version InstalledVersion { get; set; }|
Version
|
Indicates whether the app is SharePoint Framework client-side solution.
bool IsClientSideSolution { get; set; }|
System.Boolean
|
Whether the app is enabled.
bool IsEnabled { get; set; }|
System.Boolean
|
Returns true, if the app's config (./config/package-solution.json) contains "skipFeatureDeployment" setting and it's set to true.
bool IsPackageDefaultSkipFeatureDeployment { get; set; }|
System.Boolean
|
Indicates whether the app package is valid.
bool IsValidAppPackage { get; set; }|
System.Boolean
|
The app's product id.
Guid ProductId { get; set; }|
Guid
|
The short description of the app.
string ShortDescription { get; set; }|
System.String
|
Returns true, if the app was globally deployed.
bool SkipDeploymentFeature { get; set; }|
System.Boolean
|
The thumbnail url of the app.
string ThumbnailUrl { get; set; }|
System.String
|
Title of the app.
string Title { get; set; }|
System.String
|
Approves All PermissionRequests
IPermissionGrant2[] ApprovePermissionRequests()|
IPermissionGrant2[]
true if all permissions have been approved successfully. |
Approves All PermissionRequests
Task<IPermissionGrant2[]> ApprovePermissionRequestsAsync()|
Task<IPermissionGrant2[]>
|
Deploys / trusts an app in the app catalog.
bool Deploy(bool skipFeatureDeployment = true)|
System.Boolean
skipFeatureDeployment
If set to true will skip the feature deployment for tenant scoped apps. |
|
System.Boolean
true if deployment was successful. |
Deploys / trusts an app in the app catalog.
Task<bool> DeployAsync(bool skipFeatureDeployment = true)|
System.Boolean
skipFeatureDeployment
If set to true will skip the feature deployment for tenant scoped apps. |
|
Task<System.Boolean>
true if deployment was successful. |
Installs the app from the app catalog in a site.
bool Install()|
System.Boolean
true if installation was successful. |
Installs the app from the app catalog in a site.
Task<bool> InstallAsync()|
Task<System.Boolean>
true if installation was successful. |
Removes the app from the app catalog.
bool Remove()|
System.Boolean
true if remove was successful. |
Removes the app from the app catalog.
Task<bool> RemoveAsync()|
Task<System.Boolean>
true if remove was successful. |
Retracts the app in the app catalog. Notice that this will not remove the app from the app catalog.
bool Retract()|
System.Boolean
true if retract was successful. |
Retracts the app in the app catalog. Notice that this will not remove the app from the app catalog.
Task<bool> RetractAsync()|
Task<System.Boolean>
true if retract was successful. |
Uninstalls the app from a site.
bool Uninstall()|
System.Boolean
true if uninstall was successful. |
Uninstalls the app from a site.
Task<bool> UninstallAsync()|
Task<System.Boolean>
true if uninstall was successful. |
Upgrades the app in a site.
bool Upgrade()|
System.Boolean
true if upgrade was successful. |
Upgrades the app in a site.
Task<bool> UpgradeAsync()|
Task<System.Boolean>
true if upgrade was successful. |