مرجع کلاس GMSPlacesClient

توابع اعضای عمومی | توابع اعضای عمومی استاتیک | توابع مرتبط
مرجع کلاس GMSPlacesClient

بررسی اجمالی

رابط اصلی Places SDK.

برای جستجو و دریافت جزئیات در مورد مکان ها استفاده می شود. این کلاس باید از طریق روش [ GMSPlacesClient sharedClient] قابل دسترسی باشد.

متدهای GMSPlacesClient فقط باید از رشته اصلی فراخوانی شوند. فراخوانی این روش ها از یک رشته دیگر منجر به یک استثنا یا رفتار تعریف نشده می شود. مگر اینکه غیر از این مشخص شده باشد، همه تماس‌های برگشتی در رشته اصلی فراخوانی می‌شوند.

توابع اعضای عمومی

(خالی) - LookUpPlaceID: callback:
دریافت جزئیات برای یک مکان.
(خالی) - LookUpPhotosForPlaceID:Callback:
فراداده حداکثر 10 عکس مرتبط با یک مکان را دریافت می کند.
(خالی) - loadPlacePhoto: callback:
تصویر را برای یک عکس خاص با حداکثر اندازه بارگیری می کند.
(خالی) - loadPlacePhoto:constrainedToSize:scale:callback:
تصویر را برای یک عکس خاص بارگذاری می‌کند، که برای تناسب با حداکثر ابعاد داده شده، مقیاس‌بندی می‌شود.
(خالی) - مکان فعلی با پاسخ تماس:
تخمینی از مکانی که دستگاه در حال حاضر در آن قرار دارد را برمی‌گرداند.
(خالی) - findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
پیش بینی های تکمیل خودکار را از پرس و جو متن پیدا کنید.
(خالی) - fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
واکشی جزئیات برای یک مکان.
(خالی) - findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:Callback:
احتمالات مکان را با استفاده از مکان فعلی کاربر پیدا کنید.
(خالی) - isOpenWithPlaceID: callback:
جزئیات یک مکان شامل تمام فیلدهای لازم برای تعیین GMSPlaceOpenStatus در زمان فعلی دریافت می کند.
(خالی) - isOpenWithPlaceID:date:callback:
جزئیات یک مکان شامل تمام فیلدهای لازم برای تعیین GMSPlaceOpenStatus در NSDate مشخص شده را دریافت می کند.
(خالی) - isOpenWithPlace: callback:
جزئیات یک مکان شامل تمام فیلدهای لازم برای تعیین GMSPlaceOpenStatus در زمان فعلی دریافت می کند.
(خالی) - isOpenWithPlace:date:callback:
جزئیات یک مکان شامل تمام فیلدهای لازم برای تعیین GMSPlaceOpenStatus در NSDate مشخص شده را دریافت می کند.
(خالی) - searchByTextWithRequest: callback:
مکان ها را بر اساس متن و محدودیت ها جستجو کنید.

توابع اعضای عمومی استاتیک

