מצלמה.listimages

הצגת כל התמונות במצלמה. הפקודה הזו הוצאה משימוש ברמת API 2. במקומו יש להשתמש במאפיין camera.listFiles.

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

פרמטרים

  • entryCount: מספר הרשומות שיוחזרו.
  • maxSize: הגודל המקסימלי של תמונות ממוזערות; max(thumbnail_width, picture_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: (אופציונלי) צריך להגדיר רק אם התוצאה לא מלאה (incomplete – כל דף אפליקציה שלא כולל את התמונה האחרונה). כדי לאחזר את הערכים שנותרו, הלקוח צריך להפעיל שוב את הפקודה listImages עם האסימון.

שגיאות

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

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."
    }
}