gpg:: SnapshotMetadata
#include <snapshot_metadata.h>
Eine einzelne Datenstruktur, mit der Sie auf Daten zum Status bestimmter Snapshot-Metadaten zugreifen können.
Zusammenfassung
Im Gegensatz zu anderen Werttypen ist ein SnapshotMetadata
nicht unbedingt unveränderlich. SnapshotManager
APIs können „geschlossen“ werden Snapshot, wobei das Ergebnis der Methode IsOpen() geändert wird Solche APIs erfordern allgemein, dass die SnapshotMetadata
in IsOpen() übergeben wird.
Konstruktoren und Zerstörer |
|
---|---|
SnapshotMetadata()
|
|
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
Konstruiert ein
SnapshotMetadata -Objekt aus einem shared_ptr -Element in ein SnapshotMetadataImpl -Element. |
|
SnapshotMetadata(const SnapshotMetadata & copy_from)
Erstellt eine Kopie eines vorhandenen
SnapshotMetadata -Objekts. |
|
SnapshotMetadata(SnapshotMetadata && move_from)
Verschiebt ein vorhandenes
SnapshotMetadata -Objekt. |
|
~SnapshotMetadata()
|
Öffentliche Funktionen |
|
---|---|
CoverImageURL() const
|
const std::string &
Gibt die URL des Titelbilds zurück.
|
Description() const
|
const std::string &
Gibt eine prägnante Beschreibung der Snapshot-Metadaten zurück.
|
FileName() const
|
const std::string &
Gibt den Dateinamen und die eindeutige ID des Snapshots zurück.
|
IsOpen() const
|
bool
Gibt "true" zurück, wenn die zurückgegebenen Snapshot-Metadaten mit übereinstimmenden Dateidaten geladen wurden.
|
LastModifiedTime() const
|
Gibt den Zeitpunkt der letzten Änderung des Eintrags zurück (ausgedrückt als Millisekunden seit der Unix-Epoche).
|
PlayedTime() const
|
Gibt die Wiedergabedauer zurück, die diesen Snapshot-Metadaten zugeordnet ist.
|
ProgressValue() const
|
int64_t
Gibt den festgelegten Fortschrittswert zurück, der diesen Snapshot-Metadaten zugeordnet ist.
|
Valid() const
|
bool
Gibt "true" zurück, wenn die zurückgegebenen Snapshot-Metadaten mit Daten gefüllt sind und eine erfolgreiche Antwort angezeigt wird. "false" für einen nicht ausgefüllten, vom Nutzer erstellten Snapshot oder für einen ausgefüllten Snapshot mit dem Status "Nicht bestanden".
|
operator=(const SnapshotMetadata & copy_from)
|
Weist dieses
SnapshotMetadata -Objekt durch Kopieren aus einem anderen Objekt zu. |
operator=(SnapshotMetadata && move_from)
|
Weist diesem
SnapshotMetadata -Objekt zu, indem ein anderes in das Objekt verschoben wird. |
Öffentliche Funktionen
CoverImageURL
const std::string & CoverImageURL() const
Gibt die URL des Titelbilds zurück.
Beschreibung
const std::string & Description() const
Gibt eine prägnante Beschreibung der Snapshot-Metadaten zurück.
SnapshotMetadata::Valid()
muss „true“ zurückgeben, damit diese Funktion verwendet werden kann.
FileName
const std::string & FileName() const
Gibt den Dateinamen und die eindeutige ID des Snapshots zurück.
Snapshot-Namen müssen 1 bis 100 Zeichen umfassen, die nicht mit einer URL reserviert sind (a–z, A–Z, 0–9 oder die Symbole „-“, „.“, „_“ oder „~“).
IsOpen
bool IsOpen() const
Gibt "true" zurück, wenn die zurückgegebenen Snapshot-Metadaten mit übereinstimmenden Dateidaten geladen wurden.
Datenbezogene Vorgänge wie Read
, Commit
und Resolve
funktionieren nur, wenn das Objekt Dateidaten enthält. Trotz des Werts „const“ ändert sich dieser Wert, um die zugrunde liegenden Daten der Snapshot-Metadaten widerzuspiegeln. Wenn Sie beispielsweise Commit
für den Vorgang aufrufen, gibt IsOpen() "false" zurück.
LastModifiedTime
Timestamp LastModifiedTime() const
Gibt den Zeitpunkt der letzten Änderung des Eintrags zurück (ausgedrückt als Millisekunden seit der Unix-Epoche).
PlayedTime
gpg::Duration PlayedTime() const
Gibt die Wiedergabedauer zurück, die diesen Snapshot-Metadaten zugeordnet ist.
ProgressValue
int64_t ProgressValue() const
Gibt den festgelegten Fortschrittswert zurück, der diesen Snapshot-Metadaten zugeordnet ist.
Der Fortschrittswert wird für die automatische Konfliktlösung verwendet.
SnapshotMetadata
SnapshotMetadata()
SnapshotMetadata
SnapshotMetadata( std::shared_ptr< SnapshotMetadataImpl > impl )
Konstruiert ein SnapshotMetadata
-Objekt aus einem shared_ptr
-Element in ein SnapshotMetadataImpl
-Element.
Vorgesehen für die interne Verwendung durch die API.
SnapshotMetadata
SnapshotMetadata( const SnapshotMetadata & copy_from )
Erstellt eine Kopie eines vorhandenen SnapshotMetadata
-Objekts.
SnapshotMetadata
SnapshotMetadata( SnapshotMetadata && move_from )
Verschiebt ein vorhandenes SnapshotMetadata
-Objekt.
Gültig
bool Valid() const
Gibt "true" zurück, wenn die zurückgegebenen Snapshot-Metadaten mit Daten gefüllt sind und eine erfolgreiche Antwort angezeigt wird. "false" für einen nicht ausgefüllten, vom Nutzer erstellten Snapshot oder für einen ausgefüllten Snapshot mit dem Status "Nicht bestanden".
Diese Funktion muss „true“ zurückgeben, damit die Getter-Funktionen (id
, Name
, Description
usw.) in diesem Snapshot verwendet werden können.
operator=
SnapshotMetadata & operator=( const SnapshotMetadata & copy_from )
Weist dieses SnapshotMetadata
-Objekt durch Kopieren aus einem anderen Objekt zu.
operator=
SnapshotMetadata & operator=( SnapshotMetadata && move_from )
Weist diesem SnapshotMetadata
-Objekt zu, indem ein anderes in das Objekt verschoben wird.
~SnapshotMetadata
~SnapshotMetadata()