class NsPushRestoreRequest

La classe NsPushRestoreRequest désigne un requête Push Restore, destinée à envoyer des documents à restaurer aux postes utilisateur.

Une fois crée, la demande de restauration est stockée dans une file de messages consultée périodiquement par l'agent client, ce qui explique que le déclenchement ne soit pas immédiat et que le logiciel propose des méthodes destinées à suivre le traitement des demandes d'exécution créées.

En mode interactif (par défaut), les documents sont restaurés après que l'utilisateur a validé un dialogue indiquant la nature de l'opération, ainsi qu'une élévation UAC. Lorsqu'un chaîne de texte est associée au champ UserMsg, celle-ci est intégrée au dialogue présenté à l'utilisateur. En mode non interactif, les fichiers sont extraits sans confirmation et en arrière-plan par les services du logiciel.

Les requêtes Push Restore sont créées en initialisant les champs de l'objet puis en appelant la méthode CreatePushRestoreRequest ou via la méthode PushToUser d'un objet NsRestorePackage. Une fois créée, les paramètres de la requête ne peuvent être modifiés.

Une requête Push Restore doit être associée avec un objet pointant vers des données à restaurer. Pour l'instant, seules les archives de restauration sont supportées : le champ SourceType doit être défini à nsPushRestoreRequestSourceTypeRestorePackage et SourceID doit contenir l'identificateur numérique d'une archive de restauration contenant les documents à restaurer.

Pour que les demandes de restauration soient correctement traitées, le module de notification doit-être démarré sur le poste client.

Pour visualiser un exemple d'utilisation de cette classe, consultez l'exemple de la classe NsRestorePackage.

ID : __int64

L'identificateur unique de la requête Push Restore.

CreationDate : VARIANT readonly

La date de création de la requête Push Restore sur le serveur de sauvegarde, au format UTC.

Options : long

Réservé.

UserID : __int64

L'identificateur numérique de l'utilisateur (NsUser) auquel envoyer des données.

Mode : enum NsPushRestoreRequestMode

Le mode de traitement de la requête : interactif (par défaut) ou en arrière-plan.

SourceType : enum NsPushRestoreRequestSourceType

Le type des données à restaurer.

SourceID : __int64

L'identificateur de l'objet contenant les données à restaurer.

TargetMode : enum NsPushRestoreRequestTargetMode

La cible de restauration des données : dans un répertoire ad-hoc (par défaut), dans un dossier pointé par TargetMode, ou aux emplacements originaux.

TargetPath : BSTR

Le répertoire dans lequel restaurer les données, si TargetMode est initialisé à nsPushRestoreRequestTargetModeCustomPath.

UserMsg : BSTR

Un message facultatif à présenter à l'utilisateur si le mode interactif est activé.

State : enum NsPushRestoreRequestState readonly

Le statut actuel de la requête Push Restore

ProgressValue : long readonly

Un nombre entre 0 et 100 représentant le pourcentage de progression de l'opération.

Completed : VARIANT_BOOL readonly

Indique si l'opération est arrivée à son terme.

Succeeded : VARIANT_BOOL readonly

Indique si l'opération a réussie, c'est à dire que tous les documents ont été restaurés avec succès sur le poste client.

RestoredFiles : __int64 readonly

Le nombre de fichiers restaurés si la requête a été traitée.

RestoredSize : __int64 readonly

Le volume de données restauré si la requête a été traitée.

VARIANT_BOOL LoadFromID(NsConnection Connection, __int64 PushRestoreRequestID)

Charge en mémoire la requête Push Restore d'identificateur numérique PushRestoreRequestID.

VARIANT_BOOL CreatePushRestoreRequest(NsConnection Connection)

Crée la requête Push Restore sur le serveur.

VARIANT_BOOL Refresh(NsConnection Connection)

Mets à jour les indicateurs d'une demande précédemment chargée.

VARIANT_BOOL Delete(NsConnection Connection)

Supprime la requête du serveur de sauvegarde.