הפניה למחלקה של GMSPlacesClient

פונקציות של חברי מועדון | פונקציות סטטיות של חברי קבוצה | פונקציות קשורות

הפניה לסוג לקוח GMSPlacesClient

---

סקירה כללית

הממשק הראשי של Places SDK.

הנתונים משמשים לחיפוש ולקבלת פרטים על מקומות. יש לגשת למחלקה הזו דרך המתודה [GMSPlacesClient sharedClient].

יש לקרוא ל-methods של GMSPlacesClient רק מה-thread הראשי. קריאה לשיטות האלה משרשור אחר תגרום לחריגה או להתנהגות לא מוגדרת. אם לא צוין אחרת, כל הקריאות החוזרות יופעלו ב-thread הראשי.

פונקציות של חברי מועדון
(void)	- lookUpPlaceID:callback:
	קבלת פרטים על מקום מסוים.
(void)	- lookUpPhotosForPlaceID:callback:
	קבלת המטא-נתונים של עד 10 תמונות המשויכות למקום.
(void)	- loadPlacePhoto:callback:
	טוען את התמונה עבור תמונה ספציפית בגודל המקסימלי שלה.
(void)	- loadPlacePhoto:constrainedToSize:scale:callback:
	טוען את התמונה עבור תמונה ספציפית, מותאמת למידות המקסימליות הנתונים.
(void)	- currentPlaceWithCallback:
	מחזירה את המיקום המשוער של המכשיר שבו המכשיר נמצא כרגע.
(void)	- findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
	מחפשים חיזויים של ההשלמה האוטומטית משאילתת טקסט.
(void)	– fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
	מאחזרים פרטים של מקום.
(void)	– findPlacePlaceLivelidotsFromCurrentLocationWithPlaceFields:callback:
	חיפוש סבירות למקום על סמך המיקום הנוכחי של המשתמש.
(void)	- isOpenWithPlaceID:callback:
	קבלת פרטים על מקום, כולל כל השדות הדרושים לקביעת GMSPlaceOpenStatus באותו הזמן.
(void)	– isOpenWithPlaceID:date:callback:
	קבלת פרטים על מקום, כולל כל השדות הדרושים לקביעת GMSPlaceOpenStatus ב-NSDate שצוין.
(void)	- isOpenWithPlace:callback:
	קבלת פרטים על מקום, כולל כל השדות הדרושים לקביעת GMSPlaceOpenStatus באותו הזמן.
(void)	– isOpenWithPlace:date:callback:
	קבלת פרטים על מקום, כולל כל השדות הדרושים לקביעת GMSPlaceOpenStatus ב-NSDate שצוין.
(void)	- searchByTextWithRequest:callback:
	חיפוש מקומות לפי טקסט והגבלות.
פונקציות סטטיות של חברים ציבוריים
(instancetype)	+ sharedClient
	מספק את המופע המשותף של GMSPlacesClient עבור ה-SDK של מקומות Google ל-iOS, ויוצר אותו במקרה הצורך.
(BOOL)	+ provideAPIKey:
	מספק את מפתח ה-API שלכם ל-Google Places SDK ל-iOS.
(NSString *)	+ openSourceLicenseInfo
	מחזירה את פרטי רישיון התוכנה של הקוד הפתוח עבור Google Places SDK ל-iOS.
(NSString *)	+ SDKVersion
	מחזירה את הגרסה של הגרסה הזו של Google Places SDK ל-iOS.
(NSString *)	+ SDKLongVersion
	מחזירה את הגרסה הארוכה של הגרסה הזו של Google Places SDK ל-iOS.
פונקציות קשורות
(שימו לב: אלו אינן פונקציות חבר).
typedef void(^	GMSPlaceResultCallback )(GMSPlace *_Nullable result, NSError *_Nullable error)
	סוג קריאה חוזרת (callback) לקבלת חיפוש של פרטי מקום.
typedef void(^	GMSPlaceLikelihoodListCallback )(GMSPlaceLikelihoodList *_Nullable’List, NSError *_Nullable error)
	סוג התקשרות חזרה לקבלת רשימות של סבירות מקום.
typedef void(^	GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullableסורs, NSError *_Nullable error)
	סוג קריאה חוזרת לקבלת מערך של GMSPlaceLikelihood.
typedef void(^	GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable results, NSError *_Nullable error)
	סוג קריאה חוזרת לקבלת תוצאות של השלמה אוטומטית.
