Aller au contenu
rdlabo.devdocs

API

method initialize(...)

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

Initialise le SDK JavaScript Facebook sur le Web.
Sans effet sur Android et iOS, où le SDK est configuré nativement.

Paramètre Type
options Partial<FacebookConfiguration>

method login(...)

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

Lance le parcours de connexion Facebook avec les autorisations demandées.
Une connexion native annulée se résout sans jeton.

Paramètre Type
options { permissions: string[]; tracking?: 'limited' \| 'enabled'; nonce?: string; }

Renvoie : Promise<FacebookLoginResponse>

method logout()

logout() => Promise<void>

Déconnecte la session Facebook courante.

method reauthorize()

reauthorize() => Promise<FacebookLoginResponse>

Demande le renouvellement de l’accès aux données pour la session Facebook courante.

Renvoie : Promise<FacebookLoginResponse>

method getCurrentAccessToken()

getCurrentAccessToken() => Promise<FacebookCurrentAccessTokenResponse>

Renvoie le jeton courant. Sur iOS, renvoie un jeton d’authentification OIDC pour Limited Login. Les plateformes natives se résolvent sans jeton lorsque l’utilisateur est déconnecté ; le Web rejette l’appel en l’absence de session Facebook connectée.

Renvoie : Promise<FacebookCurrentAccessTokenResponse>

method getProfile(...)

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

Demande les champs sélectionnés à l’endpoint /me de l’API Facebook Graph.

Paramètre Type
options { fields: readonly string[]; }

Renvoie : Promise<T>

method logEvent(...)

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

Enregistre un Facebook App Event avec des paramètres facultatifs de type chaîne ou nombre.

Paramètre Type
options { eventName: string; parameters?: Record<string, string \| number>; }

method setAutoLogAppEventsEnabled(...)

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

Active ou désactive l’enregistrement automatique des App Events sur les plateformes natives.

Paramètre Type
options { enabled: boolean; }

method setAdvertiserTrackingEnabled(...)

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

Active ou désactive le suivi publicitaire sur iOS.

Paramètre Type
options { enabled: boolean; }

method setAdvertiserIDCollectionEnabled(...)

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

Active ou désactive la collecte de l’identifiant publicitaire sur les plateformes natives.

Paramètre Type
options { enabled: boolean; }

Interfaces

interface FacebookConfiguration

Propriété Type Description
appId string Identifiant de l’application Meta.
autoLogAppEvents boolean Indique si le SDK Web enregistre automatiquement les App Events.
xfbml boolean Indique si le SDK Web analyse les plugins sociaux XFBML.
version string Version de l’API Facebook Graph utilisée par le SDK Web. Valeur par défaut : v26.0.
locale string Locale utilisée pour charger le SDK Web. Valeur par défaut : en_US.

interface FacebookLoginResponse

Propriété Type Description
accessToken AccessToken \| null Réponse contenant le jeton, lorsque la plateforme en renvoie une.
recentlyGrantedPermissions string[] Autorisations accordées pendant cette connexion.
recentlyDeniedPermissions string[] Autorisations refusées pendant cette connexion.

interface AccessToken

Propriété Type Description
applicationId string Identifiant de l’application Meta qui a émis le jeton.
declinedPermissions string[] Autorisations refusées par l’utilisateur.
expires string Date d’expiration du jeton au format ISO 8601.
isExpired boolean Indique si le jeton a expiré.
lastRefresh string Date ISO 8601 de la dernière actualisation du jeton.
permissions string[] Autorisations accordées au jeton.
token string Chaîne du jeton renvoyée par la plateforme. Avec iOS Limited Login, il s’agit d’un jeton d’authentification OIDC (JWT), et non d’un jeton d’accès à l’API Graph.
userId string Identifiant de l’utilisateur Facebook associé au jeton.

interface FacebookCurrentAccessTokenResponse

Propriété Type Description
accessToken AccessToken \| null Réponse contenant le jeton courant, lorsque la plateforme en renvoie une.

Alias de types

type alias Partial

Rend toutes les propriétés de T facultatives

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

type alias Record

Construit un type avec un ensemble de propriétés K de type T

{ [P in K]: T; }

Modifier cette page sur GitHub