
Langue 🇫🇷 Français (France)
Premiers pas
Documentation
Référence API
Agrégation
Journaux d'audit
Bloquer depuis le commentaire
Vérifier les commentaires bloqués
Commentaires
Configurations de domaine
Modèles d'e-mail
Journal des événements
Publications
Signaler un commentaire
Hashtags
Modérateurs
Nombre de notifications
Notifications
Pages
Événements webhook en attente
Configurations des questions
Résultats des questions
Agrégation des résultats des questions
Utilisateurs SSO
Abonnements
Utilisation quotidienne du locataire
Forfaits du locataire
Utilisateurs du locataire
Locataires
Téléverser une image
Progression du badge utilisateur
Badges utilisateur
Notifications utilisateur
Statuts de présence utilisateur
Recherche d'utilisateurs
Utilisateurs
Votes
FastComments Swift SDK
Ceci est le SDK Swift officiel pour FastComments.
SDK Swift officiel pour l'API FastComments
Repository
Installation 
Swift Package Manager
Ajoutez ce qui suit dans votre fichier Package.swift :
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "0.0.1")
]
Ou dans Xcode :
- Fichier > Ajouter des paquets...
- Saisissez l'URL du dépôt :
https://github.com/fastcomments/fastcomments-swift.git - Sélectionnez la version que vous souhaitez utiliser
Prérequis
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Contenu de la bibliothèque 
Le SDK Swift de FastComments se compose de plusieurs modules :
Client Module - Client d'API généré automatiquement pour les API REST de FastComments
- Définitions complètes des types pour tous les modèles d'API
- Points de terminaison à la fois authentifiés (
DefaultAPI) et publics (PublicAPI) - Prise en charge complète d'async/await
- Voir client/README.md pour la documentation détaillée de l'API
SSO Module - Utilitaires Single Sign-On côté serveur
- Génération sécurisée de jetons pour l'authentification des utilisateurs
- Prise en charge à la fois des modes SSO simple et sécurisé
- Signature de jetons basée sur HMAC-SHA256 utilisant CryptoKit
Démarrage rapide 
Utiliser l'API publique
import FastCommentsSwift
// Crée le client API
let publicApi = PublicAPI()
// Récupère les commentaires pour une page
do {
let response = try await publicApi.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
Utiliser l'API authentifiée
import FastCommentsSwift
// Crée la configuration avec la clé API
let defaultApi = DefaultAPI()
defaultApi.apiKey = "your-api-key"
// Récupère les commentaires en utilisant l'API authentifiée
do {
let response = try await defaultApi.getComments(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
Utiliser SSO pour l'authentification
SSO sécurisé (recommandé pour la production)
import FastCommentsSwift
let apiKey = "your-api-key"
// Crée les données utilisateur SSO sécurisées (côté serveur uniquement !)
let userData = SecureSSOUserData(
id: "user-123", // ID utilisateur
email: "user@example.com", // Adresse e-mail
username: "johndoe", // Nom d'utilisateur
avatar: "https://example.com/avatar.jpg" // URL de l'avatar
)
// Génère le jeton SSO
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Transmettez ce jeton à votre frontend pour l'authentification
} catch {
print("Error creating SSO token: \(error)")
}
SSO simple (pour le développement/tests)
import FastCommentsSwift
// Crée les données utilisateur SSO simples (aucune clé API nécessaire)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Génère le jeton SSO simple
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
API publiques vs sécurisées 
Le FastComments SDK fournit deux types de points de terminaison d'API :
PublicAPI - Points de terminaison sécurisés côté client
Le PublicAPI contient des points de terminaison qui sont sûrs à appeler depuis du code côté client (applications iOS/macOS). Ces points de terminaison :
- Ne nécessitent pas d'API key
- Peuvent utiliser des SSO tokens pour l'authentification
- Sont soumis à des limites de fréquence par utilisateur/appareil
- Conviennent aux applications destinées aux utilisateurs finaux
Exemple d'utilisation : Récupération et création de commentaires dans votre application iOS
DefaultAPI - Points de terminaison côté serveur
Le DefaultAPI contient des points de terminaison authentifiés qui requièrent une API key. Ces points de terminaison :
- Exigent votre FastComments API key
- Doivent UNIQUEMENT être appelés depuis du code côté serveur
- Offrent un accès complet aux données FastComments
- Sont soumis à des limites de fréquence par tenant
Exemple d'utilisation : Opérations administratives, exportation de données en masse, outils de modération
IMPORTANT : N'exposez jamais votre API key dans du code côté client. Les API keys ne doivent être utilisées que côté serveur.
Effectuer des appels API 
Le SDK Swift utilise la syntaxe moderne async/await pour tous les appels d'API :
let response = try await publicApi.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Problèmes courants 
Erreurs 401 (Non autorisé)
Si vous obtenez des erreurs 401 lorsque vous utilisez l'API authentifiée :
- Vérifiez votre API key : Assurez-vous d'utiliser la bonne API key depuis votre tableau de bord FastComments
- Vérifiez le tenant ID : Assurez-vous que le tenant ID correspond à votre compte
- Format de l'API key : L'API key doit être définie sur le client API :
let defaultApi = DefaultAPI()
defaultApi.apiKey = "YOUR_API_KEY"
- Utilisation de la mauvaise API : Assurez-vous d'utiliser
DefaultAPI(et nonPublicAPI) pour les appels authentifiés
Problèmes de jetons SSO
Si les jetons SSO ne fonctionnent pas :
- Utilisez le mode sécurisé en production : Utilisez toujours
FastCommentsSSO.createSecure()avec votre API key en production - Côté serveur uniquement : Générez les jetons SSO sécurisés sur votre serveur, n'exposez jamais votre API key aux clients
- Vérifiez les données utilisateur : Assurez-vous que tous les champs requis (id, email, username) sont fournis
- Expiration du token : Les jetons SSO sécurisés incluent un horodatage et peuvent expirer. Générez de nouveaux jetons selon les besoins.
Erreurs SSL/TLS
Si vous rencontrez des erreurs SSL/TLS :
- Assurez-vous que l'Info.plist de votre application autorise les connexions HTTPS vers fastcomments.com
- Vérifiez que vous n'utilisez pas d'exceptions App Transport Security susceptibles de bloquer la connexion
Remarques 
Identifiants de diffusion
Vous verrez qu'on vous demande de passer un broadcastId dans certains appels d'API. Lorsque vous recevez des événements, vous récupérerez cet ID en retour, ce qui vous permettra d'ignorer l'événement si vous prévoyez d'appliquer des changements de manière optimiste côté client (ce que vous souhaiterez probablement faire, car cela offre la meilleure expérience). Passez un UUID ici. L'ID doit être suffisamment unique pour ne pas apparaître deux fois au cours d'une session.
let broadcastId = UUID().uuidString
agréger 
Agrège des documents en les groupant (si groupBy est fourni) et en appliquant plusieurs opérations. Différentes opérations (p. ex. sum, countDistinct, avg, etc.) sont prises en charge.
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| parentTenantId | string | query | Non | |
| includeStats | boolean | query | Non |
Réponse
Renvoie: AggregationResponse
Exemple

Récupérer les journaux d'audit 
Paramètres
| Name | Type | Location | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| limit | number | query | Non | |
| skip | number | query | Non | |
| order | string | query | Non | |
| after | number | query | Non | |
| before | number | query | Non |
Réponse
Renvoie: GetAuditLogs200Response
Exemple

Bloquer depuis un commentaire (public) 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Retourne : BlockFromCommentPublic200Response
Exemple

Débloquer le commentaire (public) 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie: UnBlockCommentPublic200Response
Exemple

Vérifier si les commentaires sont bloqués 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentIds | string | query | Oui | Une liste d'identifiants de commentaires séparés par des virgules. |
| sso | string | query | Non |
Réponse
Retourne: CheckedCommentsForBlocked200Response
Exemple

Bloquer l'utilisateur depuis un commentaire 
Paramètres
| Name | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Renvoie: BlockFromCommentPublic200Response
Exemple

Créer un commentaire (public) 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| broadcastId | string | query | Oui | |
| sessionId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie: CreateCommentPublic200Response
Exemple

Supprimer un commentaire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| contextUserId | string | query | Non | |
| isLive | boolean | query | Non |
Réponse
Renvoie : DeleteComment200Response
Exemple

Supprimer un commentaire (public) 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| editKey | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : DeleteCommentPublic200Response
Exemple

Supprimer un vote de commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| voteId | string | path | Oui | |
| urlId | string | query | Oui | |
| broadcastId | string | query | Oui | |
| editKey | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne: DeleteCommentVote200Response
Exemple

Signaler un commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Réponse
Renvoie : FlagComment200Response
Exemple

Récupérer un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetComment200Response
Exemple

Récupérer des commentaires 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| page | integer | query | Non | |
| limit | integer | query | Non | |
| skip | integer | query | Non | |
| asTree | boolean | query | Non | |
| skipChildren | integer | query | Non | |
| limitChildren | integer | query | Non | |
| maxTreeDepth | integer | query | Non | |
| urlId | string | query | Non | |
| userId | string | query | Non | |
| anonUserId | string | query | Non | |
| contextUserId | string | query | Non | |
| hashTag | string | query | Non | |
| parentId | string | query | Non | |
| direction | string | query | Non |
Réponse
Renvoie : GetComments200Response
Exemple

Récupérer des commentaires (publics) 
req tenantId urlId
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| page | integer | query | Non | |
| direction | string | query | Non | |
| sso | string | query | Non | |
| skip | integer | query | Non | |
| skipChildren | integer | query | Non | |
| limit | integer | query | Non | |
| limitChildren | integer | query | Non | |
| countChildren | boolean | query | Non | |
| fetchPageForCommentId | string | query | Non | |
| includeConfig | boolean | query | Non | |
| countAll | boolean | query | Non | |
| includei10n | boolean | query | Non | |
| locale | string | query | Non | |
| modules | string | query | Non | |
| isCrawler | boolean | query | Non | |
| includeNotificationCount | boolean | query | Non | |
| asTree | boolean | query | Non | |
| maxTreeDepth | integer | query | Non | |
| useFullTranslationIds | boolean | query | Non | |
| parentId | string | query | Non | |
| searchText | string | query | Non | |
| hashTags | array | query | Non | |
| userId | string | query | Non | |
| customConfigStr | string | query | Non | |
| afterCommentId | string | query | Non | |
| beforeCommentId | string | query | Non |
Réponse
Renvoie: GetCommentsPublic200Response
Exemple

Récupérer le texte du commentaire 
Paramètres
| Nom | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| editKey | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : GetCommentText200Response
Exemple

Récupérer les noms d'utilisateurs ayant voté sur le commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| dir | integer | query | Yes | |
| sso | string | query | No |
Réponse
Renvoie: GetCommentVoteUserNames200Response
Exemple

Verrouiller un commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : LockComment200Response
Exemple

Épingler un commentaire 
Paramètres
| Nom | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : PinComment200Response
Exemple

Enregistrer un commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| isLive | boolean | query | Non | |
| doSpamCheck | boolean | query | Non | |
| sendEmails | boolean | query | Non | |
| populateNotifications | boolean | query | Non |
Réponse
Retourne : SaveComment200Response
Exemple

Enregistrer des commentaires en masse 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| isLive | boolean | query | Non | |
| doSpamCheck | boolean | query | Non | |
| sendEmails | boolean | query | Non | |
| populateNotifications | boolean | query | Non |
Réponse
Renvoie : [SaveComment200Response]
Exemple

Définir le texte du commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| editKey | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie: SetCommentText200Response
Exemple

Débloquer l'utilisateur depuis un commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Renvoie: UnBlockCommentPublic200Response
Exemple

Retirer le signalement d'un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Renvoie: FlagComment200Response
Exemple

Déverrouiller un commentaire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie: LockComment200Response
Exemple

Désépingler un commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| sso | string | query | Non |
Response
Renvoie: PinComment200Response
Exemple

Mettre à jour un commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| contextUserId | string | query | Non | |
| doSpamCheck | boolean | query | Non | |
| isLive | boolean | query | Non |
Réponse
Retourne: FlagCommentPublic200Response
Exemple

Voter pour un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| urlId | string | query | Oui | |
| broadcastId | string | query | Oui | |
| sessionId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne: VoteComment200Response
Exemple

Ajouter une configuration de domaine 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : AddDomainConfig200Response
Exemple

Supprimer une configuration de domaine 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domain | string | path | Oui |
Réponse
Renvoie: DeleteDomainConfig200Response
Exemple

Récupérer la configuration de domaine 
Paramètres
| Name | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domain | string | path | Oui |
Réponse
Renvoie: GetDomainConfig200Response
Exemple

Récupérer les configurations de domaine 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne: GetDomainConfigs200Response
Exemple

Appliquer un patch à la configuration de domaine 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Réponse
Renvoie : GetDomainConfig200Response
Exemple

Remplacer la configuration de domaine 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domainToUpdate | string | path | Oui |
Réponse
Renvoie : GetDomainConfig200Response
Exemple

Créer un modèle d'e-mail 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Réponse
Renvoie : CreateEmailTemplate200Response
Exemple

Supprimer un modèle d'e-mail 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

Supprimer une erreur de rendu de modèle d'e-mail 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| errorId | string | path | Yes |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

Récupérer un modèle d'e-mail 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetEmailTemplate200Response
Exemple

Récupérer les définitions des modèles d'e-mail 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: GetEmailTemplateDefinitions200Response
Exemple

Récupérer les erreurs de rendu des modèles d'e-mail 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| skip | number | query | Non |
Réponse
Renvoie: GetEmailTemplateRenderErrors200Response
Exemple

Récupérer les modèles d'e-mail 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie : GetEmailTemplates200Response
Exemple

Rendre un modèle d'e-mail 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| locale | string | query | Non |
Réponse
Renvoie : RenderEmailTemplate200Response
Exemple

Mettre à jour un modèle d'e-mail 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

Récupérer le journal d'événements 
req tenantId urlId userIdWS
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| userIdWS | string | query | Oui | |
| startTime | integer | query | Oui | |
| endTime | integer | query | Oui |
Réponse
Renvoie : GetEventLog200Response
Exemple

Récupérer le journal d'événements global 
req tenantId urlId userIdWS
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| userIdWS | string | query | Oui | |
| startTime | integer | query | Oui | |
| endTime | integer | query | Oui |
Réponse
Renvoie : GetEventLog200Response
Exemple

Créer une publication 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| broadcastId | string | query | Non | |
| isLive | boolean | query | Non | |
| doSpamCheck | boolean | query | Non | |
| skipDupCheck | boolean | query | Non |
Réponse
Renvoie: CreateFeedPost200Response
Exemple

Créer une publication (publique) 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie: CreateFeedPostPublic200Response
Exemple

Supprimer une publication (publique) 
Paramètres
| Name | Type | Location | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : DeleteFeedPostPublic200Response
Exemple

Récupérer les publications 
req tenantId afterId
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| afterId | string | query | Non | |
| limit | integer | query | Non | |
| tags | array | query | Non |
Réponse
Renvoie : GetFeedPosts200Response
Exemple

Récupérer les publications (publiques) 
req tenantId afterId
Paramètres
| Nom | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| afterId | string | query | Non | |
| limit | integer | query | Non | |
| tags | array | query | Non | |
| sso | string | query | Non | |
| isCrawler | boolean | query | Non | |
| includeUserInfo | boolean | query | Non |
Réponse
Retourne : GetFeedPostsPublic200Response
Exemple

Récupérer les statistiques des publications 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postIds | array | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie: GetFeedPostsStats200Response
Exemple

Récupérer les réactions des utilisateurs (public) 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Réponse
Renvoie: GetUserReactsPublic200Response
Exemple

Réagir à une publication (publique) 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postId | string | path | Oui | |
| isUndo | boolean | query | Non | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne: ReactFeedPostPublic200Response
Exemple

Mettre à jour une publication 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

Mettre à jour une publication (publique) 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : CreateFeedPostPublic200Response
Exemple

Signaler un commentaire (public) 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| isFlagged | boolean | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

Ajouter un hashtag 
Paramètres
| Name | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Non |
Réponse
Retourne: AddHashTag200Response
Exemple

Ajouter des hashtags en masse 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Non |
Réponse
Retourne : AddHashTagsBulk200Response
Exemple

Supprimer un hashtag 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Oui | |
| tenantId | string | query | Non |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

Récupérer les hashtags 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| page | number | query | Non |
Réponse
Renvoie: GetHashTags200Response
Exemple

Appliquer un patch à un hashtag 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tag | string | path | Oui | |
| tenantId | string | query | Non |
Réponse
Retourne : PatchHashTag200Response
Exemple

Créer un modérateur 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: CreateModerator200Response
Exemple

Supprimer un modérateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| sendEmail | string | query | Non |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

Récupérer un modérateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetModerator200Response
Exemple

Récupérer les modérateurs 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Retourne : GetModerators200Response
Exemple

Envoyer une invitation 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| fromName | string | query | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

Mettre à jour un modérateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

Supprimer le compteur de notifications 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

Récupérer le nombre de notifications mis en cache 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetCachedNotificationCount200Response
Exemple

Récupérer le nombre de notifications 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non | |
| urlId | string | query | Non | |
| fromCommentId | string | query | Non | |
| viewed | boolean | query | Non | |
| type | string | query | Non |
Réponse
Retourne: GetNotificationCount200Response
Exemple

Récupérer les notifications 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non | |
| urlId | string | query | Non | |
| fromCommentId | string | query | Non | |
| viewed | boolean | query | Non | |
| type | string | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie: GetNotifications200Response
Exemple

Mettre à jour une notification 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

Ajouter une page 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : AddPageAPIResponse
Exemple

Supprimer une page 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Retourne : DeletePageAPIResponse
Exemple

Récupérer la page par identifiant d'URL 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui |
Réponse
Retourne : GetPageByURLIdAPIResponse
Exemple

Récupérer les pages 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: GetPagesAPIResponse
Exemple

Appliquer un patch à une page 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : PatchPageAPIResponse
Exemple

Supprimer un événement webhook en attente 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

Récupérer le nombre d'événements webhook en attente 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | query | Non | |
| externalId | string | query | Non | |
| eventType | string | query | Non | |
| type | string | query | Non | |
| domain | string | query | Non | |
| attemptCountGT | number | query | Non |
Réponse
Renvoie: GetPendingWebhookEventCount200Response
Exemple

Récupérer les événements webhook en attente 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | query | Non | |
| externalId | string | query | Non | |
| eventType | string | query | Non | |
| type | string | query | Non | |
| domain | string | query | Non | |
| attemptCountGT | number | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie : GetPendingWebhookEvents200Response
Exemple

Créer une configuration de question 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateQuestionConfig200Response
Exemple

Supprimer une configuration de question 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

Récupérer une configuration de question 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetQuestionConfig200Response
Exemple

Récupérer les configurations de question 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Retourne : GetQuestionConfigs200Response
Exemple

Mettre à jour une configuration de question 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui | |
| id | string | chemin | Oui |
Réponse
Retourne: FlagCommentPublic200Response
Exemple

Créer un résultat de question 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateQuestionResult200Response
Exemple

Supprimer un résultat de question 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

Récupérer un résultat de question 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetQuestionResult200Response
Exemple

Récupérer les résultats des questions 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Non | |
| userId | string | query | Non | |
| startDate | string | query | Non | |
| questionId | string | query | Non | |
| questionIds | string | query | Non | |
| skip | number | query | Non |
Réponse
Retourne: GetQuestionResults200Response
Exemple

Mettre à jour un résultat de question 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

Agréger les résultats des questions 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| questionId | string | query | Non | |
| questionIds | array | query | Non | |
| urlId | string | query | Non | |
| timeBucket | string | query | Non | |
| startDate | string | query | Non | |
| forceRecalculate | boolean | query | Non |
Réponse
Renvoie: AggregateQuestionResults200Response
Exemple

Agréger en masse les résultats des questions 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| forceRecalculate | boolean | query | Non |
Réponse
Renvoie: BulkAggregateQuestionResults200Response
Exemple

Combiner les commentaires avec les résultats des questions 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| questionId | string | query | Non | |
| questionIds | array | query | Non | |
| urlId | string | query | Non | |
| startDate | string | query | Non | |
| forceRecalculate | boolean | query | Non | |
| minValue | number | query | Non | |
| maxValue | number | query | Non | |
| limit | number | query | Non |
Réponse
Renvoie : CombineCommentsWithQuestionResults200Response
Exemple

Ajouter un utilisateur SSO 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : AddSSOUserAPIResponse
Exemple

Supprimer un utilisateur SSO 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| deleteComments | boolean | query | Non | |
| commentDeleteMode | string | query | Non |
Réponse
Renvoie: DeleteSSOUserAPIResponse
Exemple

Récupérer un utilisateur SSO par e-mail 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| string | path | Oui |
Réponse
Retourne : GetSSOUserByEmailAPIResponse
Exemple

Récupérer un utilisateur SSO par identifiant 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetSSOUserByIdAPIResponse
Exemple

Récupérer les utilisateurs SSO 
Paramètres
| Name | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | integer | query | Non |
Réponse
Retourne: GetSSOUsers200Response
Exemple

Appliquer un patch à un utilisateur SSO 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | boolean | query | Non |
Réponse
Renvoie : PatchSSOUserAPIResponse
Exemple

Remplacer un utilisateur SSO 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Réponse
Renvoie: PutSSOUserAPIResponse
Exemple

Créer un abonnement 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne : CreateSubscriptionAPIResponse
Exemple

Supprimer un abonnement 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Retourne: DeleteSubscriptionAPIResponse
Exemple

Récupérer les abonnements 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non |
Réponse
Retourne : GetSubscriptionsAPIResponse
Exemple

Récupérer les utilisations quotidiennes du locataire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| yearNumber | number | query | Non | |
| monthNumber | number | query | Non | |
| dayNumber | number | query | Non | |
| skip | number | query | Non |
Réponse
Retourne : GetTenantDailyUsages200Response
Exemple

Créer un forfait du locataire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateTenantPackage200Response
Exemple

Supprimer un forfait du locataire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

Récupérer le forfait du locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetTenantPackage200Response
Exemple

Récupérer les forfaits du locataire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie : GetTenantPackages200Response
Exemple

Remplacer le forfait du locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

Mettre à jour le forfait du locataire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: FlagCommentPublic200Response
Exemple

Créer un utilisateur du locataire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: CreateTenantUser200Response
Exemple

Supprimer un utilisateur du locataire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| deleteComments | string | query | Non | |
| commentDeleteMode | string | query | Non |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

Récupérer un utilisateur du locataire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: GetTenantUser200Response
Exemple

Récupérer les utilisateurs du locataire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie : GetTenantUsers200Response
Exemple

Remplacer un utilisateur du locataire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | string | query | Non |
Réponse
Retourne : FlagCommentPublic200Response
Exemple

Envoyer un lien de connexion 
Paramètres
| Name | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| redirectURL | string | query | Non |
Réponse
Retourne: FlagCommentPublic200Response
Exemple

Mettre à jour un utilisateur du locataire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | string | query | Non |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

Créer un locataire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateTenant200Response
Exemple

Supprimer un locataire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| sure | string | query | Non |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

Récupérer un locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : GetTenant200Response
Exemple

Récupérer les locataires 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| meta | string | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie : GetTenants200Response
Exemple

Mettre à jour un locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

Téléverser une image 
Téléverser et redimensionner une image
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| sizePreset | string | query | Non | Préréglage de taille : "Default" (1000x1000px) ou "CrossPlatform" (crée des tailles pour les appareils populaires) |
| urlId | string | query | Non | Identifiant de la page depuis laquelle le téléchargement est effectué, pour configurer |
Réponse
Renvoie: UploadImageResponse
Exemple

Récupérer la progression de badge utilisateur par identifiant 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetUserBadgeProgressById200Response
Exemple

Récupérer la progression de badge utilisateur par identifiant utilisateur 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | path | Oui |
Response
Renvoie : GetUserBadgeProgressById200Response
Exemple

Récupérer la liste de progression des badges utilisateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non | |
| limit | number | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie: GetUserBadgeProgressList200Response
Exemple

Créer un badge utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateUserBadge200Response
Exemple

Supprimer un badge utilisateur 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : UpdateUserBadge200Response
Exemple

Récupérer un badge utilisateur 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetUserBadge200Response
Exemple

Récupérer les badges utilisateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non | |
| badgeId | string | query | Non | |
| type | number | query | Non | |
| displayedOnComments | boolean | query | Non | |
| limit | number | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie : GetUserBadges200Response
Exemple

Mettre à jour un badge utilisateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : UpdateUserBadge200Response
Exemple

Récupérer le nombre de notifications utilisateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : GetUserNotificationCount200Response
Exemple

Récupérer les notifications utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| pageSize | integer | query | Non | |
| afterId | string | query | Non | |
| includeContext | boolean | query | Non | |
| afterCreatedAt | integer | query | Non | |
| unreadOnly | boolean | query | Non | |
| dmOnly | boolean | query | Non | |
| noDm | boolean | query | Non | |
| includeTranslations | boolean | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : GetUserNotifications200Response
Exemple

Réinitialiser le compteur de notifications utilisateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : ResetUserNotifications200Response
Exemple

Réinitialiser les notifications utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| afterId | string | query | Non | |
| afterCreatedAt | integer | query | Non | |
| unreadOnly | boolean | query | Non | |
| dmOnly | boolean | query | Non | |
| noDm | boolean | query | Non | |
| sso | string | query | Non |
Réponse
Retourne: ResetUserNotifications200Response
Exemple

Mettre à jour le statut d'abonnement aux commentaires pour la notification utilisateur 
Activer ou désactiver les notifications pour un commentaire spécifique.
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| notificationId | string | path | Oui | |
| optedInOrOut | string | path | Oui | |
| commentId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie: UpdateUserNotificationStatus200Response
Exemple

Mettre à jour le statut d'abonnement aux pages pour la notification utilisateur 
Activer ou désactiver les notifications pour une page. Lorsqu'un utilisateur est abonné à une page, des notifications sont créées pour les nouveaux commentaires racine, et aussi
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui | |
| url | string | query | Oui | |
| pageTitle | string | query | Oui | |
| subscribedOrUnsubscribed | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : UpdateUserNotificationStatus200Response
Exemple

Mettre à jour le statut de la notification utilisateur 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| notificationId | string | path | Oui | |
| newStatus | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie: UpdateUserNotificationStatus200Response
Exemple

Récupérer les statuts de présence utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlIdWS | string | query | Oui | |
| userIds | string | query | Oui |
Réponse
Renvoie : GetUserPresenceStatuses200Response
Exemple

Rechercher des utilisateurs 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| usernameStartsWith | string | query | Oui | |
| mentionGroupIds | array | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : SearchUsers200Response
Exemple

Récupérer un utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetUser200Response
Exemple

Créer un vote 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | query | Oui | |
| direction | string | query | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Retourne: VoteComment200Response
Exemple

Supprimer un vote 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| editKey | string | query | Non |
Réponse
Renvoie : DeleteCommentVote200Response
Exemple

Récupérer les votes 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui |
Réponse
Renvoie: GetVotes200Response
Exemple

Récupérer les votes pour un utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Renvoie: GetVotesForUser200Response
Exemple

Besoin d'aide?
Si vous rencontrez des problèmes ou avez des questions concernant le SDK Swift, veuillez :
Contribuer
Les contributions sont les bienvenues ! Veuillez consulter le dépôt GitHub pour les consignes de contribution.