
Langue 🇫🇷 Français (France)
Premiers pas
Documentation
Référence API
Agrégation
Journaux d'audit
Blocage depuis un commentaire
Vérifier les commentaires bloqués
Commentaires
Configurations de domaine
Modèles d'e-mail
Journal d'événements
Publications
Signaler un commentaire
Hashtags
Modérateurs
Nombre de notifications
Notifications
Pages
Événements webhook en attente
Configurations de questions
Résultats des questions
Agrégation des résultats de questions
Utilisateurs SSO
Abonnements
Utilisation quotidienne du locataire
Forfaits du locataire
Utilisateurs du locataire
Locataires
Tickets
Téléverser une image
Progression des badges utilisateur
Badges utilisateur
Notifications utilisateur
Statuts de présence des utilisateurs
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 à votre Package.swift file:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "1.2.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
aggregate 
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

getAuditLogs 
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

blockFromCommentPublic 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Retourne : BlockFromCommentPublic200Response
Exemple

unBlockCommentPublic 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie: UnBlockCommentPublic200Response
Exemple

checkedCommentsForBlocked 
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

blockUserFromComment 
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

createCommentPublic 
Paramètres
| Nom | Type | Location | Requis | 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

deleteComment 
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

deleteCommentPublic 
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

deleteCommentVote 
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

flagComment 
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

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

getComments 
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

getCommentsPublic 
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

getCommentText 
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

getCommentVoteUserNames 
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

lockComment 
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

pinComment 
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

saveComment 
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
Renvoie: SaveComment200Response
Exemple

saveCommentsBulk 
Paramètres
| Name | Type | Location | 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

setCommentText 
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

unBlockUserFromComment 
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

unFlagComment 
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

unLockComment 
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

unPinComment 
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

updateComment 
Paramètres
| Nom | Type | Location | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| contextUserId | string | query | Non | |
| doSpamCheck | boolean | query | Non | |
| isLive | boolean | query | Non |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

voteComment 
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

addDomainConfig 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : AddDomainConfig200Response
Exemple

deleteDomainConfig 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domain | string | path | Oui |
Réponse
Renvoie: DeleteDomainConfig200Response
Exemple

getDomainConfig 
Paramètres
| Name | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domain | string | path | Oui |
Réponse
Renvoie: GetDomainConfig200Response
Exemple

getDomainConfigs 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne: GetDomainConfigs200Response
Exemple

patchDomainConfig 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Réponse
Renvoie : GetDomainConfig200Response
Exemple

putDomainConfig 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domainToUpdate | string | path | Oui |
Réponse
Renvoie : GetDomainConfig200Response
Exemple

createEmailTemplate 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Réponse
Renvoie : CreateEmailTemplate200Response
Exemple

deleteEmailTemplate 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

deleteEmailTemplateRenderError 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| errorId | string | path | Yes |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

getEmailTemplate 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetEmailTemplate200Response
Exemple

getEmailTemplateDefinitions 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: GetEmailTemplateDefinitions200Response
Exemple

getEmailTemplateRenderErrors 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| skip | number | query | Non |
Réponse
Renvoie: GetEmailTemplateRenderErrors200Response
Exemple

getEmailTemplates 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie : GetEmailTemplates200Response
Exemple

renderEmailTemplate 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| locale | string | query | Non |
Réponse
Renvoie : RenderEmailTemplate200Response
Exemple

updateEmailTemplate 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

getEventLog 
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

getGlobalEventLog 
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

createFeedPost 
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

createFeedPostPublic 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie: CreateFeedPostPublic200Response
Exemple

deleteFeedPostPublic 
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

getFeedPosts 
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

getFeedPostsPublic 
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

getFeedPostsStats 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postIds | array | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie: GetFeedPostsStats200Response
Exemple

getUserReactsPublic 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Réponse
Renvoie: GetUserReactsPublic200Response
Exemple

reactFeedPostPublic 
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

updateFeedPost 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

updateFeedPostPublic 
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

flagCommentPublic 
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

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

addHashTagsBulk 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Non |
Réponse
Retourne : AddHashTagsBulk200Response
Exemple

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

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

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

createModerator 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: CreateModerator200Response
Exemple

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

getModerator 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetModerator200Response
Exemple

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

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

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

