Notifications Bark

Aperçu

• Source: https://github.com/Finb/Bark
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Corps: 32768
• Créer votre URL Apprise

Configuration du Compte

Bark est une application iOS qui vous permet d’envoyer des notifications personnalisées sur votre iPhone. Téléchargez également le serveur si vous souhaitez une solution auto-hébergée.

Syntaxe

La syntaxe valide est la suivante :

• bark://{host}/{device_key}
• bark://{host}:{port}/{device_key}

Les versions sécurisées :

• barks://{host}/{device_key}
• barks://{host}:{port}/{device_key}

Vous pouvez également notifier plusieurs appareils à la fois :

• bark://{host}:{port}/{device_key1}/{device_key2}/{device_keyN}/

Prise en Charge du Format des Messages

Bark prend en charge la réception de contenu en texte brut ou en Markdown.

Apprise enverra automatiquement l’un des champs de charge utile suivants, selon le format de message utilisé :

• Texte brut (par défaut) : le contenu est envoyé via le champ body.
• Markdown : le contenu est envoyé via le champ markdown.

Pour contrôler explicitement ce comportement, définissez le format de message Apprise. Par exemple :

• ?format=text force le traitement en texte brut.
• ?format=markdown active le traitement Markdown.

Notez que la gestion de format est effectuée par Apprise et influe sur la manière dont la notification est assemblée puis remise à Bark.

Détail des Paramètres

Variable	Requis	Description
device_key	Oui	La clé de l’appareil que vous souhaitez notifier.
sound	Non	Permet facultativement de définir un fichier son à jouer avec la notification envoyée. Les sons pris en charge sont identifiés ici.
click	Non	Fournit un lien hypertexte à associer à la notification.
level	Non	Précise le niveau du message. Peut être active, timeSensitive ou passive.
volume	Non	Précise un volume entre 0 et 10, inclus.
badge	Non	Fournit une valeur numérique égale ou supérieure à 0 pour associer un badge à l’icône Bark sur l’appareil iOS.
category	Non	Associe une catégorie à votre notification.
group	Non	Associe un groupe à votre notification.
icon	Non	Définit une URL d’icône personnalisée pour la notification. Si elle n’est pas précisée, Apprise peut utiliser son image de notification par défaut, sauf si elle est désactivée.
image	Non	Définissez cette valeur sur no si vous ne souhaitez pas que le niveau d’alerte Apprise soit utilisé comme icône associée au message.
call	Non	Entrée de type booléen. Accepte yes/no, true/false, 1/0, +/-. Lorsqu’elle est activée, la charge utile inclut 1.

Paramètres Globaux

Variable	Description
overflow	Ce paramètre peut être défini sur split, truncate ou upstream. Il détermine la manière dont Apprise remet le message que vous lui transmettez. Par défaut, il vaut upstream. 👉 upstream : ne fait aucune modification et transmet le message exactement tel qu’il a été reçu au service. 👉 truncate : veille à ce que le message tienne dans la limite amont documentée par le service. Si plus d’informations sont fournies que la limite définie, l’excédent est tronqué. 👉 split : similaire à truncate, sauf que si le message dépasse la limite amont documentée par le service, il est découpé en plusieurs morceaux plus petits puis envoyés séquentiellement.
format	Ce paramètre peut être défini sur text, html ou markdown. Certains services prennent en charge plusieurs formats de publication du contenu. La valeur par défaut varie selon le service choisi et peut correspondre à l’un de ces trois formats. Vous pouvez facultativement forcer cette option pour vous écarter du comportement par défaut. Si le service ne prend pas en charge plusieurs formats de transmission, ce champ est ignoré.
verify	Les requêtes externes vers des emplacements sécurisés, par exemple via https, utilisent des certificats. Par défaut, Apprise vérifie la validité de ces certificats ; si ce n’est pas le cas, aucune notification n’est envoyée à la source. Dans certains cas, un utilisateur ne dispose pas d’une autorité de certification pour valider la clé ou fait simplement confiance à la source ; dans ce cas, vous pouvez définir ce drapeau sur no. Par défaut, il vaut yes.
cto	Signifie Socket Connect Timeout. Il s’agit du nombre de secondes pendant lesquelles Requests attend que votre client établisse une connexion avec une machine distante, ce qui correspond à l’appel connect() sur la socket. La valeur par défaut est de 4.0 secondes.
rto	Signifie Socket Read Timeout. Il s’agit du nombre de secondes pendant lesquelles le client attend que le serveur envoie une réponse. La valeur par défaut est de 4.0 secondes.
emojis	Active la prise en charge des emojis, par exemple :+1: qui sera traduit en 👍. Par défaut, cette option vaut no. Remarque : selon la configuration côté serveur, l’administrateur peut désactiver globalement la prise en charge des emojis ; mais par défaut, ce n’est pas le cas.
tz	Identifie le fuseau horaire de la base IANA que vous souhaitez utiliser. Par défaut, celui-ci est détecté à partir de la configuration du serveur qui exécute Apprise. Vous pouvez le définir sur des valeurs comme America/Toronto, ou sur tout autre fuseau correctement formaté correspondant à votre région.

Exemples

Envoyer une notification Bark à tous les appareils associés à un projet :

# Supposons :
#  - que notre {hostname} soit localhost
#  - que notre {port} soit 8080
#  - que notre {device_key} soit j300012fl9y0b5AW9g9Nsejb8P
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   bark://localhost:8080/j300012fl9y0b5AW9g9Nsejb8P

Envoyer une notification Bark au format Markdown :

# Le contenu Markdown est envoyé via le champ `markdown` de Bark
apprise -vv -t "Build Statut" -b "# Success\n\nDeployment completed." \
   bark://localhost:8080/j300012fl9y0b5AW9g9Nsejb8P?format=markdown

Forcer le comportement en texte brut, même si votre configuration Apprise par défaut utilise un autre format :

apprise -vv -t "Plain Text" -b "**This will not be bold**" \
   bark://localhost:8080/j300012fl9y0b5AW9g9Nsejb8P?format=text