דף זה תורגם על ידי Cloud Translation API.

ResApiHelper

public class RestApiHelper
extends Object implements IRestApiHelper

JavaScript.lang.Object
↳	com.android.tradefed.util.RestApiHelper

מחלקה מסייעת לביצוע קריאות ל-API ל-REST.

סיכום

קבועים
`int`	`DEFAULT_NUMBER_OF_RETRIES`

שדות
`protected static final JsonFactory`	`JSON_FACTORY`
`protected static final String`	`JSON_MIME`

בנאים ציבוריים
`RestApiHelper(HttpRequestFactory requestFactory, String baseUri)` יצירת מכונה של עוזר API עם המידע הנתון.

שיטות ציבוריות
`GenericUrl`	`buildQueryUri(String[] uriParts, options)` בנייה של URI לקריאה ל-API עם חלקים ואפשרויות URI נתונים.
`HttpResponse`	`execute(String method, String[] uriParts, options, JSONObject data)` מפעיל בקשת API.
`HttpRequestFactory`	`getRequestFactory()` מחזירה את הערך HttpRequestRequest במפעל.
`static RestApiHelper`	`newInstanceWithGoogleCredential(String baseUri, File jsonKeyFile, scopes)` יוצרת מכונה של עוזר API שמשתמש ב-`Credential` לצורך אימות.

protected static final int DEFAULT_NUMBER_OF_RETRIES

ערך קבוע: 2 (0x00000002)

protected static final JsonFactory JSON_FACTORY

protected static final String JSON_MIME

public RestApiHelper (HttpRequestFactory requestFactory, 
                String baseUri)

יצירת מכונה של עוזר API עם המידע הנתון.

פרמטרים
`requestFactory`	`HttpRequestFactory`: המפעל שבו צריך להשתמש במהלך יצירת `HttpRequest`.
`baseUri`	`String`: ה-URI הבסיסי של API

public GenericUrl buildQueryUri (String[] uriParts, 
                 options)

בנייה של URI לקריאה ל-API עם חלקים ואפשרויות URI נתונים. URIParts צריך להיות כתובות ה-URL כבר מקודדות, אבל האפשרויות צריכות להיות מחרוזות לא מקודדות.

פרמטרים
`uriParts`	`String`
`options`

החזרות
`GenericUrl`

public HttpResponse execute (String method, 
                String[] uriParts, 
                 options, 
                JSONObject data)

מפעיל בקשת API.

פרמטרים
`method`	`String`: שיטת ה-HTTP של הבקשה
`uriParts`	`String`: חלקי URI בקידודי תווים שמתאימים לכתובות URL שישמשו לבניית ה-URI של הבקשה.
`options`	: שמות פרמטרים לא מקודדים וערכים שמשמשים לבניית מחרוזת השאילתה
`data`	`JSONObject`: הנתונים שיישלחו עם הבקשה

החזרות
`HttpResponse`	אובייקט HttpResponse

public HttpRequestFactory getRequestFactory ()

מחזירה את הערך HttpRequestRequest במפעל.

חשיפה לבדיקה.

החזרות
`HttpRequestFactory`

public static RestApiHelper newInstanceWithGoogleCredential (String baseUri, 
                File jsonKeyFile, 
                 scopes)

יוצרת מכונה של עוזר API שמשתמש ב-Credential לצורך אימות.

פרמטרים
`baseUri`	`String`: ה-URI הבסיסי של ה-API
`jsonKeyFile`	`File`: קובץ מפתח ה-json של חשבון השירות
`scopes`	: אוסף היקפי ההרשאות של OAuth לשימוש עם חשבון השירות

החזרות
`RestApiHelper`

קליעות
	חריגת אבטחה כללית
	חריגת IO