Zum Inhalt springen
rdlabo.devdocs

API

method initialize(...)

initialize(options: Partial<FacebookConfiguration>) => Promise<void>

Initialisiert das Facebook JavaScript SDK im Web.
Unter Android und iOS, wo das SDK nativ konfiguriert wird, hat dieser Aufruf keine Wirkung.

Parameter Typ
options Partial<FacebookConfiguration>

method login(...)

login(options: { permissions: string[]; tracking?: 'limited' | 'enabled'; nonce?: string; }) => Promise<FacebookLoginResponse>

Startet den Facebook-Anmeldeablauf mit den angeforderten Berechtigungen.
Eine abgebrochene native Anmeldung wird ohne Token aufgelöst.

Parameter Typ
options { permissions: string[]; tracking?: 'limited' \| 'enabled'; nonce?: string; }

Rückgabe: Promise<FacebookLoginResponse>

method logout()

logout() => Promise<void>

Meldet die aktuelle Facebook-Sitzung ab.

method reauthorize()

reauthorize() => Promise<FacebookLoginResponse>

Fordert erneuten Datenzugriff für die aktuelle Facebook-Sitzung an.

Rückgabe: Promise<FacebookLoginResponse>

method getCurrentAccessToken()

getCurrentAccessToken() => Promise<FacebookCurrentAccessTokenResponse>

Liefert den aktuellen Token. iOS gibt für
Limited Login einen OIDC-Authentifizierungstoken zurück. Native Plattformen lösen den Aufruf bei abgemeldeten Nutzern ohne Token auf;
im Web wird der Aufruf zurückgewiesen, wenn keine verbundene Facebook-Sitzung besteht.

Rückgabe: Promise<FacebookCurrentAccessTokenResponse>

method getProfile(...)

getProfile<T extends Record<string, unknown>>(options: { fields: readonly string[]; }) => Promise<T>

Fragt die ausgewählten Felder vom /me-Endpunkt der Facebook Graph API ab.

Parameter Typ
options { fields: readonly string[]; }

Rückgabe: Promise<T>

method logEvent(...)

logEvent(options: { eventName: string; parameters?: Record<string, string | number>; }) => Promise<void>

Protokolliert ein Facebook App Event mit optionalen String- oder Zahlenparametern.

Parameter Typ
options { eventName: string; parameters?: Record<string, string \| number>; }

method setAutoLogAppEventsEnabled(...)

setAutoLogAppEventsEnabled(options: { enabled: boolean; }) => Promise<void>

Aktiviert oder deaktiviert die automatische Protokollierung von App Events auf nativen Plattformen.

Parameter Typ
options { enabled: boolean; }

method setAdvertiserTrackingEnabled(...)

setAdvertiserTrackingEnabled(options: { enabled: boolean; }) => Promise<void>

Aktiviert oder deaktiviert Werbetracking unter iOS.

Parameter Typ
options { enabled: boolean; }

method setAdvertiserIDCollectionEnabled(...)

setAdvertiserIDCollectionEnabled(options: { enabled: boolean; }) => Promise<void>

Aktiviert oder deaktiviert die Erfassung der Werbe-ID auf nativen Plattformen.

Parameter Typ
options { enabled: boolean; }

Interfaces

interface FacebookConfiguration

Eigenschaft Typ Beschreibung
appId string Kennung der Meta-Anwendung.
autoLogAppEvents boolean Ob das Web SDK App Events automatisch protokolliert.
xfbml boolean Ob das Web SDK XFBML-Social-Plugins verarbeitet.
version string Vom Web SDK verwendete Version der Facebook Graph API. Standardwert: v26.0.
locale string Gebietsschema für das Laden des Web SDK. Standardwert: en_US.

interface FacebookLoginResponse

Eigenschaft Typ Beschreibung
accessToken AccessToken \| null Tokenantwort, sofern die Plattform eine zurückgibt.
recentlyGrantedPermissions string[] Bei dieser Anmeldung erteilte Berechtigungen.
recentlyDeniedPermissions string[] Bei dieser Anmeldung verweigerte Berechtigungen.

interface AccessToken

Eigenschaft Typ Beschreibung
applicationId string Kennung der Meta-Anwendung, die den Token ausgestellt hat.
declinedPermissions string[] Vom Nutzer abgelehnte Berechtigungen.
expires string ISO-8601-Ablaufdatum des Tokens.
isExpired boolean Ob der Token abgelaufen ist.
lastRefresh string ISO-8601-Datum der letzten Tokenaktualisierung.
permissions string[] Dem Token erteilte Berechtigungen.
token string Von der Plattform zurückgegebene Tokenzeichenfolge. Bei iOS Limited Login ist dies ein OIDC-Authentifizierungstoken (JWT), kein Graph-API-Zugriffstoken.
userId string Dem Token zugeordnete Facebook-Nutzer-ID.

interface FacebookCurrentAccessTokenResponse

Eigenschaft Typ Beschreibung
accessToken AccessToken \| null Aktuelle Tokenantwort, sofern die Plattform eine zurückgibt.

Typaliase

type alias Partial

Macht alle Properties in T optional

{ [P in keyof T]?: T[P]; }

type alias Record

Erstellt einen Typ mit einer Menge von Properties K vom Typ T

{ [P in K]: T; }

Diese Seite auf GitHub bearbeiten