AppInstance - Membres
Represents an App object installed to a specific Web site.
Le type AppInstance expose les membres suivants.
Constructeurs
Nom | Description | |
---|---|---|
AppInstance | Initializes a new instance of the AppInstance class using the current context and object path. |
Haut
Propriétés
Nom | 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 | Retourne le contexte associé à l'objet client. (Hérité de ClientObject) | |
Id | Gets the unique identifier of the AppInstance object. | |
ImageFallbackUrl | ||
ImageUrl | ||
InError | Gets whether the app instance is in an error state. | |
ObjectData | Obtient les données d'objet pour l'objet de client en cours. (Hérité de ClientObject) | |
ObjectVersion | Obtient une chaîne qui indique la version de l'objet client actuel. Ce membre est réservé à une utilisation interne et n’est pas destiné à être utilisé directement à partir de votre code. (Hérité de ClientObject) | |
PackageFingerprint | ||
Path | Effectue le suivi de façon dont un objet client est créé dans la classe ClientRuntimeContext afin que l'objet peut être recréé sur le serveur. Ce membre est réservé à une utilisation interne et n’est pas destiné à être utilisé directement à partir de votre code. (Hérité de ClientObject) | |
ProductId | ||
RemoteAppUrl | Gets the base URL of the remote system deployed during the installation of this app instance. | |
ServerObjectIsNull | Obtient l'objet serveur et renvoie la valeur null si l'objet serveur est null. (Hérité de 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 | Obtient ou définit les données associées à l'objet client. (Hérité de ClientObject) | |
Title | Gets the title of the SharePoint app. | |
TypedObject | Renvoie l'objet contenant les informations de type correct renvoyées par le serveur. (Hérité de ClientObject) | |
WebId | Gets the identifier of the web where this app is installed. |
Haut
Méthodes
Nom | Description | |
---|---|---|
CancelAllJobs | Cancels each currently running lifecycle job for an app instance. | |
CheckUninitializedProperty | Vérifie si la propriété de type de valeur spécifiée d'une ClientObject a été initialisée. (Hérité de ClientObject) | |
CustomFromJson | Renvoie une valeur booléenne qui indique si le code personnalisé a été utilisé pour remplir un objet. Ce membre est réservé à une utilisation interne et n’est pas destiné à être utilisé directement à partir de votre code. (Hérité de ClientObject) | |
FromJson | Indique si le code personnalisé a été utilisé pour remplir un objet. Ce membre est réservé à une utilisation interne et n’est pas destiné à être utilisé directement à partir de votre code. (Hérité de 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 | Initialise un champ non propriété de l'objet client basé sur des données JavaScript Object Notation (JSON) à partir du serveur. Ce membre est réservé à une utilisation interne et n’est pas destiné à être utilisé directement à partir de votre code. (Hérité de 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. (Remplace ClientObject.InitOnePropertyFromJson(String, JsonReader)) | |
Install | Starts an install on this app instance. | |
IsObjectPropertyInstantiated | Indique si la propriété spécifiée de l'objet client instanciation. (Hérité de ClientObject) | |
IsPropertyAvailable | Renvoie une valeur booléenne qui indique si la propriété scalaire spécifiée a été récupérée ou définir. (Hérité de ClientObject) | |
LoadExpandoFields | Rétablit les propriétés étendues associées à l'objet client en cas de substitution dans une classe dérivée. (Hérité de ClientObject) | |
Recycle | Creates a job that sends the app instance to the recycle bin. | |
RefreshLoad | Recharge toutes les propriétés scalaires associées à l'objet client en cas de substitution dans une classe dérivée. (Hérité de ClientObject) | |
RemoveFromParentCollection | Supprime l'objet client en cours de la collection d'objets client parent. (Hérité de ClientObject) | |
Restore | Creates a job that restores the app instance from the recycle bin to the installed state. | |
Retrieve() | Récupère toutes les propriétés scalaires associées à l'objet. Ce membre est réservé à une utilisation interne et n’est pas destiné à être utilisé directement à partir de votre code. (Hérité de ClientObject) | |
Retrieve([]) | Extrait les propriétés scalaires spécifiées associées à l'objet. Ce membre est réservé à une utilisation interne et n’est pas destiné à être utilisé directement à partir de votre code. (Hérité de ClientObject) | |
RetrieveAppDatabaseConnectionString | Retrieves the connection string for an app database. | |
RetryAllJobs | Restarts all jobs for this app instance if there are any. | |
ToString | (Hérité de 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 | Met à jour la valeur de la propriété objet client pour que le type correct en utilisant les informations de type renvoyées par le serveur. (Hérité de ClientObject) | |
Upgrade | Uploads a version of an app, and then upgrades the app instance to that version. |
Haut