gpg::SnapshotMetadata

#include <snapshot_metadata.h>

Una sola estructura de datos que te permite acceder a datos sobre el estado de los metadatos de una instantánea específica.

Resumen

A diferencia de otros tipos de valores, un SnapshotMetadata no es estrictamente inmutable. Las APIs de SnapshotManager pueden "cerrar" la instantánea, lo que cambia el resultado del método IsOpen(). Estas APIs requieren de forma universal que el SnapshotMetadata se pase en IsOpen().

Constructores y destructores
SnapshotMetadata()
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
Construye un objeto SnapshotMetadata de un shared_ptr a un SnapshotMetadataImpl.
SnapshotMetadata(const SnapshotMetadata & copy_from)
Crea una copia de un objeto SnapshotMetadata existente.
SnapshotMetadata(SnapshotMetadata && move_from)
Mueve un objeto SnapshotMetadata existente.
~SnapshotMetadata()

Funciones públicas
CoverImageURL() const
const std::string &
Muestra la URL de la imagen de portada.
Description() const
const std::string &
Muestra una descripción concisa de los metadatos de tu instantánea.
FileName() const
const std::string &
Muestra el nombre del archivo y el identificador único de la instantánea.
IsOpen() const
bool
Muestra verdadero cuando los metadatos de la instantánea que se muestra se cargaron con datos de archivos coincidentes.
LastModifiedTime() const
Muestra la hora en la que se modificó la entrada por última vez (expresada en milisegundos desde la época Unix).
PlayedTime() const
Muestra la duración reproducida asociada con estos metadatos de instantánea.
ProgressValue() const
int64_t
Muestra el valor de progreso establecido asociado con estos metadatos de instantánea.
Valid() const
bool
Muestra verdadero cuando los metadatos de la instantánea que se muestra se propagan con datos y se acompañan de un estado de respuesta correcto; muestra falso para una instantánea creada por el usuario que no se propagó o para una que sí se propagó y se acompaña de un estado de respuesta incorrecto.
operator=(const SnapshotMetadata & copy_from)
Asigna este objeto SnapshotMetadata copiando de otro.
operator=(SnapshotMetadata && move_from)
Asigna este objeto SnapshotMetadata moviendo otro dentro de él.

Funciones públicas

CoverImageURL

const std::string & CoverImageURL() const

Muestra la URL de la imagen de portada.

Descripción

const std::string & Description() const

Muestra una descripción concisa de los metadatos de tu instantánea.

SnapshotMetadata::Valid() debe mostrar verdadero para que esta función se pueda usar.

FileName

const std::string & FileName() const

Muestra el nombre del archivo y el identificador único de la instantánea.

Los nombres de las instantáneas deben tener entre 1 y 100 caracteres que no estén reservados para URLs (a-z, A-Z, 0-9 o los símbolos "-", ".", "_" o "~").

IsOpen

bool IsOpen() const

Muestra verdadero cuando los metadatos de la instantánea que se muestra se cargaron con datos de archivos coincidentes.

Las operaciones relacionadas con los datos, como Read, Commit y Resolve, solo funcionarán si el objeto tiene datos de archivos. A pesar de ser const, este valor cambia para reflejar los datos subyacentes de los metadatos de la instantánea. Por ejemplo, si llamas a Commit en la operación, IsOpen() mostrará un valor falso.

LastModifiedTime

Timestamp LastModifiedTime() const

Muestra la hora en la que se modificó la entrada por última vez (expresada en milisegundos desde la época Unix).

PlayedTime

gpg::Duration PlayedTime() const

Muestra la duración reproducida asociada con estos metadatos de instantánea.

ProgressValue

int64_t ProgressValue() const

Muestra el valor de progreso establecido asociado con estos metadatos de instantánea.

El valor de progreso se usa en la resolución automática de conflictos.

SnapshotMetadata

 SnapshotMetadata()

SnapshotMetadata

 SnapshotMetadata(
  std::shared_ptr< SnapshotMetadataImpl > impl
)

Construye un objeto SnapshotMetadata de un shared_ptr a un SnapshotMetadataImpl.

Está destinado al uso interno de la API.

SnapshotMetadata

 SnapshotMetadata(
  const SnapshotMetadata & copy_from
)

Crea una copia de un objeto SnapshotMetadata existente.

SnapshotMetadata

 SnapshotMetadata(
  SnapshotMetadata && move_from
)

Mueve un objeto SnapshotMetadata existente.

Válido

bool Valid() const

Muestra verdadero cuando los metadatos de la instantánea que se muestra se propagan con datos y se acompañan de un estado de respuesta correcto; muestra falso para una instantánea creada por el usuario que no se propagó o para una que sí se propagó y se acompaña de un estado de respuesta incorrecto.

Esta función debe mostrar un valor verdadero para que las funciones de obtención (id, Name, Description, etcétera) de esta instantánea se puedan usar.

operador=

SnapshotMetadata & operator=(
  const SnapshotMetadata & copy_from
)

Asigna este objeto SnapshotMetadata copiando de otro.

operador=

SnapshotMetadata & operator=(
  SnapshotMetadata && move_from
)

Asigna este objeto SnapshotMetadata moviendo otro dentro de él.

~SnapshotMetadata

 ~SnapshotMetadata()