מצלמה.listimages

בתיבת הדו-שיח הזו מפורטים כל התמונות במצלמה. הפקודה הזו הוצאה משימוש ברמת API 2. במקומם יש להשתמש ב-camera.listFiles.

אם מצלמה לא תומכת בפרמטרים המבוקשים, היא חייבת להחזיר את יכולת מקסימלית שזמינה לחומרה. לדוגמה, מקרה נדיר הבקשה: {entryCount: 500, maxSize: 2000}. במקום לזרוק הודעת שגיאה, התגובה צריכה להתבסס על היכולת המקסימלית שנתמכת על ידי המצלמה, למשל: {entryCount: 100, maxSize: 200}. יש לשלוח שגיאות לגבי כל שאר מקרים נוספים; לדוגמה, כשהבקשה היא {entryCount: 500, maxSize: -500}, היא אמורה להקפיץ את השגיאה invalidParameterValue כי maxSize הוא שלילי.

פרמטרים

  • entryCount: מספר הרשומות הרצוי שיוחזרו.
  • maxSize: הגודל המקסימלי של תמונות ממוזערות; max(thumbnail_width, JPEG_height) נדרש רק אם הערך של includeThumb הוא True (בהמשך).
  • continuationToken: (אופציונלי) אסימון המשך אטום מסוג מחרוזת מסוג, שהוחזר על ידי קריאת listImages הקודמת, ומשמש לאחזור התמונות הבאות. יש להשמיט את הפרמטר הזה בקריאה הראשונה ל-listImages. הערה: המצלמה אחראית לאלגוריתם שיוצר את האסימון.
  • includeThumb: (אופציונלי) ברירת המחדל היא true. משתמשים ב-false כדי להשמיט תמונות ממוזערות מהתוצאה.

תוצאות

  • רשומות: רשימה של מאפיינים של תמונות. כל רשומה צריכה להכיל את השדות הבאים מלבד קו רוחב וקו אורך, שהם אופציונליים:
    • name: שם
    • uri: URI
    • size: גודל בבייטים
    • dateTimeZone: התאריך, השעה ואזור הזמן של התמונה, בפורמט: YYYY:MM:DD HH:MM:SS+(-)HH:MM. יש להשתמש בפורמט של 24 שעות לשעה. התאריך השעה מופרדת על ידי שדה ריק . אזור הזמן מקוזז משעון UTC.
    • lat: (אופציונלי) קו הרוחב של מיקום צילום התמונה.
    • lng: (אופציונלי) קו האורך של מיקום התמונה.
    • width: רוחב התמונה
    • height: גובה התמונה
    • thumbnail: מחרוזת בקידוד Base64 לתמונה ממוזערת (כאשר includeThumb == true).
  • totalEntries: מספר הרשומות הכולל באחסון.
  • continuationToken: (אופציונלי) יש להגדיר רק אם התוצאה חלקית (המשמעות של חסר היא כל כרטיס מוצר שלא כולל את התמונה האחרונה). כדי לאחזר את הפריטים שנותרו רשומות, הלקוח צריך לקרוא לפקודה listImages שוב עם האסימון.

שגיאות

  • missingParameter: פרמטר נדרש לא צוין; לדוגמה, entryCount לא צוין.
  • falseParameterName: השם של פרמטר הקלט הוא לא מזוהה.
  • invalidParameterValue: שם פרמטר הקלט הוא מזוהה, אבל הערך שלו לא חוקי. לדוגמה, השדה continuationToken לא קיים, הוא מחוץ לטווח, הנתונים שלו הסוג שגוי, סוג הנתונים של includeThumb שגוי, או סוג הנתונים של maxSize שגוי כשהערך של includeThumb הוא נכון.

Command I/O
קלט פקודה 
{
    "parameters": {
        "entryCount": 50,
        "maxSize": 100,
        "includeThumb": true
    }
}
פלט הפקודה 
{
    "results": {
        "entries": [
            {
                "name": "abc",
                "uri": "image URI",
                "size": image size in bytes,
                "dateTimeZone": "2014:12:27 08:00:00+08:00"
                "lat": 50.5324
                "lng": -120.2332
                "width": 2000
                "height": 1000
                "thumbnail": "ENCODEDSTRING"
            }
            ...
            {
                ...
            }
        ],
        "totalEntries": 250,
        "continuationToken": "50"
    }
}
פלט הפקודה (שגיאה) 
{
    "error": {
        "code": "invalidParameterValue",
        "message": "Parameter continuationToken is out of range."
    }
}