AppInstance methods

AppInstance methods

SharePoint 2013

The AppInstance type exposes the following members.

  Name Description
Public method CancelAllJobs Cancels each currently running lifecycle job for an app instance.
Protected method CheckUninitializedProperty Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
Public method 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.)
Public method 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.)
Public method Static member GetAppIcon
Public method GetErrorDetails Retrieves the details of an error the app instance has encountered.
Public method GetPreviousAppVersion Retrieves the version of the app that is being upgraded from during an upgrade.
Protected method 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.)
Protected method 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).)
Public method Install Starts an install on this app instance.
Public method IsObjectPropertyInstantiated Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
Public method IsPropertyAvailable Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
Protected method LoadExpandoFields Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Public method Recycle Creates a job that sends the app instance to the recycle bin.
Public method RefreshLoad Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Protected method RemoveFromParentCollection Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
Public method Restore Creates a job that restores the app instance from the recycle bin to the installed state.
Public method 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.)
Public method 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.)
Public method Static 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 Static member TryGetAppDatabaseConnectionDirect(ClientRuntimeContext, SqlConnection, Boolean) Retrieves a connection to the app database.
Public method Static member TryGetAppDatabaseConnectionDirect(ClientRuntimeContext, SqlConnectionStringBuilder, SqlConnection, Boolean) Retrieves a connection to the app database.
Public method Uninstall Removes app instances that are either initialized or installed.
Protected method UpdateClientObjectPropertyType Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)
Public method Upgrade Uploads a version of an app, and then upgrades the app instance to that version.
Top
Show:
© 2016 Microsoft