(نوع نمونه) + sharedClient
نمونه مشترک GMSPlacesClient را برای Google Places SDK برای iOS ارائه می دهد و در صورت لزوم آن را ایجاد می کند.
(بول) + ارائه APIKey:
کلید 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(^ GMSPlaceResult Callback
نوع پاسخ به تماس برای دریافت جستجوی جزئیات مکان.
typedef void(^ GMSPlaceLikelihoodListCallback )( GMSPlaceLikelihoodList *_List احتمال ناتوان، NSError *_خطای nullable)
نوع برگشت به تماس برای دریافت لیست احتمال مکان.
typedef void(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_احتمال‌های باطل‌پذیر، خطای NSE *_خطای پاک‌پذیر)
نوع پاسخ به تماس برای دریافت آرایه های GMSPlaceLikelihood s.
typedef void(^ GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_نتایج باطل، NSE خطا *_خطا نول پذیر)
نوع پاسخ به تماس برای دریافت نتایج تکمیل خودکار.
typedef void(^ GMSPlacePhotoMetadataResultCallback )( GMSPlacePhotoMetadataList *_عکس‌های با قابلیت پاک کردن، خطای NSE *_خطای پاک‌پذیر)
نوع پاسخ به تماس برای دریافت نتایج عکس های مکان.
typedef void(^ GMSPlacePhotoImageResultCallback )(تصویر UII *_عکس قابل پاک کردن، خطای NSE *_خطای نول پذیر)
نوع پاسخ به تماس برای دریافت اشیاء UIImage از یک شی GMSPlacePhotoMetadata .
typedef void(^ GMSPlaceOpenStatusCallback )(نتیجه GMSPlaceOpenStatus ، خطای NSE *_خطای ناتوان)
نوع پاسخ به تماس برای دریافت وضعیت ساعات کار برای مکان.
typedef void(^ GMSPlaceSearchByTextResultCallback )(NSArray< GMSPlace * > *_مکانهای باطل، NSEخطا *_خطای نول پذیر)
نوع پاسخ به تماس برای دریافت جستجو بر اساس نتایج متنی.

مستندات عملکرد اعضا

+ (نمونه) sharedClient

نمونه مشترک GMSPlacesClient را برای Google Places SDK برای iOS ارائه می دهد و در صورت لزوم آن را ایجاد می کند.

اگر برنامه شما اغلب از روش‌های GMSPlacesClient استفاده می‌کند، ممکن است بخواهد مستقیماً روی این شیء نگه دارد، زیرا در غیر این صورت ممکن است اتصال شما به Google به طور منظم مجدداً راه‌اندازی شود.

+ (BOOL) ارائهAPIKey: (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 *) شناسه مکان
پاسخ به تماس: ( GMSPlaceResultCallback ) پاسخ به تماس

دریافت جزئیات برای یک مکان.

این روش غیر مسدود کننده است.

مولفه های:
شناسه مکان شناسه مکان برای جستجو
پاسخ به تماس تماس برگشتی برای فراخوانی با نتیجه جستجو.
- (باطل) lookUpPhotosForPlaceID: (NSString *) شناسه مکان
پاسخ به تماس: ( GMSPlacePhotoMetadataResultCallback ) پاسخ به تماس

فراداده حداکثر 10 عکس مرتبط با یک مکان را دریافت می کند.

عکس‌ها از مکان‌های مختلف، از جمله صاحبان کسب‌وکار و عکس‌های ارائه‌شده توسط کاربران Google+‎ تهیه می‌شوند. در بیشتر موارد، این عکس‌ها را می‌توان بدون ذکر منبع استفاده کرد یا به عنوان بخشی از تصویر، ارجاع مورد نیاز را در نظر گرفت. با این حال، شما باید از ویژگی attributions در پاسخ برای بازیابی هر گونه اسناد اضافی مورد نیاز استفاده کنید و هر جا که تصویر را نمایش می‌دهید، آن اسناد را در برنامه خود نمایش دهید. حداکثر 10 عکس برگردانده می شود.

تماس های متعدد این روش احتمالاً هر بار همان عکس ها را برمی گرداند. با این حال، این تضمین نمی شود زیرا داده های اساسی ممکن است تغییر کرده باشند.

این روش جستجوی شبکه را انجام می دهد.

مولفه های:
شناسه مکان شناسه مکانی که برای جستجوی عکس‌ها.
پاسخ به تماس تماس برگشتی برای فراخوانی با نتیجه جستجو.
- (باطل) loadPlacePhoto: ( متادیتا GMSPlacePhoto *) عکس متادیتا
پاسخ به تماس: ( GMSPlacePhotoImageResultCallback ) پاسخ به تماس

تصویر را برای یک عکس خاص با حداکثر اندازه بارگیری می کند.

داده های تصویر ممکن است توسط SDK ذخیره شوند. اگر عکس درخواستی در حافظه پنهان وجود نداشته باشد، جستجوی شبکه انجام خواهد شد.

مولفه های:
عکس متادیتا GMSPlacePhotoMetadata که برای بارگیری یک UIImage .
پاسخ به تماس فراخوانی برای فراخوانی با UIImage بارگذاری شده.
- (باطل) loadPlacePhoto: ( متادیتا GMSPlacePhoto *) عکس متادیتا
constrainedToSize: (CGSize) maxSize
مقیاس: (CGFloat) مقیاس
پاسخ به تماس: ( GMSPlacePhotoImageResultCallback ) پاسخ به تماس

تصویر را برای یک عکس خاص بارگذاری می‌کند، که برای تناسب با حداکثر ابعاد داده شده، مقیاس‌بندی می‌شود.

با حفظ نسبت ابعاد تصویر اصلی، تصویر به گونه‌ای کوچک می‌شود که در ابعاد داده شده قرار گیرد. این مقیاس بندی در سمت سرور انجام می شود.

اگر پارامتر مقیاس 1.0 نباشد maxSize در این مقدار ضرب می شود و UIImage برگردانده شده برای داشتن مقیاس مشخص تنظیم می شود. اگر در حال بارگذاری تصاویر برای نمایش روی صفحه هستید، این پارامتر باید روی مقیاس صفحه تنظیم شود.

داده های تصویر ممکن است توسط SDK ذخیره شوند. اگر عکس درخواستی در حافظه پنهان وجود نداشته باشد، جستجوی شبکه انجام خواهد شد.

توجه داشته باشید:
بعد از اعمال ضریب مقیاس، ابعاد در maxSize قبل از استفاده به نزدیکترین عدد صحیح گرد می شود. اگر تصویری بزرگتر از حداکثر اندازه موجود درخواست شود، ممکن است تصویر کوچکتر برگردانده شود.
مولفه های:
عکس متادیتا GMSPlacePhotoMetadata که برای بارگیری یک UIImage .
maxSize حداکثر اندازه تصویر.
مقیاس مقیاس برای بارگذاری تصویر.
پاسخ به تماس فراخوانی برای فراخوانی با UIImage بارگذاری شده.
- (باطل) مکان فعلی با پاسخ تماس: ( GMSPlaceLikelihoodListCallback ) پاسخ به تماس

تخمینی از مکانی که دستگاه در حال حاضر در آن قرار دارد را برمی‌گرداند.

بر اساس آخرین مکان تخمینی دستگاه، فهرست احتمال مکانی را ایجاد می کند. پاسخ تماس ارائه شده با این لیست احتمال در صورت موفقیت و یک خطای NSE در صورت خطا فراخوانی می شود.

توجه داشته باشید:
این روش مستلزم آن است که برنامه شما مجوز دسترسی به مکان فعلی دستگاه را داشته باشد. قبل از تماس با این، مطمئن شوید که با استفاده از [CLLocationManager requestWhenInUseAuthorization] یا [CLLocationManager requestAlwaysAuthorization] درخواست دسترسی به موقعیت مکانی کاربران را داشته باشید. اگر این روش را فراخوانی کنید و برنامه شما وضعیت مجوز صحیح را نداشته باشد، تماس پاسخ با خطا فراخوانی می شود.
مولفه های:
پاسخ به تماس تماس برگشتی برای فراخوانی با لیست احتمال مکان.
- (void) findAutocompletePredictionsFromQuery: (NSString *) پرس و جو
فیلتر: ( GMSAutocompleteFilter قابل تهی *) فیلتر
sessionToken: ( GMSAutocompleteSessionToken قابل تهی *) sessionToken
پاسخ به تماس: ( GMSAutocompletePredictionsCallback ) پاسخ به تماس

پیش بینی های تکمیل خودکار را از پرس و جو متن پیدا کنید.

نتایج ممکن است به صورت اختیاری به سمت یک مکان خاص یا محدود به یک منطقه باشد. این روش غیر مسدود کننده است.

پاسخ تماس ارائه شده با آرایه ای از پیش بینی های تکمیل خودکار پس از موفقیت و یک خطای NSE در صورت بروز خطا فراخوانی می شود.

مولفه های:
پرس و جو متن جزئی برای تکمیل خودکار.
فیلتر فیلتری که روی نتایج اعمال می شود. این پارامتر ممکن است صفر باشد.
sessionToken GMSAutocompleteSessionToken برای مرتبط کردن درخواست به جلسه صورتحساب.
پاسخ به تماس فراخوانی برای فراخوانی با پیش‌بینی‌ها.
- (باطل) fetchPlaceFromPlaceID: (NSString *) شناسه مکان
مکان فیلدها: ( GMSPlaceField ) مکان فیلدها
sessionToken: ( GMSAutocompleteSessionToken قابل تهی *) sessionToken
پاسخ به تماس: ( GMSPlaceResultCallback ) پاسخ به تماس

واکشی جزئیات برای یک مکان.

این روش غیر مسدود کننده است.

مولفه های:
شناسه مکان شناسه مکان برای جستجو
مکان فیلدها فیلدهای مکان جداگانه درخواست شده برای اشیاء مکان در لیست.
sessionToken GMSAutocompleteSessionToken برای مرتبط کردن درخواست به جلسه صورتحساب.
پاسخ به تماس تماس برگشتی برای فراخوانی با نتیجه جستجو.
- (void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: ( GMSPlaceField ) مکان فیلدها
پاسخ به تماس: ( GMSPlaceLikelihoodsCallback ) پاسخ به تماس

احتمالات مکان را با استفاده از مکان فعلی کاربر پیدا کنید.

این روش غیر مسدود کننده است.

پاسخ تماس ارائه شده با آرایه ای از مکان ها با امتیاز احتمال در صورت موفقیت و NSError در صورت خطا فراخوانی می شود.

مولفه های:
مکان فیلدها فیلدهای مکان جداگانه درخواست شده برای اشیاء مکان در لیست.
پاسخ به تماس تماس برگشتی برای فراخوانی با احتمالات مکان.
- (باطل) isOpenWithPlaceID: (NSString *) شناسه مکان
پاسخ به تماس: ( GMSPlaceOpenStatusCallback ) پاسخ به تماس

جزئیات یک مکان شامل تمام فیلدهای لازم برای تعیین GMSPlaceOpenStatus در زمان فعلی دریافت می کند.

این روش غیر مسدود کننده است.

مولفه های:
شناسه مکان شناسه مکان برای جستجو
پاسخ به تماس تماس برگشتی برای فراخوانی با نتیجه مکان.
- (باطل) isOpenWithPlaceID: (NSString *) شناسه مکان
تاریخ: (تاریخ NSD *) تاریخ
پاسخ به تماس: ( GMSPlaceOpenStatusCallback ) پاسخ به تماس

جزئیات یک مکان شامل تمام فیلدهای لازم برای تعیین GMSPlaceOpenStatus در NSDate مشخص شده را دریافت می کند.

این روش غیر مسدود کننده است.

مولفه های:
شناسه مکان شناسه مکان برای جستجو
تاریخ NSDate برای تعیین وضعیت باز برای.
پاسخ به تماس تماس برگشتی برای فراخوانی با نتیجه مکان.
- (باطل) isOpenWithPlace: ( GMSPlace *) محل
پاسخ به تماس: ( GMSPlaceOpenStatusCallback ) پاسخ به تماس

جزئیات یک مکان شامل تمام فیلدهای لازم برای تعیین GMSPlaceOpenStatus در زمان فعلی دریافت می کند.

فقط در صورتی که GMSPlace تمام فیلدهای لازم را نداشته باشد، فیلدهای اضافی را درخواست می کند، در غیر این صورت GMSPlaceOpenStatus بلافاصله در تماس برگشتی برگردانده می شود. این روش غیر مسدود کننده است.

مولفه های:
محل GMSPlace برای جستجو.
پاسخ به تماس تماس برگشتی برای فراخوانی با نتیجه مکان.
- (باطل) isOpenWithPlace: ( GMSPlace *) محل
تاریخ: (تاریخ NSD *) تاریخ
پاسخ به تماس: ( GMSPlaceOpenStatusCallback ) پاسخ به تماس

جزئیات یک مکان شامل تمام فیلدهای لازم برای تعیین GMSPlaceOpenStatus در NSDate مشخص شده را دریافت می کند.

فقط در صورتی که GMSPlace تمام فیلدهای لازم را نداشته باشد، فیلدهای اضافی را درخواست می کند، در غیر این صورت GMSPlaceOpenStatus بلافاصله در تماس برگشتی برگردانده می شود. این روش غیر مسدود کننده است.

مولفه های:
محل GMSPlace برای جستجو.
تاریخ NSDate برای تعیین وضعیت باز برای.
پاسخ به تماس تماس برگشتی برای فراخوانی با نتیجه مکان.
- (باطل) searchByTextWithRequest: ( GMSPlaceSearchByTextRequest *) textSearchRequest
پاسخ به تماس: ( GMSPlaceSearchByTextResultCallback ) پاسخ به تماس

مکان ها را بر اساس متن و محدودیت ها جستجو کنید.

این روش غیر مسدود کننده است.

مولفه های:
textSearchRequest GMSPlaceSearchByTextRequest درخواست متنی که برای پرس و جو استفاده می شود.
پاسخ به تماس تماس برگشتی برای فراخوانی با نتیجه جستجو.
- (typedef void(^ GMSPlaceResultCallback )( GMSPlace *_Nullable نتیجه، NSError *_Nullable error)) [related]

نوع پاسخ به تماس برای دریافت جستجوی جزئیات مکان.

اگر خطایی رخ داده باشد، result صفر خواهد بود و error حاوی اطلاعات مربوط به خطا خواهد بود.

مولفه های:
نتیجه GMSPlace که برگردانده شد.
خطا خطای رخ داده در صورت وجود.
- (typedef void(^ GMSPlaceLikelihoodListCallback )( GMSPlaceLikelihoodList *_Nullable likelihoodList، NSError *_Nullable error)) [related]

نوع برگشت به تماس برای دریافت لیست احتمال مکان.

اگر خطایی رخ داده باشد، likelihoodList صفر خواهد بود و error حاوی اطلاعات مربوط به خطا است.

مولفه های:
lilihoodList لیست احتمالات مکان
خطا خطای رخ داده در صورت وجود.
- (typedef void(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullable likelihoods, NSError *_Nullable error)) [related]

نوع پاسخ به تماس برای دریافت آرایه های GMSPlaceLikelihood s.

اگر خطایی رخ دهد، آرایه صفر خواهد بود و error حاوی اطلاعات مربوط به خطا است.

- (typedef void(^ GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_نتایج باطل، NSError *_Nullable error)) [related]

نوع پاسخ به تماس برای دریافت نتایج تکمیل خودکار.

results آرایه‌ای از GMSAutocompletePredictions است که تکمیل‌های نامزد درخواست را نشان می‌دهد.

مولفه های:
نتایج آرایه ای از GMSAutocompletePrediction s.
خطا خطای رخ داده در صورت وجود.
- (typedef void(^ GMSPlacePhotoMetadataResultCallback )( GMSPlacePhotoMetadataList *_عکس‌های باطل، NSError *_Nullable error)) [related]

نوع پاسخ به تماس برای دریافت نتایج عکس های مکان.

اگر خطایی رخ داده باشد، photos صفر خواهد بود و error حاوی اطلاعات مربوط به خطا خواهد بود.

مولفه های:
عکس ها نتیجه شامل اشیاء GMSPlacePhotoMetadata است.
خطا خطای رخ داده در صورت وجود.
- (typedef void(^ GMSPlacePhotoImageResultCallback )(UIImage *_Photo nullable, NSError *_Nullable error)) [related]

نوع پاسخ به تماس برای دریافت اشیاء UIImage از یک شی GMSPlacePhotoMetadata .

اگر خطایی رخ داده باشد، photo صفر خواهد بود و error حاوی اطلاعاتی در مورد خطا خواهد بود.

مولفه های:
عکس UIImage که بارگیری شد.
خطا خطای رخ داده در صورت وجود.
- (typedef void(^ GMSPlaceOpenStatusCallback )( نتیجه GMSPlaceOpenStatus ، NSError *_Nullable error)) [related]

نوع پاسخ به تماس برای دریافت وضعیت ساعات کار برای مکان.

اگر خطایی رخ داده باشد، result GMSPlaceOpenStatusUnknown خواهد بود و error حاوی اطلاعات مربوط به خطا خواهد بود.

مولفه های:
نتیجه GMSPlaceOpenStatus که برگردانده شد.
خطا خطای رخ داده در صورت وجود.
- (typedef void(^ GMSPlaceSearchByTextResultCallback )(NSArray< GMSPlace * > *_Nullable place, NSError *_Nullable error)) [related]

نوع پاسخ به تماس برای دریافت جستجو بر اساس نتایج متنی.

results آرایه ای از GMSPlace است که نشان دهنده نتایج فردی منطبق با پرس و جو است.

مولفه های:
نتایج آرایه ای از GMSPlace s.
خطا خطای رخ داده در صورت وجود.