typedef void(^	GMSPlacePhotoMetadataResultCallback )(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)
	סוג התקשרות חזרה לקבלת תוצאות של תמונות של מקומות.
typedef void(^	GMSPlacePhotoImageResultCallback )(UIImage *_Nullable image, NSError *_Nullable error)
	סוג קריאה חוזרת לקבלת אובייקטים של UIImage מאובייקט GMSPlacePhotoMetadata.
typedef void(^	GMSPlaceOpenStatusCallback )(תוצאה של GMSPlaceOpenStatus, NSError *_Nullable error)
	סוג קריאה חוזרת לקבלת סטטוס שעות הפתיחה של המקום.
typedef void(^	GMSPlaceSearchByTextResultCallback )(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)
	סוג קריאה חוזרת לקבלת תוצאות חיפוש לפי טקסט.

---

מסמכי תיעוד לגבי פונקציות של חברים

+ (מופע) sharedClient

מספק את המופע המשותף של GMSPlacesClient עבור ה-SDK של מקומות Google ל-iOS, ויוצר אותו במקרה הצורך.

אם האפליקציה שלכם משתמשת לעיתים קרובות בשיטות של GMSPlacesClient, מומלץ לשמור את האובייקט הזה ישירות, אחרת החיבור שלכם ל-Google עשוי להתחיל מחדש על בסיס קבוע.

+ (BOOL) provideAPIKey:

(NSString *)

מפתח

מספק את מפתח ה-API שלכם ל-Google Places SDK ל-iOS.

המפתח הזה נוצר עבור האפליקציה שלך באמצעות מסוף Google Cloud Platform, והוא מותאם למזהה החבילה של האפליקציה כדי לזהות אותו. האפליקציה שלך צריכה לקרוא לו לפני השימוש ב-GMSPlacesClient (לדוגמה, ב-Application:didFinishLaunchingWithOptions:).

החזרות:

כן אם מפתח ה-APIKey סופק בהצלחה.

+ (NSString *) openSourceLicenseInfo

מחזירה את פרטי רישיון התוכנה של הקוד הפתוח עבור Google Places SDK ל-iOS.

מידע זה חייב להיות זמין בבקשה שלך.

+ (NSString *) SDKVersion

מחזירה את הגרסה של הגרסה הזו של Google Places SDK ל-iOS.

. לדוגמה, "1.0.0".

+ (NSString *) SDKLongVersion

מחזירה את הגרסה הארוכה של הגרסה הזו של Google Places SDK ל-iOS.

. לדוגמה, "1.0.0 (102.1)".

- (ריק) lookUpPlaceID:		(NSString *)	placeID
קריאה חוזרת:		(GMSPlaceResultCallback)	התקשרות חזרה

קבלת פרטים על מקום מסוים.

שיטה זו לא חוסמת.

פרמטרים:

placeID	מזהה המקום שצריך לחפש.
קריאה חוזרת (callback)	הקריאה החוזרת להפעלה עם תוצאת החיפוש.

- (void) lookUpPhotosForPlaceID:		(NSString *)	placeID
קריאה חוזרת:		(GMSPlacePhotoMetadataResultCallback)	התקשרות חזרה

קבלת המטא-נתונים של עד 10 תמונות המשויכות למקום.

התמונות מגיעות ממגוון מיקומים, כולל בעלי עסקים ותמונות שנתרמו על ידי משתמשי Google+. ברוב המקרים ניתן להשתמש בתמונות ללא ייחוס, או שהייחוס הנדרש יופיע כחלק מהתמונה. עם זאת, צריך להשתמש במאפיין attributions בתגובה כדי לאחזר את השיוךים הנוספים הנדרשים, ולהציג את פרטי הייחוס האלה באפליקציה בכל מקום שבו התמונה מוצגת. מוחזרות עד 10 תמונות.

כשמשתמשים בשיטה הזו, כמה שיחות בדרך כלל מחזירות את אותן התמונות בכל פעם. עם זאת, זה לא מובטח כי יכול להיות שנתוני הבסיס השתנו.

השיטה הזו מבצעת חיפוש רשת.

פרמטרים:

placeID	מזהה המקום שעבורו רוצים לחפש תמונות.
קריאה חוזרת (callback)	הקריאה החוזרת להפעלה עם תוצאת החיפוש.

- (בטל) loadPlacePhoto:		(GMSPlacePhotoMetadata * *)	photoMetadata
קריאה חוזרת:		(GMSPlacePhotoImageResultCallback)	התקשרות חזרה

