Export (0) Print
Expand All

AppInstance members

SharePoint 2013

Represents an App object installed to a specific Web site.

The AppInstance type exposes the following members.

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

  Name Description
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 Context Returns the context that is associated with the client object. (Inherited from ClientObject.)
Public property Id Gets the unique identifier of the AppInstance object.
Public property InError Gets whether the app instance is in an error state.
Protected property ObjectData Gets the object data for the current client object. (Inherited from ClientObject.)
Public property 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.)
Public property 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.)
Public property RemoteAppUrl Gets the base URL of the remote system deployed during the installation of this app instance.
Public property ServerObjectIsNull Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
Public property SettingsPageUrl Gets the settings page URL of the current app instance.
Public property SiteId Gets the SharePoint site containing the Web where this app instance is installed.
Public property StartPage Gets the start page of the app instance.
Public property Status Gets the lifecycle status of an app instance based on the constants defined by the AppInstanceStatus object.
Public property Tag Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
Public property Title Gets the title of the SharePoint app.
Public property TypedObject Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)
Public property WebId Gets the identifier of the web where this app is installed.
Top

  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 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 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 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

Community Additions

ADD
Show:
© 2014 Microsoft