gpg:: SnapshotMetadata
#include <snapshot_metadata.h>
特定のスナップショット メタデータのステータスに関するデータにアクセスできる単一のデータ構造。
概要
他の値の型とは異なり、SnapshotMetadata
は厳密には不変ではありません。SnapshotManager
API はスナップショットを「クローズ」し、IsOpen() メソッドの結果を変更できます。このような API は普遍的に IsOpen() で渡される SnapshotMetadata
を必要とします。
コンストラクタとデストラクタ |
|
---|---|
SnapshotMetadata()
|
|
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
|
|
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 が返されます。そうでない場合は、レスポンスの失敗ステータスが伴う場合は false が返されます。
|
operator=(const SnapshotMetadata & copy_from)
|
この
SnapshotMetadata オブジェクトを別のオブジェクトからコピーして割り当てます。 |
operator=(SnapshotMetadata && move_from)
|
この
SnapshotMetadata オブジェクトに別のオブジェクトを移動して割り当てます。 |
パブリック関数
CoverImageURL
const std::string & CoverImageURL() const
表紙画像の URL を返します。
説明
const std::string & Description() const
スナップショットのメタデータの簡潔な説明を返します。
この関数を使用できるようにするには、SnapshotMetadata::Valid()
が true を返す必要があります。
FileName
const std::string & FileName() const
スナップショットのファイル名と一意の識別子を返します。
スナップショット名は、URL 予約されていない 1 ~ 100 文字(a ~ z、A ~ Z、0 ~ 9、または記号「-」、「.」、「_」、「~」)で指定してください。
IsOpen
bool IsOpen() const
返されたスナップショット メタデータが一致するファイルデータで読み込まれると、true を返します。
Read
、Commit
、Resolve
などのデータ関連のオペレーションは、オブジェクトにファイルデータがある場合にのみ機能します。この値は定数ですが、スナップショット メタデータの基盤となるデータを反映するように変化します。たとえば、オペレーションで Commit
を呼び出すと、IsOpen() が false を返します。
ProgressValue
int64_t ProgressValue() const
このスナップショット メタデータに関連付けられている設定済みの進行状況の値を返します。
進行状況の値は、競合の自動解決で使用されます。
SnapshotMetadata
SnapshotMetadata()
SnapshotMetadata
SnapshotMetadata( std::shared_ptr< SnapshotMetadataImpl > impl )
shared_ptr
から SnapshotMetadataImpl
への SnapshotMetadata
オブジェクトを作成します。
API による内部使用を対象としています。
SnapshotMetadata
SnapshotMetadata( const SnapshotMetadata & copy_from )
既存の SnapshotMetadata
オブジェクトのコピーを作成します。
SnapshotMetadata
SnapshotMetadata( SnapshotMetadata && move_from )
既存の SnapshotMetadata
オブジェクトを移動します。
有効
bool Valid() const
返されたスナップショット メタデータにデータが入力され、成功のレスポンス ステータスが付随する場合は true が返されます。ユーザーが作成したスナップショットにデータが入力されていない場合は、false が返されます。そうでない場合は、レスポンスの失敗ステータスが伴う場合は false が返されます。
このスナップショットのゲッター関数(id
、Name
、Description
など)を使用できるようにするには、この関数は true を返す必要があります。
演算子=
SnapshotMetadata & operator=( const SnapshotMetadata & copy_from )
この SnapshotMetadata
オブジェクトを別のオブジェクトからコピーして割り当てます。
演算子=
SnapshotMetadata & operator=( SnapshotMetadata && move_from )
この SnapshotMetadata
オブジェクトに別のオブジェクトを移動して割り当てます。
~SnapshotMetadata
~SnapshotMetadata()