#Configuration
Bien que la configuration par défaut convienne à la plupart des cas d'usage, vous pouvez souhaiter
personnaliser certains comportements.
ℹ️ La configuration de votre Dashboard remplacera ces valeurs de configuration sauf si
elles ont été définies en mode lecture seule.
#Utilisation
func config(_ config: [String: Any], _ readOnly: Bool = false) -> Void#Options
#percent
- Type: Int
- Défaut: 80
Pourcentage du contenu que vous souhaitez masquer/retirer lors de l'utilisation du mode d'affichage
embedded.#app_name
- Type: String
- Défaut: ''
Permet de définir le nom d'affichage de votre média pour certains widgets. Cette valeur peut être remplacée par la configuration du Dashboard.
#subscription_url
- Type: String
- Défaut: nil
URL de votre page d'abonnement. Le widget d'abonnement redirigera le lecteur vers cette page lorsqu'il décidera de s'abonner.
La variable
{return_url} permet d'obtenir l'URL actuelle.La variable
{user_id} permet d'obtenir l'identifiant Poool du lecteur.#subscription_button_enabled
- Type: Bool
- Défaut: true
Affiche/masque le bouton d'abonnement sur chaque widget (sauf “Abonnement” et “Déblocage invisible”).
#newsletter_name
- Type: String
- Défaut: nil
Nom de la newsletter, lié à l'adresse email enregistrée d'un utilisateur sur le widget newsletter.
#newsletter_id
- Type: String
- Défaut: nil
Identifiant de la newsletter, lié à l'adresse email enregistrée d'un utilisateur sur le widget newsletter.
Vous pourrez ensuite récupérer toutes les inscriptions pour un utilisateur particulier via l'API Poool.
#login_url
- Type: String
- Défaut: nil
URL de votre page de connexion. Un utilisateur sera redirigé ici après avoir cliqué sur le bouton de connexion.
La variable
{return_url} peut être utilisée pour obtenir l'URL actuelle.La variable
{user_id} peut être utilisée pour obtenir l'identifiant Poool du lecteur.#login_button_enabled
- Type: Bool
- Défaut: true
Affiche/masque le bouton de connexion sur chaque widget.
#alternative_enabled
- Type: Bool
- Défaut: true
Affiche/masque le lien 'Non merci' pour plusieurs widgets.
#alternative_widget
- Type: String
- Valeurs acceptées: 'none', 'gift', 'question', 'subscription', 'newsletter'
- Défaut: 'none'
Remplace l'action alternative par défaut utilisée par plusieurs widgets.
#context
- Type: [String]
- Défaut: nil
Permet d'attribuer un contexte personnalisé à un lecteur.
Si aucun contexte n'est spécifié, des contextes natifs ou un contexte par défaut seront utilisés.
#consent_rejection_widget
- Type: String
- Valeurs acceptées: 'invisible', 'unlock', 'gift', 'subscription'
- Défaut: 'subscription'
Permet de définir le widget à afficher par défaut si le suivi d'activités n'a pas été autorisé dans l'application.
#custom_segment
- Type: String
- Défaut: nil
Permet d'attribuer un lecteur à un groupe personnalisé préalablement créé dans le Dashboard Poool.
#data_policy_url
- Type: String
- Défaut: nil
URL du lien affiché dans les widgets qui nécessitent la collecte d'informations utilisateur.
La variable
{return_url} permet d'obtenir l'URL actuelle.La variable
{user_id} permet d'obtenir l'identifiant Poool du lecteur.#paywall_load_timeout
- Type: Int
- Défaut: 10000
Définit le temps d'attente par défaut pour que le Paywall soit entièrement affiché. Après ce délai, l'événement
onError est déclenché afin que vous puissiez afficher un paywall de secours.#custom_reader_id
- Type: String
- Défaut: nil
Permet d'attribuer votre propre identifiant personnalisé à l'un de vos lecteurs.
#default_widget
- Type: String
- Valeurs acceptées: 'invisible', 'unlock', 'gift', 'subscription'
- Défaut: 'subscription'
Permet de définir le widget à afficher en cas d'erreur réseau.
Il est alors possible de débloquer le contenu manuellement (ex :
gift, etc.) ou automatiquement avec invisible.#hide_gradient
- Type: Bool
- Défaut: false
Utilisé pour masquer le fond en dégradé sur le paywall lors de l'utilisation du mode
embedded.