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 den Snapshot „schließen“ und so das Ergebnis der Methode IsOpen() ändern. Diese APIs erfordern grundsätzlich, dass die in IsOpen() übergebene SnapshotMetadata übergeben wird.

Konstruktoren und Zerstörer
SnapshotMetadata()
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
Erstellt ein SnapshotMetadata-Objekt aus einer shared_ptr in eine SnapshotMetadataImpl.
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 für das Titelbild zurück.
Description() const
const std::string &
Gibt eine kurze Beschreibung Ihrer Snapshot-Metadaten zurück.
FileName() const
const std::string &
Gibt den Dateinamen und die eindeutige Kennung 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 zurück, zu dem der Eintrag zuletzt geändert wurde (in Millisekunden seit der Unix-Epoche).
PlayedTime() const
Gibt die Wiedergabezeit zurück, die mit diesen Snapshot-Metadaten verknüpft ist.
ProgressValue() const
int64_t
Gibt den festgelegten Fortschrittswert zurück, der mit diesen Snapshot-Metadaten verknüpft 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 einen ausgefüllten Snapshot mit dem Status „Fehlgeschlagene Antwort“.
operator=(const SnapshotMetadata & copy_from)
Weist dieses SnapshotMetadata-Objekt durch Kopieren aus einem anderen Objekt zu.
operator=(SnapshotMetadata && move_from)
Weist dieses SnapshotMetadata-Objekt zu, indem ein anderes dorthin verschoben wird.

Öffentliche Funktionen

CoverImageURL

const std::string & CoverImageURL() const

Gibt die URL für das Titelbild zurück.

Beschreibung

const std::string & Description() const

Gibt eine kurze Beschreibung Ihrer Snapshot-Metadaten zurück.

Für SnapshotMetadata::Valid() muss „true“ zurückgegeben werden, damit diese Funktion verwendet werden kann.

FileName

const std::string & FileName() const

Gibt den Dateinamen und die eindeutige Kennung des Snapshots zurück.

Snapshot-Namen müssen 1 bis 100 Zeichen lang sein, die nicht für URLs 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 der Konsistenz ändert sich dieser Wert, um die zugrunde liegenden Daten der Snapshot-Metadaten widerzuspiegeln. Wenn beispielsweise Commit für den Vorgang aufgerufen wird, gibt IsOpen() den Wert „false“ zurück.

LastModifiedTime

Timestamp LastModifiedTime() const

Gibt den Zeitpunkt zurück, zu dem der Eintrag zuletzt geändert wurde (in Millisekunden seit der Unix-Epoche).

PlayedTime

gpg::Duration PlayedTime() const

Gibt die Wiedergabezeit zurück, die mit diesen Snapshot-Metadaten verknüpft ist.

ProgressValue

int64_t ProgressValue() const

Gibt den festgelegten Fortschrittswert zurück, der mit diesen Snapshot-Metadaten verknüpft ist.

Der Fortschrittswert wird bei der automatischen Konfliktlösung verwendet.

SnapshotMetadata

 SnapshotMetadata()

SnapshotMetadata

 SnapshotMetadata(
  std::shared_ptr< SnapshotMetadataImpl > impl
)

Erstellt ein SnapshotMetadata-Objekt aus einer shared_ptr in eine SnapshotMetadataImpl.

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 einen ausgefüllten Snapshot mit dem Status „Fehlgeschlagene Antwort“.

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 dieses SnapshotMetadata-Objekt zu, indem ein anderes dorthin verschoben wird.

~SnapshotMetadata

 ~SnapshotMetadata()