gpg:: SnapshotMetadata
#include <snapshot_metadata.h>
يشير ذلك المصطلح إلى هيكل بيانات واحد يتيح لك الوصول إلى البيانات المتعلّقة بحالة بيانات وصفية خاصة بلقطة شاشة.
ملخّص
على عكس أنواع القيم الأخرى، لا يمكن تغيير SnapshotMetadata
تمامًا. بإمكان واجهات برمجة التطبيقات SnapshotManager
"إغلاق" النبذة، وتغيير نتيجة طريقة IsOpen(). وتتطلب واجهات برمجة التطبيقات هذه بشكل عام تمرير SnapshotMetadata
في IsOpen().
الدلالة والهياكل |
|
---|---|
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
|
تعرض الوقت الذي تم فيه آخر تعديل للإدخال (ويتم التعبير عنه بالمللي ثانية منذ حقبة يونكس).
|
PlayedTime() const
|
تعرض وقت التشغيل المرتبط بالبيانات الوصفية للنبذة.
|
ProgressValue() const
|
int64_t
تعرض قيمة التقدم المحددة المرتبطة بالبيانات الوصفية للنبذة هذه.
|
Valid() const
|
bool
تعرِض القيمة "صحيح" عندما تتم تعبئة البيانات الوصفية لللقطة المعروضة بالبيانات وتكون مصحوبة بحالة استجابة ناجحة، أو القيمة "خطأ" للقطة أنشأها المستخدم أو للقطة تمت تعبئتها مصحوبة بحالة استجابة غير ناجحة.
|
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
تعرض اسم الملف والمعرّف الفريد للقطة.
يجب أن تتراوح أسماء اللقطات بين حرف واحد و100 حرف غير محجوز لعنوان URL (من a إلى z أو من A إلى Z أو من 0 إلى 9 أو الرموز "-" أو "." أو "_" أو "~").
IsOpen
bool IsOpen() const
تعرض القيمة true عندما يتم تحميل البيانات الوصفية لللقطة المعروضة مع بيانات ملف مطابقة.
لن تعمل العمليات المتعلّقة بالبيانات، مثل Read
وCommit
وResolve
، إلا إذا كان الكائن يحتوي على بيانات ملف. وعلى الرغم من كونها ثابتة، تتغير هذه القيمة لتعكس البيانات الأساسية لبيانات التعريف الخاصة باللقطة. على سبيل المثال، سيؤدي استدعاء الدالة Commit
في العملية إلى عرض خطأ IsOpen() الناتج عن ذلك،
LastModifiedTime
Timestamp LastModifiedTime() const
تعرض الوقت الذي تم فيه آخر تعديل للإدخال (ويتم التعبير عنه بالمللي ثانية منذ حقبة يونكس).
ProgressValue
int64_t ProgressValue() const
تعرض قيمة التقدم المحددة المرتبطة بالبيانات الوصفية للنبذة هذه.
يتم استخدام قيمة التقدم في حل التعارض التلقائي.
SnapshotMetadata
SnapshotMetadata()
SnapshotMetadata
SnapshotMetadata( std::shared_ptr< SnapshotMetadataImpl > impl )
تنشئ هذه الدالة كائن SnapshotMetadata
من shared_ptr
إلى SnapshotMetadataImpl
.
مخصَّصة للاستخدام الداخلي من قِبل واجهة برمجة التطبيقات.
SnapshotMetadata
SnapshotMetadata( const SnapshotMetadata & copy_from )
تنشئ نسخة من عنصر SnapshotMetadata
حالي.
صالحة
bool Valid() const
تعرِض القيمة "صحيح" عندما تتم تعبئة البيانات الوصفية لللقطة المعروضة بالبيانات وتكون مصحوبة بحالة استجابة ناجحة، أو القيمة "خطأ" للقطة أنشأها المستخدم أو للقطة تمت تعبئتها مصحوبة بحالة استجابة غير ناجحة.
يجب أن تعرض هذه الدالة true بالنسبة إلى دوال getter (id
، وName
، وDescription
، وما إلى ذلك) في هذه اللقطة لتكون قابلة للاستخدام.
r=or
SnapshotMetadata & operator=( const SnapshotMetadata & copy_from )
تتيح تخصيص كائن SnapshotMetadata
هذا من خلال نسخه من عنصر آخر.
r=or
SnapshotMetadata & operator=( SnapshotMetadata && move_from )
تحدّد هذه السمة كائن SnapshotMetadata
هذا من خلال نقل عنصر آخر إليه.
~SnapshotMetadata
~SnapshotMetadata()