ניווט API

כיתה סופית ציבורית NavigationApi מרחיב את האובייקט

נקודת הכניסה ל-API של הניווט. משתמשים בשיטות הסטטיות במחלקה הזו כדי לקבל הפניה אל Navigator.

סיכום של הכיתה המוצבת

@interface	NavigationApi.ErrorCode		קוד שגיאה הוא קוד סטטוס המוחזר על ידי getNavigator(Activity, NavigatorListener) ו-getNavigator(Application, NavigatorListener) כאשר לא ניתן לקבל את Navigator בהצלחה.
משופר	NavigationApi.NavigatorListener		יש לרשום NavigatorListener ב-getNavigator(Activity, NavigatorListener) כדי לקבל הודעה לגבי הסטטוס של Navigator שנאמר.
משופר	NavigationApi.OnTermsResponseListener		ניתן לרשום OnTermsResponseListener ב-showTermsAndConditionsDialog(Activity, String, OnTermsResponseListener) כדי לקבל הודעה כאשר המשתמש מאשר או דוחה את התנאים וההגבלות.

סיכום אמצעי תשלום ציבורי

סטטי בוליאני	areTermsAccepted(בקשה להגשת בקשה) הפונקציה מחזירה את הערך true אם המשתמש הביע הסכמה לתנאים ולהגבלות של הניווט של Google.
בטל סטטי	cleanup() ניקוי המצב הפנימי של רכיבי ה-NavSDK.
מסונכרן סטטי ForegroundServiceManager	getForegroundServiceManager(אפליקציה) מקבלת את המכונה של singleton ForegroundServiceManager.
סטטי מחרוזת	getNavSDKVersion() מחזירה את גרסת ה-NavSDK הנוכחית.
בטל סטטי	getNavigator(אפליקציה של האפליקציה, קריאה חוזרת של NavigationApi.NavigatorListener) מקבלת את המכונה Navigator.
בטל סטטי	getNavigator(פעילות, פעילות, NavigationApi.NavigatorListener, TermsAndConditionsCheckOption termsCheck) מקבלת את המכונה Navigator.
בטל סטטי	getNavigator(פעילות פעילות, קריאה חוזרת של NavigationApi.NavigatorListener) שווה ערך ל-getNavigator(activity, callback, {@link TermsAndConditionsCheckOption#ENABLED}.
בטל סטטי	getNavigatorNoToS(האפליקציה של האפליקציה, קריאה חוזרת של NavigationApi.NavigatorListener) מקבלת את המכונה Navigator.
סטטי RoadSnappedLocationProvider	getRoadSnappedLocationProvider(אפליקציה) מקבל מופע של RoadSnappedLocationProvider, שיכול לשמש להרשמה למיקומי משתמשים חסומים.
סטטי NavigationTransactionRecorder	getTransactionRecorder(אפליקציה לאפליקציה) הפונקציה מקבלת מופע של NavigationTransactionRecorder, שיכול לשמש לתיעוד טרנזקציות שקשורות לניווט.
מסונכרן סטטי ריק	initForegroundServiceManager(Application application, Integer notificationId, String defaultMessage, NotificationContentProvider ספק) הפונקציה מפעילה את המופע ForegroundServiceManager באמצעות הארגומנטים שצוינו.
בטל סטטי	resetTermsAccepted(אפליקציית האפליקציה) איפוס התנאים וההגבלות – לצורך בדיקה.
בטל סטטי	showTermsAndConditionsDialog(פעילות, String companyName, כותרת String, אוזן NavigationApi.OnTermsResponseListener) מוצגת תיבת דו-שיח שמכוונת את המשתמש לאשר את התנאים וההגבלות של הניווט של Google, תוך שימוש במראה ובתחושה המוגדרים כברירת מחדל.
בטל סטטי	showTermsAndConditionsDialog(Activity, String companyName, String title, TermsAndConditionsUIParams uiParams, NavigationApi.OnTermsResponseListener listener, TermsAndConditionsCheckOption תנאיםAndConditionsCheckOption) הצגת תיבת דו-שיח עם בקשה לאשר את התנאים וההגבלות של הניווט של Google.
בטל סטטי	showTermsAndConditionsDialog(פעילות, String companyName, NavigationApi.OnTermsResponseListener) מוצגת תיבת דו-שיח שמכוונת את המשתמש לאשר את התנאים וההגבלות של הניווט Google, תוך שימוש בכותרת ברירת המחדל ובמראה ובתחושה המוגדרים כברירת מחדל.

סיכום שיטות שעברו בירושה

מכיתה java.lang.Object

boolean	equals(Object arg0)
סופי כיתה<?>	getClass()
int	hashCode()
סופי בטל	notify()
סופי בטל	notifyAll()
מחרוזת	toString()
סופי בטל	wait(long arg0, int arg1)
סופי בטל	wait(long arg0)
סופי בטל	wait()

שיטות ציבוריות

Public סטטי בוליאני areTermsAccepted (Application application)

הפונקציה מחזירה את הערך true אם המשתמש הביע הסכמה לתנאים ולהגבלות של הניווט של Google.

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

פרמטרים

יישום	האפליקציה הנוכחית

החזרות

• true אם התנאים אושרו על ידי המשתמש, ו-false אחרת

Public סטטי void ניקוי ()

ניקוי המצב הפנימי של רכיבי ה-NavSDK. אם קיים ניווט קיים, ההנחיה נפסקת ומושבתת. לא ניתן יהיה לבצע בקשות עתידיות לקבלת הנחיות מהניווט הזה. כדאי להפעיל את השיטה הזו כדי לשחזר זיכרון כשאין יותר צורך ב-Navigator באפליקציה, והאפליקציה מחקה את כל ההפניות ל-Navigator. אם צריך להשתמש ב-Navigator אחרי השיחה הזו, צריך להשתמש ב-getNavigator() כדי ליצור ניווט חדש. הערה: נדרש זמן כדי ליצור ניווט חדש. כדאי לחשוב איך העיכוב ישפיע על ביצועי האפליקציה לעומת היתרונות של שחזור זיכרון.

Public סטטי מסונכרן ForegroundServiceManager getForegroundServiceManager (אפליקציית Application)

מקבלת את המכונה של singleton ForegroundServiceManager. אם לא תתבצע קריאה ל-initForegroundServiceManager(Application, Integer, String, NotificationContentProvider) לפני getForegroundServiceManager(Application), ייעשה שימוש במזהה ברירת המחדל של ההתראה, בהודעה ובספק ההתראות.

פרמטרים

יישום	Application הנוכחי

Public סטטי String getNavSDKVersion ()

מחזירה את גרסת ה-NavSDK הנוכחית.

ציבורי סטטי void getNavigator (אפליקציה של האפליקציה, NavigationApi.NavigatorListener להתקשרות חזרה)

מקבלת את המכונה Navigator.

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

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

פרמטרים

יישום	Application הנוכחי
קריאה חוזרת (callback)	התקשרות חזרה שתופעל כשה-Navigator יהיה מוכן, או שמתרחשת שגיאה

ציבורי סטטי void getNavigator (Activity, NavigationApi.NavigatorListener callback, TermsAndConditionsCheckOption termsCheck)

מקבלת את המכונה Navigator.

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

אם הערך בשדה termsCheck הוא ENABLED, תיבת הדו-שיח תכיל גם קישור לתנאים ולהגבלות של ה-SDK לניווט. תתבצע קריאה ל-callback עם שגיאת TERMS_NOT_ACCEPTED אם המשתמש לא יאשר את התנאים האלה.

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

פרמטרים

פעילות	Activity כדי להציג את תיבת הדו-שיח של התנאים וההגבלות, אם הם עדיין לא אושרו
קריאה חוזרת (callback)	התקשרות חזרה שתופעל כשה-Navigator יהיה מוכן, או שמתרחשת שגיאה
termsCheck	מציין אם יש לדלג על בדיקת התנאים וההגבלות.

Public סטטי void getNavigator (Activity activity, NavigationApi.NavigatorListener callback)

שווה ערך ל-getNavigator(activity, callback, {@link TermsAndConditionsCheckOption#ENABLED}.

פרמטרים

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

ראו בנוסף

• getNavigator(Activity, NavigatorListener, TermsAndConditionsCheckOption)

ציבורי סטטי void getNavigatorNoToS (Application application, NavigationApi.NavigatorListener callback)

מקבלת את המכונה Navigator.

עוקף את התנאים וההגבלות.

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

פרמטרים

יישום	Application הנוכחי.
קריאה חוזרת (callback)	קריאה חוזרת (callback) שיופעל כאשר Navigator תהיה מוכנה, או שתתרחש שגיאה.

ציבורי סטטי RoadSnappedLocationProvider getRoadSnappedLocationProvider (אפליקציה)

מקבל מופע של RoadSnappedLocationProvider, שיכול לשמש להרשמה למיקומי משתמשים חסומים. לתשומת ליבך, הרשמה לעדכוני מיקום מוצמדים עלולה לגרום להתרוקנות הסוללה או לאיסוף לא מכוון של נתוני מיקום משתמש אם המכשיר פועל ברקע.

חובה להשיג את השדה Navigator לפני ההפעלה של השיטה הזו, אחרת הוא יחזיר null.

פרמטרים

יישום	Application הנוכחי

ציבורי סטטי NavigationTransactionRecorder getTransactionRecorder (אפליקציה של אפליקציה)

הפונקציה מקבלת מופע של NavigationTransactionRecorder, שיכול לשמש לתיעוד טרנזקציות שקשורות לניווט.

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

חובה להשיג את השדה Navigator לפני ההפעלה של השיטה הזו, אחרת הוא יחזיר null.

פרמטרים

יישום	Application הנוכחי

Public סטטי מסונכרן void initForegroundServiceManager (Application application, Integer notificationId, String defaultMessage, NotificationContentProvider Provider)

הפונקציה מפעילה את המופע ForegroundServiceManager באמצעות הארגומנטים שצוינו.

יש לקרוא לפונקציה זו רק אם ברצונך לשנות פרמטר ברירת מחדל כלשהו. אחרת, יש להתקשר ישירות אל getForegroundServiceManager(Application). אפשר לקרוא לשיטה הזו רק פעם אחת וצריך להפעיל אותה לפני getForegroundServiceManager(Application).

פרמטרים

יישום	Application הנוכחי
notificationId	מזהה ההתראה לגבי ההתראה הקבועה
defaultMessage	הודעת ברירת המחדל שתוצג אם לא צוין provider
provider	הטמעה של NotificationContentProvider

ציבורי סטטי void resetTermsAccepted (Application application)

איפוס התנאים וההגבלות – לצורך בדיקה. כדי לבדוק את תיבת הדו-שיח של התנאים וההגבלות צריך להוסיף אליה קריאה לפני כל הקריאות אל NavigationApi.

פרמטרים

יישום	האפליקציה הנוכחית

ציבורי סטטי void showTermsAndConditionsDialog (Activity, String companyName, String title, NavigationApi.OnTermsResponseListener listener)

מוצגת תיבת דו-שיח שמכוונת את המשתמש לאשר את התנאים וההגבלות של הניווט של Google, תוך שימוש במראה ובתחושה המוגדרים כברירת מחדל.

פרמטרים

פעילות
companyName
שם פריט
listener

ראו בנוסף

• for a description of the different parameters.

ציבורי סטטי void showTermsAndConditionsDialog (Activity, String companyName, String title, TermsAndConditionsUIParams uiParams, NavigationApi.OnTermsResponseListener listener, TermsAndConditionsCheckOption termsAndConditionsCheck}{/13Option)

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

הערה: תיבת הדו-שיח תופיע גם אם המשתמש אישר את ההזמנה בעבר. יש לקרוא לשם כך רק אם areTermsAccepted(Application) הוא false, כי משתמש לא יכול לבטל את הסכמתו לתנאים ולהגבלות.

פרמטרים

פעילות	ה-Activity שבו תוצג תיבת הדו-שיח
companyName	שם החברה שלך, שיוצג בתיבת הדו-שיח 'תנאים והגבלות'
שם פריט	הכותרת של תיבת הדו-שיח. אם הערך הוא null, תיבת הדו-שיח תשתמש בכותרת ברירת המחדל.
uiParams	הפרמטרים המשמשים להתאמה אישית של המראה והתחושה של תיבת הדו-שיח. אם הערך הוא null, המערכת תשתמש במראה ובסגנון שמוגדרים כברירת מחדל.
listener	קריאה חוזרת (callback) אופציונלית שתופעל כשהמשתמש יאשר או ידחה את התנאים וההגבלות
termsAndConditionsCheckOption	TermsAndConditionsCheckOption שמציין אפשרויות לבדיקת תנאים והגבלות

ציבורי סטטי void showTermsAndConditionsDialog (Activity activity, String companyName, NavigationApi.OnTermsResponseListener listener)

מוצגת תיבת דו-שיח שמכוונת את המשתמש לאשר את התנאים וההגבלות של הניווט Google, תוך שימוש בכותרת ברירת המחדל ובמראה ובתחושה המוגדרים כברירת מחדל.

פרמטרים

פעילות
companyName
listener

ראו בנוסף

• for a description of the different parameters.