гпг:: Метаданные моментального снимка

#include <snapshot_metadata.h>

Единая структура данных, позволяющая получить доступ к данным о состоянии метаданных конкретного моментального снимка.

Краткое содержание

В отличие от других типов значений, SnapshotMetadata не является строго неизменяемым. API-интерфейсы SnapshotManager могут «закрыть» снимок, изменив результат метода IsOpen() ; такие API обычно требуют, чтобы SnapshotMetadata передавалась в IsOpen() .

Конструкторы и деструкторы

SnapshotMetadata ()
SnapshotMetadata (std::shared_ptr< SnapshotMetadataImpl > impl)
Создает объект SnapshotMetadata из shared_ptr в SnapshotMetadataImpl .
SnapshotMetadata (const SnapshotMetadata & copy_from)
Создает копию существующего объекта SnapshotMetadata .
SnapshotMetadata ( SnapshotMetadata && move_from)
Перемещает существующий объект SnapshotMetadata .
~SnapshotMetadata ()

Общественные функции

CoverImageURL () const
const std::string &
Возвращает URL изображения обложки.
Description () const
const std::string &
Возвращает краткое описание метаданных вашего снимка.
FileName () const
const std::string &
Возвращает имя файла и уникальный идентификатор снимка.
IsOpen () const
bool
Возвращает значение true, если возвращенные метаданные моментального снимка загружены с соответствующими данными файла.
LastModifiedTime () const
Возвращает время последнего изменения записи (выраженное в миллисекундах с эпохи Unix).
PlayedTime () const
Возвращает время воспроизведения, связанное с метаданными этого снимка.
ProgressValue () const
int64_t
Возвращает установленное значение прогресса, связанное с метаданными этого моментального снимка.
Valid () const
bool
Возвращает true, когда возвращаемые метаданные моментального снимка заполнены данными и сопровождаются статусом успешного ответа; false для незаполненного снимка, созданного пользователем, или для заполненного снимка, сопровождающегося статусом неудачного ответа.
operator= (const SnapshotMetadata & copy_from)
Назначает этот объект SnapshotMetadata путем копирования из другого.
operator= ( SnapshotMetadata && move_from)
Назначает этот объект SnapshotMetadata , перемещая в него другой объект.

Общественные функции

URL-адрес изображения обложки 

const std::string & CoverImageURL() const

Возвращает URL изображения обложки.

Описание 

const std::string & Description() const

Возвращает краткое описание метаданных вашего снимка.

SnapshotMetadata::Valid() должен возвращать true, чтобы эту функцию можно было использовать.

Имя файла 

const std::string & FileName() const

Возвращает имя файла и уникальный идентификатор снимка.

Имена снимков должны содержать от 1 до 100 символов, не зарезервированных для URL-адреса (az, AZ, 0–9 или символы «-», «.», «_» или «~»).

Открыт 

bool IsOpen() const

Возвращает значение true, если возвращенные метаданные моментального снимка загружены с соответствующими данными файла.

Операции, связанные с данными, такие как Read , Commit и Resolve будут работать только в том случае, если объект имеет данные файла. Несмотря на то, что это значение является константным, оно изменяется, отражая базовые данные метаданных моментального снимка. Например, вызов Commit для операции приведет к тому, что IsOpen() вернет false;

Ластмодифицированноевремя 

Timestamp LastModifiedTime() const

Возвращает время последнего изменения записи (выраженное в миллисекундах с эпохи Unix).

Сыгранноевремя 

gpg::Duration PlayedTime() const

Возвращает время воспроизведения, связанное с метаданными этого снимка.

Прогрессвалуе 

int64_t ProgressValue() const

Возвращает установленное значение прогресса, связанное с метаданными этого моментального снимка.

Значение прогресса используется при автоматическом разрешении конфликтов.

Метаданные моментального снимка 

 SnapshotMetadata()

Метаданные моментального снимка 

 SnapshotMetadata(
  std::shared_ptr< SnapshotMetadataImpl > impl
)

Создает объект SnapshotMetadata из shared_ptr в SnapshotMetadataImpl .

Предназначен для внутреннего использования API.

Метаданные моментального снимка 

 SnapshotMetadata(
  const SnapshotMetadata & copy_from
)

Создает копию существующего объекта SnapshotMetadata .

Метаданные моментального снимка 

 SnapshotMetadata(
  SnapshotMetadata && move_from
)

Перемещает существующий объект SnapshotMetadata .

Действительный 

bool Valid() const

Возвращает true, когда возвращаемые метаданные моментального снимка заполнены данными и сопровождаются статусом успешного ответа; false для незаполненного снимка, созданного пользователем, или для заполненного снимка, сопровождающегося статусом неудачного ответа.

Эта функция должна возвращать true, чтобы функции получения ( id , Name , Description и т. д.) в этом моментальном снимке были пригодными для использования.

оператор= 

SnapshotMetadata & operator=(
  const SnapshotMetadata & copy_from
)

Назначает этот объект SnapshotMetadata путем копирования из другого.

оператор= 

SnapshotMetadata & operator=(
  SnapshotMetadata && move_from
)

Назначает этот объект SnapshotMetadata , перемещая в него другой объект.

~Метаданные моментального снимка 

 ~SnapshotMetadata()