AppInstance methods
SharePoint 2013
The AppInstance type exposes the following members.
| 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.) |
|
|
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.) |
|
|
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.) |
|
|
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. |