טוען את התמונה עבור תמונה ספציפית בגודל המקסימלי שלה.

יכול להיות שנתוני התמונה יישמרו במטמון על ידי ה-SDK. אם התמונה המבוקשת לא קיימת במטמון, תתבצע חיפוש רשת.

פרמטרים:

photoMetadata	ה-GMSPlacePhotoMetadata שעבורו יש לטעון UIImage.
קריאה חוזרת (callback)	הקריאה החוזרת להפעלה עם UIImage שנטען.

- (בטל) loadPlacePhoto:		(GMSPlacePhotoMetadata * *)	photoMetadata
constrainedToSize:		(CGSize)	maxSize
קנה מידה:		(CGFloat)	קנה מידה
קריאה חוזרת:		(GMSPlacePhotoImageResultCallback)	התקשרות חזרה

טוען את התמונה עבור תמונה ספציפית, מותאמת למידות המקסימליות הנתונים.

גודל התמונה יותאם לממדים הנתונים שצוינו תוך שמירה על יחס הגובה-רוחב של התמונה המקורית. קנה מידה זה מתבצע בצד השרת.

אם פרמטר קנה המידה אינו 1.0 maxSize יוכפל בערך הזה, וה-UIImage שיוחזר יוגדר לפי קנה המידה שצוין. יש להגדיר את הפרמטר הזה לקנה המידה של המסך אם אתם טוענים תמונות להצגה במסך.

יכול להיות שנתוני התמונה יישמרו במטמון על ידי ה-SDK. אם התמונה המבוקשת לא קיימת במטמון, תתבצע חיפוש רשת.

הערה:

אחרי החלת גורם קנה המידה, המידות בגודל maxSize יעוגלו כלפי מעלה למספר השלם הקרוב ביותר לפני השימוש. אם התבקשת לספק תמונה גדולה יותר מהגודל המקסימלי הזמין, ייתכן שתוחזר תמונה קטנה יותר.

פרמטרים:

photoMetadata	ה-GMSPlacePhotoMetadata שעבורו יש לטעון UIImage.
maxSize	הגודל המקסימלי של התמונה.
קנה מידה	קנה המידה שבו יש לטעון את התמונה.
קריאה חוזרת (callback)	הקריאה החוזרת להפעלה עם UIImage שנטען.

- (ביטול) currentPlaceWithCallback:

(GMSPlaceLikelihoodListCallback)

התקשרות חזרה

מחזירה את המיקום המשוער של המכשיר שבו המכשיר נמצא כרגע.

יוצרת רשימה של סבירות למקום על סמך המיקום המשוער האחרון של המכשיר. הקריאה החוזרת (callback) שסופקה תופעל עם רשימת הסבירות הזו לאחר הצלחה ועם NSError במקרה של שגיאה.

הערה:

כדי להשתמש בשיטה הזו, צריך לתת לאפליקציה הרשאה לגשת למיקום הנוכחי של המכשיר. לפני שמפעילים את התכונה הזו, צריך לבקש גישה למיקום של המשתמש באמצעות [CLLocationManager requestWhenInUseAuthorization] או [CLLocationManager requestAllowAuthorization]. אם מתקשרים לשיטה הזו והאפליקציה לא מקבלת את סטטוס ההרשאה הנכון, תתבצע קריאה חוזרת (callback) עם שגיאה.

פרמטרים:

קריאה חוזרת (callback)

הקריאה החוזרת להפעלה עם רשימת הסבירות של המקום.

- (ריק) find\nPredictionsFromQuery:		(NSString *)	שאילתה
מסנן:		(פונקציית הערך nullable GMSAutocompleteFilter *)	סינון
sessionToken:		(nullable GMSAutocompleteSessionToken *)	sessionToken
קריאה חוזרת:		(GMSAutocompletePredictionsCallback)	התקשרות חזרה

מחפשים חיזויים של ההשלמה האוטומטית משאילתת טקסט.

ייתכן שהתוצאות יוטות למיקום מסוים או יוגבלו לאזור. שיטה זו לא חוסמת.

הקריאה החוזרת (callback) שסופקה תופעל עם מערך של תחזיות להשלמה אוטומטית לאחר הצלחה, ו-NSError במקרה של שגיאה.

פרמטרים:

