gpg::NearbyConnections::Builder

#include <nearby_connections_builder.h>

מחלקת Builder שמשמשת לבניית אובייקטים של NearbyConnections.

סיכום

בונים והורסים

Builder()
~Builder()

סוגים ציבוריים

OnInitializationFinishedCallback typedef
std::function< void(InitializationStatus)>
קריאה חוזרת שהאפליקציה מפעילה בעת אתחול ה-API, או כשהאתחול נכשל.
OnLogCallback typedef
std::function< void(LogLevel, const std::string &)>
סוג הקריאה החוזרת (callback) של הרישום ביומן שניתן לספק ל-SDK.

תפקידים ציבוריים

Create(const PlatformConfiguration & platform)
std::unique_ptr< NearbyConnections >
מציינת את הפלטפורמה שעבורה Builder יוצר את האובייקט NearbyConnections, ולאחר מכן מנסה ליצור אותו.
SetClientId(int64_t client_id)
מגדיר מזהה לקוח עבור ה-API הזה, שמוחזר באמצעות קריאה חוזרת (callback).
SetDefaultOnLog(LogLevel min_level)
המדיניות הזו קובעת שהרישום ביומן יתבצע באמצעות DEFAULT_ON_LOG_CALLBACK ברמת היומן שצוינה.
SetOnInitializationFinished(OnInitializationFinishedCallback callback)
רישום של קריאה חוזרת (callback) שהאפליקציה קוראת כשהאתחול מסתיים.
SetOnLog(OnLogCallback callback, LogLevel min_level)
רישום של קריאה חוזרת (callback) שיבצע רישום ביומן.
SetOnLog(OnLogCallback callback)
רישום של קריאה חוזרת (callback) שיבצע רישום ביומן.
SetServiceId(const std::string & service_id)
מגדיר מזהה שירות שמשמש לפרסום.

סוגים ציבוריים

OnInitializationFinishedCallback

std::function< void(InitializationStatus)> OnInitializationFinishedCallback

קריאה חוזרת שהאפליקציה מפעילה בעת אתחול ה-API, או כשהאתחול נכשל.

OnLogCallback

std::function< void(LogLevel, const std::string &)> OnLogCallback

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

תפקידים ציבוריים

בנאי/ת

 Builder()

יצירה

std::unique_ptr< NearbyConnections > Create(
  const PlatformConfiguration & platform
)

מציינת את הפלטפורמה שעבורה Builder יוצר את האובייקט NearbyConnections, ולאחר מכן מנסה ליצור אותו.

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

SetClientId

Builder & SetClientId(
  int64_t client_id
)

מגדיר מזהה לקוח עבור ה-API הזה, שמוחזר באמצעות קריאה חוזרת (callback).

מזהה הלקוח מאפשר לאובייקט יחיד להירשם כ-listener עבור מספר מופעים של NearbyConnection, ולזהות אילו קריאות חוזרות (callback) מוחזרות עבור אילו מופעים. המזהה הזה לא משפיע על Android.

SetDefaultOnLog

Builder & SetDefaultOnLog(
  LogLevel min_level
)

המדיניות הזו קובעת שהרישום ביומן יתבצע באמצעות DEFAULT_ON_LOG_CALLBACK ברמת היומן שצוינה.

min_level מציין את רמת היומן המינימלית שבה האפליקציה מפעילה את הקריאה החוזרת (callback) המוגדרת כברירת מחדל.

הרמות האפשריות הן: VERBOSE, INFO, WARNING וERROR.

המפרט הזה זהה להפעלה של SetOnLog(OnLogCallback, LogLevel) כאשר OnLogCallback מוגדר ל-DEFAULT_ON_LOG_CALLBACK ול-LogLevel של min_level.

SetOnInitializationFinished

Builder & SetOnInitializationFinished(
  OnInitializationFinishedCallback callback
)

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

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

חשוב לזכור שצריך להפעיל את הקריאה החוזרת (callback) הזו כדי להשתמש באובייקט NearbyConnections.

SetOnLog

Builder & SetOnLog(
  OnLogCallback callback,
  LogLevel min_level
)

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

min_level מציין את רמת היומן המינימלית. בסדר עולה, הרמות האפשריות הן: VERBOSE, INFO, WARNING ו-ERROR.

SetOnLog

Builder & SetOnLog(
  OnLogCallback callback
)

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

הפעולה הזו מקבילה לקריאה ל-SetOnLog(OnLogCallback, LogLevel) עם LogLevel של INFO.

SetServiceId

Builder & SetServiceId(
  const std::string & service_id
)

מגדיר מזהה שירות שמשמש לפרסום.

המזהה הזה לא משפיע בכלל ב-Android, אבל יכול להיות שהוא יצטרך את היכולת לפרסם בפלטפורמות אחרות.

~Builder

 ~Builder()