deleteNotificationCount 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

getCachedNotificationCount 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetCachedNotificationCount200Response
Exemple

getNotificationCount 
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

getNotifications 
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

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

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

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

getPageByURLId 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui |
Réponse
Retourne : GetPageByURLIdAPIResponse
Exemple

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

patchPage 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : PatchPageAPIResponse
Exemple

deletePendingWebhookEvent 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

getPendingWebhookEventCount 
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

getPendingWebhookEvents 
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

createQuestionConfig 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateQuestionConfig200Response
Exemple

deleteQuestionConfig 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

getQuestionConfig 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetQuestionConfig200Response
Exemple

getQuestionConfigs 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Retourne : GetQuestionConfigs200Response
Exemple

updateQuestionConfig 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui | |
| id | string | chemin | Oui |
Réponse
Retourne: FlagCommentPublic200Response
Exemple

createQuestionResult 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateQuestionResult200Response
Exemple

deleteQuestionResult 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

getQuestionResult 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetQuestionResult200Response
Exemple

getQuestionResults 
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

updateQuestionResult 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

aggregateQuestionResults 
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

bulkAggregateQuestionResults 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| forceRecalculate | boolean | query | Non |
Réponse
Renvoie: BulkAggregateQuestionResults200Response
Exemple

combineCommentsWithQuestionResults 
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

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

deleteSSOUser 
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

getSSOUserByEmail 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| string | path | Oui |
Réponse
Retourne : GetSSOUserByEmailAPIResponse
Exemple

getSSOUserById 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetSSOUserByIdAPIResponse
Exemple

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

patchSSOUser 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | boolean | query | Non |
Réponse
Renvoie : PatchSSOUserAPIResponse
Exemple

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

createSubscription 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne : CreateSubscriptionAPIResponse
Exemple

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

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

updateSubscription 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Renvoie: UpdateSubscriptionAPIResponse
Exemple

getTenantDailyUsages 
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

createTenantPackage 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: CreateTenantPackage200Response
Exemple

deleteTenantPackage 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

getTenantPackage 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetTenantPackage200Response
Exemple

getTenantPackages 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie : GetTenantPackages200Response
Exemple

replaceTenantPackage 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

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

createTenantUser 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: CreateTenantUser200Response
Exemple

deleteTenantUser 
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

getTenantUser 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: GetTenantUser200Response
Exemple

getTenantUsers 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie : GetTenantUsers200Response
Exemple

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

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

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

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

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

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

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

updateTenant 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

changeTicketState 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : ChangeTicketState200Response
Exemple

createTicket 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Oui |
Réponse
Renvoie : CreateTicket200Response
Exemple

getTicket 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Renvoie : GetTicket200Response
Exemple

getTickets 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non | |
| state | number | query | Non | |
| skip | number | query | Non | |
| limit | number | query | Non |
Réponse
Renvoie : GetTickets200Response
Exemple

uploadImage 
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

getUserBadgeProgressById 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetUserBadgeProgressById200Response
Exemple

getUserBadgeProgressByUserId 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | path | Oui |
Response
Renvoie : GetUserBadgeProgressById200Response
Exemple

getUserBadgeProgressList 
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

createUserBadge 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateUserBadge200Response
Exemple

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

getUserBadge 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetUserBadge200Response
Exemple

getUserBadges 
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

updateUserBadge 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : UpdateUserBadge200Response
Exemple

getUserNotificationCount 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : GetUserNotificationCount200Response
Exemple

getUserNotifications 
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

resetUserNotificationCount 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : ResetUserNotifications200Response
Exemple

resetUserNotifications 
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

updateUserNotificationCommentSubscriptionStatus 
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

updateUserNotificationPageSubscriptionStatus 
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

updateUserNotificationStatus 
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

getUserPresenceStatuses 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlIdWS | string | query | Oui | |
| userIds | string | query | Oui |
Réponse
Renvoie : GetUserPresenceStatuses200Response
Exemple

searchUsers 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| usernameStartsWith | string | query | Non | |
| mentionGroupIds | array | query | Non | |
| sso | string | query | Non | |
| searchSection | string | query | Non |
Réponse
Retourne: SearchUsers200Response
Exemple

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

createVote 
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

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

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

getVotesForUser 
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.