Share via


SPAppInstance members

Represents an SPApp object installed to a specific SPWeb site.

The SPAppInstance type exposes the following members.

Properties

  Name Description
Public property App Gets the app that this instance is an installation of.
Public property AppPrincipalId Gets the encoded claim value for the app principal identifier associated with this app instance.
Public property AppWebFullUrl Gets the absolute URL of the site created during the installation of this app instance that is used to host SharePoint components.
Public property Id Gets the unique identifier of the SPAppInstance object.
Public property ImageFallbackUrl
Public property ImageUrl
Public property InError Gets whether the app instance is in an an error state.
Public property LaunchUrl Gets the launch URL of the current app instance.
Public property PackageFingerprint
Public property ProductId
Public property RemoteAppUrl Gets the base URL of the remote system deployed during the installation of this app instance.
Public property SettingsPageUrl Gets the settings page URL of the current app instance.
Public property SiteId Gets the SharePoint site containing the SPWeb where this app instance is installed.
Public property Status Gets the lifecycle status of an app instance based on the constants defined by the SPAppInstanceStatus object.
Public property Title Gets the title of the SharePoint app.
Public property WebId Gets the identifier of the SharePoint web where this app is installed.

Top

Methods

  Name Description
Public method CancelAllJobs Cancels each currently running lifecycle job for an app instance.
Public method Disable Disables the app instance, leaving its components in place but setting them in a state where they cannot do damage.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetErrorDetails Retrieves the details of an error the app instance has encountered.
Public method GetHashCode (Inherited from Object.)
Public method GetPreviousAppVersion Retrieves the version of the app that is being upgraded from during an upgrade.
Public method GetType (Inherited from Object.)
Public method Install Starts an install on this app instance.
Protected method MemberwiseClone (Inherited from Object.)
Public method Recycle
Public method Restore
Public methodStatic member RetrieveAppDatabaseConnectionString Retrieves the connection string for an app database.
Public method RetryAllJobs Restarts all jobs for this app instance if there are any.
Public method ToString (Inherited from Object.)
Public method Uninstall Removes app instances that are either initialized or installed.
Public method UpdateAppDatabaseMetadata
Public method Upgrade Uploads a version of an app, and then upgrades the app instance to that version.

Top

See also

Reference

SPAppInstance class

Microsoft.SharePoint.Administration namespace