gpg::SnapshotMetadata

#include <snapshot_metadata.h>

Un'unica struttura di dati che ti consente di accedere ai dati sullo stato di specifici metadati di snapshot.

Riepilogo

A differenza degli altri tipi di valore, un valore SnapshotMetadata non è strettamente immutabile. SnapshotManager API possono "chiudere" lo snapshot, modificando il risultato del metodo IsOpen(). API di questo tipo richiedono universalmente che SnapshotMetadata sia stato passato in IsOpen().

Costruttori e distruttori
SnapshotMetadata()
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
Crea un oggetto SnapshotMetadata da shared_ptr a 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 dello 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 dei 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 la durata di riproduzione associata 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 restituiti sono compilati con dati e sono accompagnati da uno stato di risposta riuscita; false per uno snapshot creato dall'utente non compilato o per uno snapshot compilato accompagnato da uno stato di risposta non riuscita.
operator=(const SnapshotMetadata & copy_from)
Assegna questo oggetto SnapshotMetadata copiandolo da un altro oggetto.
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 dello snapshot.

SnapshotMetadata::Valid() deve restituire true per consentire a questa funzione di essere utilizzabile.

Nome file

const std::string & FileName() const

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

I nomi degli snapshot devono essere compresi tra 1 e 100 caratteri non riservati all'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 dei file corrispondenti.

Le operazioni relative ai dati, come Read, Commit e Resolve, funzioneranno solo se l'oggetto contiene dati di file. Nonostante sia costante, questo valore cambia per riflettere i dati sottostanti dei metadati dello snapshot. Ad esempio, chiamando Commit sull'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 la durata di riproduzione associata 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 shared_ptr a SnapshotMetadataImpl.

Destinato per uso interno dall'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.

Valido

bool Valid() const

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

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

operator=

SnapshotMetadata & operator=(
  const SnapshotMetadata & copy_from
)

Assegna questo oggetto SnapshotMetadata copiandolo da un altro oggetto.

operator=

SnapshotMetadata & operator=(
  SnapshotMetadata && move_from
)

Assegna questo oggetto SnapshotMetadata spostandone un altro al suo interno.

~SnapshotMetadata

 ~SnapshotMetadata()