AppInstance members

Represents an App object installed to a specific Web site.

The AppInstance type exposes the following members.

Constructors

	Name	Description
	AppInstance	Initializes a new instance of the AppInstance class using the current context and object path.

Top

Properties

	Name	Description
	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.
	Context	Returns the context that is associated with the client object. (Inherited from ClientObject.)
	Id	Gets the unique identifier of the AppInstance object.
	ImageFallbackUrl
	ImageUrl
	InError	Gets whether the app instance is in an error state.
	ObjectData	Gets the object data for the current client object. (Inherited from ClientObject.)
	ObjectVersion	Gets a string that indicates the version of the current client object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	PackageFingerprint
	Path	Tracks how a client object is created in the ClientRuntimeContext class so that the object can be recreated on the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	ProductId
	RemoteAppUrl	Gets the base URL of the remote system deployed during the installation of this app instance.
	ServerObjectIsNull	Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
	SettingsPageUrl	Gets the settings page URL of the current app instance.
	SiteId	Gets the SharePoint site containing the Web where this app instance is installed.
	StartPage	Gets the start page of the app instance.
	Status	Gets the lifecycle status of an app instance based on the constants defined by the AppInstanceStatus object.
	Tag	Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
	Title	Gets the title of the SharePoint app.
	TypedObject	Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)
	WebId	Gets the identifier of the web where this app is installed.

Top

Methods

	Name	Description
	CancelAllJobs	Cancels each currently running lifecycle job for an app instance.
	CheckUninitializedProperty	Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
	CustomFromJson	Returns a Boolean value that indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	FromJson	Indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	GetAppIcon
	GetErrorDetails	Retrieves the details of an error the app instance has encountered.
	GetPreviousAppVersion	Retrieves the version of the app that is being upgraded from during an upgrade.
	InitNonPropertyFieldFromJson	Initializes a non-property field of the client object based on JavaScript Object Notation (JSON) data from the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	InitOnePropertyFromJson	Initializes one property of the client object based on JSON data from the server. This member is reserved for internal use and is not intended to be used directly from your code. (Overrides ClientObject.InitOnePropertyFromJson(String, JsonReader).)
	Install	Starts an install on this app instance.
	IsObjectPropertyInstantiated	Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
	IsPropertyAvailable	Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
	LoadExpandoFields	Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
	Recycle	Creates a job that sends the app instance to the recycle bin.
	RefreshLoad	Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
	RemoveFromParentCollection	Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
	Restore	Creates a job that restores the app instance from the recycle bin to the installed state.
	Retrieve()	Retrieves all scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	Retrieve([])	Retrieves the specified scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	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.)
	TryGetAppDatabaseConnectionDirect(ClientRuntimeContext, SqlConnection, Boolean)	Retrieves a connection to the app database.
	TryGetAppDatabaseConnectionDirect(ClientRuntimeContext, SqlConnectionStringBuilder, SqlConnection, Boolean)	Retrieves a connection to the app database.
	Uninstall	Removes app instances that are either initialized or installed.
	UpdateClientObjectPropertyType	Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)
	Upgrade	Uploads a version of an app, and then upgrades the app instance to that version.

Top

See also

Reference

AppInstance class

Microsoft.SharePoint.Client namespace