Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Represents an SPApp object installed to a specific SPWeb site.
The SPAppInstance type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
App | Gets the app that this instance is an installation of. |
|
AppPrincipalId | Gets the encoded claim value for the app principal identifier associated with this app instance. |
|
AppWebFullUrl | Gets the absolute URL of the site created during the installation of this app instance that is used to host SharePoint components. |
|
Id | Gets the unique identifier of the SPAppInstance object. |
|
ImageFallbackUrl | |
|
ImageUrl | |
|
InError | Gets whether the app instance is in an an error state. |
|
LaunchUrl | Gets the launch URL of the current app instance. |
|
PackageFingerprint | |
|
ProductId | |
|
RemoteAppUrl | Gets the base URL of the remote system deployed during the installation of this app instance. |
|
SettingsPageUrl | Gets the settings page URL of the current app instance. |
|
SiteId | Gets the SharePoint site containing the SPWeb where this app instance is installed. |
|
Status | Gets the lifecycle status of an app instance based on the constants defined by the SPAppInstanceStatus object. |
|
Title | Gets the title of the SharePoint app. |
|
WebId | Gets the identifier of the SharePoint web where this app is installed. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
CancelAllJobs | Cancels each currently running lifecycle job for an app instance. |
|
Disable | Disables the app instance, leaving its components in place but setting them in a state where they cannot do damage. |
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetErrorDetails | Retrieves the details of an error the app instance has encountered. |
|
GetHashCode | (Inherited from Object.) |
|
GetPreviousAppVersion | Retrieves the version of the app that is being upgraded from during an upgrade. |
|
GetType | (Inherited from Object.) |
|
Install | Starts an install on this app instance. |
|
MemberwiseClone | (Inherited from Object.) |
|
Recycle | |
|
Restore | |
.gif "Static member") |
RetrieveAppDatabaseConnectionString | Retrieves the connection string for an app database. |
|
RetryAllJobs | Restarts all jobs for this app instance if there are any. |
|
ToString | (Inherited from Object.) |
|
Uninstall | Removes app instances that are either initialized or installed. |
|
UpdateAppDatabaseMetadata | |
|
Upgrade | Uploads a version of an app, and then upgrades the app instance to that version. |
Top