gpg::SnapshotMetadata

#include <snapshot_metadata.h>

Structure de données unique qui vous permet d'accéder aux données sur l'état d'une métadonnée d'instantané spécifique.

Résumé

Contrairement aux autres types de valeurs, un SnapshotMetadata n'est pas strictement immuable. SnapshotManager API peut "fermer" l'instantané en modifiant le résultat de la méthode IsOpen() ; ces API exigent universellement que le SnapshotMetadata transmis à IsOpen() soit transmis.

Constructeurs et destructeurs
SnapshotMetadata()
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
Construit un objet SnapshotMetadata à partir d'un shared_ptr vers un SnapshotMetadataImpl.
SnapshotMetadata(const SnapshotMetadata & copy_from)
Crée une copie d'un objet SnapshotMetadata existant.
SnapshotMetadata(SnapshotMetadata && move_from)
Déplace un objet SnapshotMetadata existant.
~SnapshotMetadata()

Fonctions publiques
CoverImageURL() const
const std::string &
Renvoie l'URL de l'image de couverture.
Description() const
const std::string &
Renvoie une description concise des métadonnées de votre instantané.
FileName() const
const std::string &
Renvoie le nom de fichier et l'identifiant unique de l'instantané.
IsOpen() const
bool
Renvoie la valeur "true" lorsque les métadonnées d'instantané renvoyées ont été chargées avec les données de fichier correspondantes.
LastModifiedTime() const
Renvoie l'heure à laquelle l'entrée a été modifiée pour la dernière fois (exprimée en millisecondes depuis l'époque Unix).
PlayedTime() const
Renvoie la durée de lecture associée à ces métadonnées d'instantané.
ProgressValue() const
int64_t
Renvoie la valeur de progression définie associée à ces métadonnées d'instantané.
Valid() const
bool
Renvoie la valeur "true" lorsque les métadonnées d'instantané renvoyées sont renseignées avec des données et accompagnées d'un état de réponse "réussite". "false" pour un instantané créé par l'utilisateur non renseigné ou pour un instantané renseigné avec un état de réponse "Échec".
operator=(const SnapshotMetadata & copy_from)
Attribue cet objet SnapshotMetadata en le copiant à partir d'un autre.
operator=(SnapshotMetadata && move_from)
Attribue cet objet SnapshotMetadata en y déplaçant un autre objet.

Fonctions publiques

CoverImageURL

const std::string & CoverImageURL() const

Renvoie l'URL de l'image de couverture.

Description

const std::string & Description() const

Renvoie une description concise des métadonnées de votre instantané.

SnapshotMetadata::Valid() doit renvoyer la valeur "true" pour que cette fonction soit utilisable.

Nom du fichier

const std::string & FileName() const

Renvoie le nom de fichier et l'identifiant unique de l'instantané.

Les noms des instantanés doivent comporter entre 1 et 100 caractères non réservés aux URL (a-z, A-Z, 0-9 ou les symboles "-", ".", "_" ou "~").

IsOpen

bool IsOpen() const

Renvoie la valeur "true" lorsque les métadonnées d'instantané renvoyées ont été chargées avec les données de fichier correspondantes.

Les opérations liées aux données telles que Read, Commit et Resolve ne fonctionneront que si l'objet contient des données de fichier. Malgré sa valeur "const", cette valeur change pour refléter les données sous-jacentes des métadonnées de l'instantané. Par exemple, si vous appelez Commit sur l'opération, IsOpen() renvoie la valeur "false".

LastModifiedTime

Timestamp LastModifiedTime() const

Renvoie l'heure à laquelle l'entrée a été modifiée pour la dernière fois (exprimée en millisecondes depuis l'époque Unix).

PlayedTime

gpg::Duration PlayedTime() const

Renvoie la durée de lecture associée à ces métadonnées d'instantané.

ProgressValue

int64_t ProgressValue() const

Renvoie la valeur de progression définie associée à ces métadonnées d'instantané.

La valeur de progression est utilisée dans la résolution automatique des conflits.

SnapshotMetadata

 SnapshotMetadata()

SnapshotMetadata

 SnapshotMetadata(
  std::shared_ptr< SnapshotMetadataImpl > impl
)

Construit un objet SnapshotMetadata à partir d'un shared_ptr vers un SnapshotMetadataImpl.

Destiné à un usage interne par l'API.

SnapshotMetadata

 SnapshotMetadata(
  const SnapshotMetadata & copy_from
)

Crée une copie d'un objet SnapshotMetadata existant.

SnapshotMetadata

 SnapshotMetadata(
  SnapshotMetadata && move_from
)

Déplace un objet SnapshotMetadata existant.

Valide

bool Valid() const

Renvoie la valeur "true" lorsque les métadonnées d'instantané renvoyées sont renseignées avec des données et accompagnées d'un état de réponse "réussite". "false" pour un instantané créé par l'utilisateur non renseigné ou pour un instantané renseigné avec un état de réponse "Échec".

Cette fonction doit renvoyer la valeur "true" pour que les fonctions getter (id, Name, Description, etc.) de cet instantané soient utilisables.

operator=

SnapshotMetadata & operator=(
  const SnapshotMetadata & copy_from
)

Attribue cet objet SnapshotMetadata en le copiant à partir d'un autre.

operator=

SnapshotMetadata & operator=(
  SnapshotMetadata && move_from
)

Attribue cet objet SnapshotMetadata en y déplaçant un autre objet.

~SnapshotMetadata

 ~SnapshotMetadata()