gpg::SnapshotMetadata

#include <snapshot_metadata.h>

Una singola struttura di dati che consente di accedere ai dati sullo stato dei metadati di uno snapshot specifico.

Riepilogo

A differenza di altri tipi di valori, SnapshotMetadata non è rigorosamente immutabile. Le API di SnapshotManager possono "chiudere" lo snapshot, modificando il risultato del metodo IsOpen(). Queste API richiedono universalmente che il valore SnapshotMetadata sia passato a IsOpen().

Costruttori e distruttori
SnapshotMetadata()
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
Crea un oggetto SnapshotMetadata da un shared_ptr a un SnapshotMetadataImpl.
SnapshotMetadata(const SnapshotMetadata & copy_from)
Crea una copia di un oggetto SnapshotMetadata esistente.
SnapshotMetadata(SnapshotMetadata && move_from)
Sposta un oggetto SnapshotMetadata esistente.
~SnapshotMetadata()

Funzioni pubbliche
CoverImageURL() const
const std::string &
Restituisce l'URL dell'immagine di copertina.
Description() const
const std::string &
Restituisce una descrizione concisa dei metadati degli snapshot.
FileName() const
const std::string &
Restituisce il nome del file e l'identificatore univoco dello snapshot.
IsOpen() const
bool
Restituisce true quando i metadati dello snapshot restituiti sono stati caricati con dati del file corrispondenti.
LastModifiedTime() const
Restituisce l'ora in cui la voce è stata modificata per l'ultima volta (espressa in millisecondi dall'epoca di Unix).
PlayedTime() const
Restituisce il tempo di riproduzione associato ai metadati di questo snapshot.
ProgressValue() const
int64_t
Restituisce il valore di avanzamento impostato associato ai metadati di questo snapshot.
Valid() const
bool
Restituisce true quando i metadati dello snapshot restituito sono completati con dati e sono accompagnati da uno stato di risposta riuscita; false per uno snapshot non compilato creato dall'utente o per uno snapshot completato accompagnato da uno stato di risposta non riuscita.
operator=(const SnapshotMetadata & copy_from)
Assegna questo oggetto SnapshotMetadata copiandolo da un altro.
operator=(SnapshotMetadata && move_from)
Assegna questo oggetto SnapshotMetadata spostandone un altro al suo interno.

Funzioni pubbliche

CoverImageURL

const std::string & CoverImageURL() const

Restituisce l'URL dell'immagine di copertina.

Descrizione

const std::string & Description() const

Restituisce una descrizione concisa dei metadati degli snapshot.

SnapshotMetadata::Valid() deve restituire true affinché questa funzione sia utilizzabile.

FileName

const std::string & FileName() const

Restituisce il nome del file e l'identificatore univoco dello snapshot.

I nomi degli snapshot devono contenere da 1 a 100 caratteri non riservati agli URL (a-z, A-Z, 0-9 o i simboli "-", ".", "_" o "~").

IsOpen

bool IsOpen() const

Restituisce true quando i metadati dello snapshot restituiti sono stati caricati con dati del file corrispondenti.

Le operazioni relative ai dati, come Read, Commit e Resolve, funzioneranno solo se l'oggetto contiene dati dei file. Nonostante sia costante, questo valore cambia per riflettere i dati sottostanti dei metadati dello snapshot. Ad esempio, se chiami Commit nell'operazione, IsOpen() restituirà false;

LastModifiedTime

Timestamp LastModifiedTime() const

Restituisce l'ora in cui la voce è stata modificata per l'ultima volta (espressa in millisecondi dall'epoca di Unix).

PlayedTime

gpg::Duration PlayedTime() const

Restituisce il tempo di riproduzione associato ai metadati di questo snapshot.

ProgressValue

int64_t ProgressValue() const

Restituisce il valore di avanzamento impostato associato ai metadati di questo snapshot.

Il valore dell'avanzamento viene utilizzato nella risoluzione automatica dei conflitti.

SnapshotMetadata

 SnapshotMetadata()

SnapshotMetadata

 SnapshotMetadata(
  std::shared_ptr< SnapshotMetadataImpl > impl
)

Crea un oggetto SnapshotMetadata da un shared_ptr a un SnapshotMetadataImpl.

Destinato all'uso interno da parte dell'API.

SnapshotMetadata

 SnapshotMetadata(
  const SnapshotMetadata & copy_from
)

Crea una copia di un oggetto SnapshotMetadata esistente.

SnapshotMetadata

 SnapshotMetadata(
  SnapshotMetadata && move_from
)

Sposta un oggetto SnapshotMetadata esistente.

Valida

bool Valid() const

Restituisce true quando i metadati dello snapshot restituito sono completati con dati e sono accompagnati da uno stato di risposta riuscita; false per uno snapshot non compilato creato dall'utente o per uno snapshot completato accompagnato da uno stato di risposta non riuscita.

Affinché le funzioni getter (id, Name, Description e così via) in questo snapshot siano utilizzabili, questa funzione deve restituire true.

operatore=

SnapshotMetadata & operator=(
  const SnapshotMetadata & copy_from
)

Assegna questo oggetto SnapshotMetadata copiandolo da un altro.

operatore=

SnapshotMetadata & operator=(
  SnapshotMetadata && move_from
)

Assegna questo oggetto SnapshotMetadata spostandone un altro al suo interno.

~SnapshotMetadata

 ~SnapshotMetadata()