שאילתה	הטקסט החלקי שיושלם אוטומטית.
סינון	המסנן שיוחל על התוצאות. הפרמטר הזה יכול להיות אפס.
sessionToken	השדה GMSAutocompleteSessionToken לשיוך הבקשה לסשן חיוב.
קריאה חוזרת (callback)	הקריאה החוזרת להפעלה עם החיזויים.

- (ביטול) fetchPlaceFromPlaceID:		(NSString *)	placeID
PlaceFields:		(GMSPlaceField)	placeFields
sessionToken:		(nullable GMSAutocompleteSessionToken *)	sessionToken
קריאה חוזרת:		(GMSPlaceResultCallback)	התקשרות חזרה

מאחזרים פרטים של מקום.

שיטה זו לא חוסמת.

פרמטרים:

placeID	מזהה המקום שצריך לחפש.
placeFields	שדות המקום הנפרדים שנדרשים לאובייקטים של המקום ברשימה.
sessionToken	השדה GMSAutocompleteSessionToken לשיוך הבקשה לסשן חיוב.
קריאה חוזרת (callback)	הקריאה החוזרת להפעלה עם תוצאת החיפוש.

- (מבוטל) findPlacelikelihoodsFromCurrentLocationWithPlaceFields:		(GMSPlaceField)	placeFields
קריאה חוזרת:		(GMSPlaceLikelihoodsCallback)	התקשרות חזרה

חיפוש סבירות למקום על סמך המיקום הנוכחי של המשתמש.

שיטה זו לא חוסמת.

הקריאה החוזרת שסופקה תופעל עם מערך של מקומות עם דירוגי סבירות להצלחה, ועם שגיאה מסוג NSError.

פרמטרים:

placeFields	שדות המקום הנפרדים שנדרשים לאובייקטים של המקום ברשימה.
קריאה חוזרת (callback)	הקריאה החוזרת להפעלה עם סבירות למקום.

- (void) isOpenWithPlaceID:		(NSString *)	placeID
קריאה חוזרת:		(GMSPlaceOpenStatusCallback)	התקשרות חזרה

קבלת פרטים על מקום, כולל כל השדות הדרושים לקביעת GMSPlaceOpenStatus באותו הזמן.

שיטה זו לא חוסמת.

פרמטרים:

placeID	מזהה המקום שצריך לחפש.
קריאה חוזרת (callback)	הקריאה החוזרת להפעלה עם תוצאת המקום.

- (void) isOpenWithPlaceID:		(NSString *)	placeID
תאריך:		(NSDate *)	date (תאריך)
קריאה חוזרת:		(GMSPlaceOpenStatusCallback)	התקשרות חזרה

קבלת פרטים על מקום, כולל כל השדות הדרושים לקביעת GMSPlaceOpenStatus ב-NSDate שצוין.

שיטה זו לא חוסמת.

פרמטרים:

placeID	מזהה המקום שצריך לחפש.
תאריך	NSDate שצריך לקבוע את סטטוס הפתיחה שלו.
קריאה חוזרת (callback)	הקריאה החוזרת להפעלה עם תוצאת המקום.

- (ביטול) isOpenWithPlace:		(GMSPlace *)	מקום
קריאה חוזרת:		(GMSPlaceOpenStatusCallback)	התקשרות חזרה

קבלת פרטים על מקום, כולל כל השדות הדרושים לקביעת GMSPlaceOpenStatus באותו הזמן.

בקשת שדות נוספים רק אם ב-GMSPlace אין את כל השדות הנחוצים, אחרת השדה GMSPlaceOpenStatus יוחזר בקריאה החוזרת באופן מיידי. שיטה זו לא חוסמת.

פרמטרים:

מקום	GMSPlace שיש לחפש.
קריאה חוזרת (callback)	הקריאה החוזרת להפעלה עם תוצאת המקום.

- (ביטול) isOpenWithPlace:		(GMSPlace *)	מקום
תאריך:		(NSDate *)	date (תאריך)
קריאה חוזרת:		(GMSPlaceOpenStatusCallback)	התקשרות חזרה

קבלת פרטים על מקום, כולל כל השדות הדרושים לקביעת GMSPlaceOpenStatus ב-NSDate שצוין.

בקשת שדות נוספים רק אם ב-GMSPlace אין את כל השדות הנחוצים, אחרת השדה GMSPlaceOpenStatus יוחזר בקריאה החוזרת באופן מיידי. שיטה זו לא חוסמת.

פרמטרים:

