gpg::SnapshotMetadata

#include <snapshot_metadata.h>

Uma única estrutura de dados que permite acessar dados sobre o status de metadados de um snapshot específico.

Resumo

Ao contrário de outros tipos de valor, um SnapshotMetadata não é estritamente imutável. As APIs SnapshotManager podem "fechar" o snapshot, mudando o resultado do método IsOpen(). Essas APIs exigem que o SnapshotMetadata seja transmitido em IsOpen().

Construtores e destrutores
SnapshotMetadata()
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
Cria um objeto SnapshotMetadata de um shared_ptr para um SnapshotMetadataImpl.
SnapshotMetadata(const SnapshotMetadata & copy_from)
Cria uma cópia de um objeto SnapshotMetadata existente.
SnapshotMetadata(SnapshotMetadata && move_from)
Move um objeto SnapshotMetadata já existente.
~SnapshotMetadata()

Funções públicas
CoverImageURL() const
const std::string &
Retorna o URL da imagem da capa.
Description() const
const std::string &
Retorna uma descrição concisa dos metadados do snapshot.
FileName() const
const std::string &
Retorna o nome do arquivo e o identificador exclusivo do snapshot.
IsOpen() const
bool
Retorna verdadeiro quando os metadados do snapshot retornados tiverem sido carregados com os dados do arquivo correspondentes.
LastModifiedTime() const
Retorna a hora em que a entrada foi modificada pela última vez (expressa em milissegundos desde a época Unix).
PlayedTime() const
Retorna o tempo de reprodução associado aos metadados desse snapshot.
ProgressValue() const
int64_t
Retorna o valor de progresso definido associado aos metadados desse snapshot.
Valid() const
bool
Retorna verdadeiro quando os metadados de snapshot retornados são preenchidos com dados e são acompanhados por um status de resposta bem-sucedida; "false", para um snapshot não preenchido criado pelo usuário ou para um preenchido acompanhado por um status de resposta malsucedida.
operator=(const SnapshotMetadata & copy_from)
Atribui este objeto SnapshotMetadata copiando de outro.
operator=(SnapshotMetadata && move_from)
Atribui este objeto SnapshotMetadata movendo outro para dentro dele.

Funções públicas

CoverImageURL

const std::string & CoverImageURL() const

Retorna o URL da imagem da capa.

Descrição

const std::string & Description() const

Retorna uma descrição concisa dos metadados do snapshot.

SnapshotMetadata::Valid() precisa retornar verdadeiro para que essa função seja utilizável.

FileName

const std::string & FileName() const

Retorna o nome do arquivo e o identificador exclusivo do snapshot.

Os nomes dos snapshots precisam ter entre 1 e 100 caracteres não reservados para o URL (a-z, A-Z, 0-9 ou os símbolos "-", ".", "_" ou "~").

IsOpen

bool IsOpen() const

Retorna verdadeiro quando os metadados do snapshot retornados tiverem sido carregados com os dados do arquivo correspondentes.

Operações relacionadas a dados, como Read, Commit e Resolve, só vão funcionar se o objeto tiver dados de arquivo. Apesar de ser constante, esse valor muda para refletir os dados subjacentes dos metadados do snapshot. Por exemplo, chamar Commit na operação fará com que IsOpen() retorne um valor falso;

LastModifiedTime

Timestamp LastModifiedTime() const

Retorna a hora em que a entrada foi modificada pela última vez (expressa em milissegundos desde a época Unix).

PlayedTime

gpg::Duration PlayedTime() const

Retorna o tempo de reprodução associado aos metadados desse snapshot.

ProgressValue

int64_t ProgressValue() const

Retorna o valor de progresso definido associado aos metadados desse snapshot.

O valor do progresso é usado na resolução automática de conflitos.

SnapshotMetadata

 SnapshotMetadata()

SnapshotMetadata

 SnapshotMetadata(
  std::shared_ptr< SnapshotMetadataImpl > impl
)

Cria um objeto SnapshotMetadata de um shared_ptr para um SnapshotMetadataImpl.

Destinado ao uso interno da API.

SnapshotMetadata

 SnapshotMetadata(
  const SnapshotMetadata & copy_from
)

Cria uma cópia de um objeto SnapshotMetadata existente.

SnapshotMetadata

 SnapshotMetadata(
  SnapshotMetadata && move_from
)

Move um objeto SnapshotMetadata já existente.

Válida

bool Valid() const

Retorna verdadeiro quando os metadados de snapshot retornados são preenchidos com dados e são acompanhados por um status de resposta bem-sucedida; "false", para um snapshot não preenchido criado pelo usuário ou para um preenchido acompanhado por um status de resposta malsucedida.

Essa função precisa retornar verdadeiro para que as funções getter (id, Name, Description etc.) nesse snapshot possam ser usadas.

operador=

SnapshotMetadata & operator=(
  const SnapshotMetadata & copy_from
)

Atribui este objeto SnapshotMetadata copiando de outro.

operador=

SnapshotMetadata & operator=(
  SnapshotMetadata && move_from
)

Atribui este objeto SnapshotMetadata movendo outro para dentro dele.

~SnapshotMetadata

 ~SnapshotMetadata()