Partager via


AppInstance - Membres

Represents an App object installed to a specific Web site.

Le type AppInstance expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique AppInstance Initializes a new instance of the AppInstance class using the current context and object path.

Haut

Propriétés

  Nom Description
Propriété publique AppPrincipalId Gets the encoded claim value for the app principal identifier associated with this app instance.
Propriété publique AppWebFullUrl Gets the absolute URL of the site created during the installation of this app instance that is used to host SharePoint components.
Propriété publique Context Retourne le contexte associé à l'objet client. (Hérité de ClientObject)
Propriété publique Id Gets the unique identifier of the AppInstance object.
Propriété publique ImageFallbackUrl
Propriété publique ImageUrl
Propriété publique InError Gets whether the app instance is in an error state.
Propriété protégée ObjectData Obtient les données d'objet pour l'objet de client en cours. (Hérité de ClientObject)
Propriété publique 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)
Propriété publique PackageFingerprint
Propriété publique 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)
Propriété publique ProductId
Propriété publique RemoteAppUrl Gets the base URL of the remote system deployed during the installation of this app instance.
Propriété publique ServerObjectIsNull Obtient l'objet serveur et renvoie la valeur null si l'objet serveur est null. (Hérité de ClientObject)
Propriété publique SettingsPageUrl Gets the settings page URL of the current app instance.
Propriété publique SiteId Gets the SharePoint site containing the Web where this app instance is installed.
Propriété publique StartPage Gets the start page of the app instance.
Propriété publique Status Gets the lifecycle status of an app instance based on the constants defined by the AppInstanceStatus object.
Propriété publique Tag Obtient ou définit les données associées à l'objet client. (Hérité de ClientObject)
Propriété publique Title Gets the title of the SharePoint app.
Propriété publique TypedObject Renvoie l'objet contenant les informations de type correct renvoyées par le serveur. (Hérité de ClientObject)
Propriété publique WebId Gets the identifier of the web where this app is installed.

Haut

Méthodes

  Nom Description
Méthode publique CancelAllJobs Cancels each currently running lifecycle job for an app instance.
Méthode protégée 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)
Méthode publique 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)
Méthode publique 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)
Méthode publiqueMembre statique GetAppIcon
Méthode publique GetErrorDetails Retrieves the details of an error the app instance has encountered.
Méthode publique GetPreviousAppVersion Retrieves the version of the app that is being upgraded from during an upgrade.
Méthode protégée 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)
Méthode protégée 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))
Méthode publique Install Starts an install on this app instance.
Méthode publique IsObjectPropertyInstantiated Indique si la propriété spécifiée de l'objet client instanciation. (Hérité de ClientObject)
Méthode publique 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)
Méthode protégée 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)
Méthode publique Recycle Creates a job that sends the app instance to the recycle bin.
Méthode publique 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)
Méthode protégée RemoveFromParentCollection Supprime l'objet client en cours de la collection d'objets client parent. (Hérité de ClientObject)
Méthode publique Restore Creates a job that restores the app instance from the recycle bin to the installed state.
Méthode publique 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)
Méthode publique 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)
Méthode publiqueMembre statique RetrieveAppDatabaseConnectionString Retrieves the connection string for an app database.
Méthode publique RetryAllJobs Restarts all jobs for this app instance if there are any.
Méthode publique ToString (Hérité de Object)
Méthode publiqueMembre statique TryGetAppDatabaseConnectionDirect(ClientRuntimeContext, SqlConnection, Boolean) Retrieves a connection to the app database.
Méthode publiqueMembre statique TryGetAppDatabaseConnectionDirect(ClientRuntimeContext, SqlConnectionStringBuilder, SqlConnection, Boolean) Retrieves a connection to the app database.
Méthode publique Uninstall Removes app instances that are either initialized or installed.
Méthode protégée 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)
Méthode publique Upgrade Uploads a version of an app, and then upgrades the app instance to that version.

Haut

Voir aussi

Référence

AppInstance classe

Microsoft.SharePoint.Client - Espace de noms