מקום	GMSPlace שיש לחפש.
תאריך	NSDate שצריך לקבוע את סטטוס הפתיחה שלו.
קריאה חוזרת (callback)	הקריאה החוזרת להפעלה עם תוצאת המקום.

- (ביטול) searchByTextWithRequest:		(GMSPlaceSearchByTextRequest *)	textSearchRequest
קריאה חוזרת:		(GMSPlaceSearchByTextResultCallback)	התקשרות חזרה

חיפוש מקומות לפי טקסט והגבלות.

שיטה זו לא חוסמת.

פרמטרים:

textSearchRequest	GMSPlaceSearchByTextRequest בקשת הטקסט לשימוש בשאילתה.
קריאה חוזרת (callback)	הקריאה החוזרת להפעלה עם תוצאת החיפוש.

---

מסמכי עזרה של חברים ופונקציות קשורות

- (typedef void(^ GMSPlaceResultCallback)(GMSPlace *_Nullable result, NSError *_Nullable error)) [related]

סוג קריאה חוזרת (callback) לקבלת חיפוש של פרטי מקום.

אם אירעה שגיאה, הערך result יהיה אפס ו-error יכיל מידע על השגיאה.

פרמטרים:

תוצאה אחת	הערך GMSPlace שהוחזר.
error	השגיאה שאירעה, אם הייתה כזו.

- (typedef void(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_NullableabilityList, NSError *_Nullable error)) [related]

סוג התקשרות חזרה לקבלת רשימות של סבירות מקום.

אם אירעה שגיאה, הערך likelihoodList יהיה אפס ו-error יכיל מידע על השגיאה.

פרמטרים:

likelihoodList	רשימת הסבירות למקום.
error	השגיאה שאירעה, אם הייתה כזו.

- (typedef void(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Nullableסורs, NSError *_Nullable error) [related]

סוג קריאה חוזרת לקבלת מערך של GMSPlaceLikelihood.

במקרה של שגיאה, המערך יהיה n ו-error יכיל מידע על השגיאה.

–GMSAutocompletePredictionsCallbackGMSAutocompletePrediction [related]

סוג קריאה חוזרת לקבלת תוצאות של השלמה אוטומטית.

results הוא מערך של חיזויי GMSהשלמה אוטומטית של בקשות, שמייצגות השלמות של שאילתות.

פרמטרים:

תוצאות	מערך של GMSAutocompletePredictions.
error	השגיאה שאירעה, אם הייתה כזו.

- (typedef void(^ GMSPlacePhotoMetadataResultCallback)(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error) [related]

סוג התקשרות חזרה לקבלת תוצאות של תמונות של מקומות.

אם אירעה שגיאה, הערך photos יהיה אפס ו-error יכיל מידע על השגיאה.

פרמטרים:

תמונות, תצלומים, צילומים, פוטוס	התוצאה שמכילה GMSPlacePhotoMetadata אובייקטים.
error	השגיאה שאירעה, אם הייתה כזו.

- (typedef void(^ GMSPlacePhotoImageResultCallback)(UIImage *_Nullable photo, NSError *_Nullable error)) [related]

סוג קריאה חוזרת לקבלת אובייקטים של UIImage מאובייקט GMSPlacePhotoMetadata.

אם אירעה שגיאה, הערך photo יהיה אפס ו-error יכיל מידע על השגיאה.

פרמטרים:

תמונה, פוטו	UIImage שנטען.
error	השגיאה שאירעה, אם הייתה כזו.

- (typedef void(^ GMSPlaceOpenStatusCallback)(תוצאה של GMSPlaceOpenStatus, NSError *_Nullable error) [related]

סוג קריאה חוזרת לקבלת סטטוס שעות הפתיחה של המקום.

אם אירעה שגיאה, הקוד result יהיה GMSPlaceOpenStatusUnknown ו-error תכיל מידע על השגיאה.

פרמטרים:

תוצאה אחת	הערך GMSPlaceOpenStatus שהוחזר.
error	השגיאה שאירעה, אם הייתה כזו.

- (typedef void(^ GMSPlaceSearchByTextResultCallback)(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error) [related]

סוג קריאה חוזרת לקבלת תוצאות חיפוש לפי טקסט.

results הוא מערך של GMSPlace שמייצג תוצאות בודדות שתואמות לשאילתה.

פרמטרים:

תוצאות	מערך של GMSPlaces.
error	השגיאה שאירעה, אם הייתה כזו.