
Lingua 🇮🇹 Italiano
Primi passi
Documentazione
Riferimento API
Aggregazione
Log di audit
Autenticazione
Blocca dal commento
Verifica commenti bloccati
Commenti
Commenti per utente
Configurazioni dominio
Modelli email
Registro eventi
Post del feed
Segnala commento
Gif
Hashtag
Moderazione
Moderatori
Conteggio notifiche
Notifiche
Reazioni alla pagina
Pagine
Eventi webhook in sospeso
Configurazioni domande
Risultati delle domande
Aggregazione risultati domande
Utenti SSO
Sottoscrizioni
Utilizzo giornaliero tenant
Pacchetti tenant
Utenti tenant
Tenant
Ticket
Traduzioni
Carica immagine
Progresso badge utente
Badge utente
Notifiche utente
Stato presenza utente
Ricerca utenti
Utenti
Voti
SDK Swift di FastComments
Questo è l'SDK Swift ufficiale per FastComments.
SDK Swift ufficiale per l'API di FastComments
Repository
Installazione 
Gestore di pacchetti Swift
Aggiungi quanto segue al tuo file Package.swift:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.0.0")
]
Oppure in Xcode:
- File > Aggiungi pacchetti...
- Inserisci l'URL del repository:
https://github.com/fastcomments/fastcomments-swift.git - Seleziona la versione che desideri utilizzare
Requisiti
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Library Contents 
Lo SDK FastComments per Swift è composto da diversi moduli:
-
Client Module - Client per le API REST di FastComments
- Definizioni di tipo complete per tutti i modelli API
- Metodi autenticati (
DefaultAPI), pubblici (PublicAPI) e di moderazione (ModerationAPI) - Supporto completo per async/await
- Vedi client/README.md per la documentazione dettagliata delle API
-
SSO Module - Utility server-side per il Single Sign-On
- Generazione sicura di token per l'autenticazione degli utenti
- Supporto per entrambe le modalità SSO: semplice e sicura
- Firma dei token basata su HMAC-SHA256 tramite CryptoKit
Quick Start 
Utilizzo dell'API Pubblica
import FastCommentsSwift
// Recupera i commenti per una pagina
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)")
}
Utilizzo dell'API Autenticata
import FastCommentsSwift
// Configura la tua chiave API nella configurazione condivisa (inviata come intestazione x-api-key)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// Recupera i commenti usando l'API autenticata
do {
let response = try await DefaultAPI.getComments(
tenantId: "your-tenant-id",
options: .init(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)")
}
Utilizzo dell'API di Moderazione
import FastCommentsSwift
// I metodi di moderazione sono autorizzati con un token `sso` per il moderatore attivo
// (generalo con FastCommentsSSO, vedi la sezione SSO sopra).
do {
let response = try await ModerationAPI.getApiComments(
options: .init(
page: 0,
count: 30,
sso: ssoToken
)
)
print("Found \(response.comments.count) comments to moderate")
for comment in response.comments {
print("Comment ID: \(comment.id), Text: \(comment.commentHTML)")
}
} catch {
print("Error: \(error)")
}
Utilizzo di SSO per l'Autenticazione
SSO Sicuro (Consigliato per la Produzione)
import FastCommentsSwift
let apiKey = "your-api-key"
// Crea dati utente SSO sicuri (solo lato server!)
let userData = SecureSSOUserData(
id: "user-123", // ID Utente
email: "user@example.com", // Email
username: "johndoe", // Nome utente
avatar: "https://example.com/avatar.jpg" // URL Avatar
)
// Genera token SSO
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Passa questo token al tuo frontend per l'autenticazione
} catch {
print("Error creating SSO token: \(error)")
}
SSO Semplice (Per Sviluppo/Test)
import FastCommentsSwift
// Crea dati utente SSO semplici (non è necessaria una chiave API)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Genera token SSO semplice
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 Clients 
L'SDK FastComments fornisce tre client API:
PublicAPI - Metodi Sicuri per il Client
Il PublicAPI contiene metodi che sono sicuri da chiamare dal codice client‑side (app iOS/macOS). Questi metodi:
- Non richiedono una chiave API
- Possono utilizzare token SSO per l'autenticazione
- Sono soggetti a limitazione di velocità per utente/dispositivo
- Sono adatti per applicazioni rivolte all'utente finale
Caso d'uso esempio: Recuperare e creare commenti nella tua app iOS
DefaultAPI - Metodi Server‑Side
Il DefaultAPI contiene metodi autenticati che richiedono una chiave API. Questi metodi:
- Richiedono la tua chiave API FastComments
- Dovrebbero essere chiamati SOLO dal codice server‑side
- Forniscono accesso completo ai tuoi dati FastComments
- Sono soggetti a limitazione di velocità per tenant
Caso d'uso esempio: Operazioni amministrative, esportazione massiva di dati, gestione degli utenti
ModerationAPI - Metodi della Dashboard del Moderatore
Il ModerationAPI fornisce una suite completa di API di moderazione in tempo reale e veloci. Ogni metodo ModerationAPI accetta un parametro sso e può autenticarsi tramite SSO o un cookie di sessione FastComments.com.
Caso d'uso esempio: Creare un'esperienza di moderazione per i moderatori della tua comunità
IMPORTANTE: Non esporre mai la tua chiave API nel codice client‑side. Le chiavi API dovrebbero essere utilizzate solo lato server.
Making API Calls 
L'SDK Swift utilizza la moderna sintassi async/await per tutte le chiamate API:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Common Issues 
Errori 401 Non Autorizzati
If you're getting 401 errors when using the authenticated API:
- Controlla la tua chiave API: Assicurati di utilizzare la chiave API corretta dal tuo cruscotto FastComments
- Verifica l'ID tenant: Assicurati che l'ID tenant corrisponda al tuo account
- Formato della chiave API: La chiave API dovrebbe essere impostata come intestazione
x-api-keynella configurazione condivisa:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- Utilizzo della API sbagliata: Assicurati di utilizzare
DefaultAPI(nonPublicAPI) per le chiamate autenticate
Problemi con i Token SSO
If SSO tokens aren't working:
- Usa la modalità sicura per la produzione: Usa sempre
FastCommentsSSO.createSecure()con la tua chiave API per la produzione - Solo lato server: Genera token SSO sicuri sul tuo server, non esporre mai la tua chiave API ai client
- Controlla i dati dell'utente: Assicurati che tutti i campi richiesti (id, email, username) siano forniti
- Scadenza del token: I token SSO sicuri includono un timestamp e possono scadere. Genera token nuovi quando necessario.
Errori SSL/TLS
If you encounter SSL/TLS errors:
- Assicurati che il file Info.plist della tua app consenta connessioni HTTPS a fastcomments.com
- Verifica di non utilizzare eccezioni di App Transport Security che potrebbero bloccare la connessione
Notes 
ID di broadcast
Vedrai che devi passare un broadcastId in alcune chiamate API. Quando ricevi eventi, ti verrà restituito questo ID, così saprai di ignorare l'evento se prevedi di applicare le modifiche in modo ottimistico sul client (cosa che probabilmente vorrai fare, poiché offre la migliore esperienza). Passa qui un UUID. L'ID dovrebbe essere sufficientemente unico da non comparire due volte in una sessione.
let broadcastId = UUID().uuidString
aggregate 
Aggrega i documenti raggruppandoli (se groupBy è fornito) e applicando più operazioni.
Sono supportate diverse operazioni (ad es. sum, countDistinct, avg, ecc.).
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Risposta
Restituisce: AggregateResponse
Esempio

getAuditLogs 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Risposta
Restituisce: GetAuditLogsResponse
Esempio

logoutPublic 
Risposta
Restituisce: APIEmptyResponse
Esempio

blockFromCommentPublic 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| sso | string | query | No |
Risposta
Restituisce: BlockSuccess
Esempio

unBlockCommentPublic 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| sso | string | query | No |
Risposta
Restituisce: UnblockSuccess
Esempio

checkedCommentsForBlocked 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentIds | string | query | Sì | Una lista di ID dei commenti separati da virgole. |
| sso | string | query | No |
Risposta
Restituisce: CheckBlockedCommentsResponse
Esempio

blockUserFromComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Risposta
Restituisce: BlockSuccess
Esempio

createCommentPublic 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: SaveCommentsResponseWithPresence
Esempio

deleteComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Risposta
Restituisce: DeleteCommentResult
Esempio

deleteCommentPublic 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | Sì | |
| editKey | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: PublicAPIDeleteCommentResponse
Esempio

deleteCommentVote 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Response
Restituisce: VoteDeleteResponse
Example

flagComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Risposta
Restituisce: FlagCommentResponse
Esempio

getComment 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIGetCommentResponse
Esempio

getComments 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| page | integer | query | No | |
| limit | integer | query | No | |
| skip | integer | query | No | |
| asTree | boolean | query | No | |
| skipChildren | integer | query | No | |
| limitChildren | integer | query | No | |
| maxTreeDepth | integer | query | No | |
| urlId | string | query | No | |
| userId | string | query | No | |
| anonUserId | string | query | No | |
| contextUserId | string | query | No | |
| hashTag | string | query | No | |
| parentId | string | query | No | |
| direction | string | query | No | |
| fromDate | integer | query | No | |
| toDate | integer | query | No |
Risposta
Restituisce: APIGetCommentsResponse
Esempio

getCommentsPublic 
req tenantId urlId
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No |
Risposta
Restituisce: GetCommentsResponseWithPresencePublicComment
Esempio

getCommentText 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| editKey | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: PublicAPIGetCommentTextResponse
Esempio

getCommentVoteUserNames 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| dir | integer | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: GetCommentVoteUserNamesSuccessResponse
Esempio

lockComment 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

pinComment 
Parametri
| Nome | Tipo | Location | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: ChangeCommentPinStatusResponse
Esempio

saveComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Risposta
Restituisce: APISaveCommentResponse
Esempio

saveCommentsBulk 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Risposta
Restituisce: [SaveCommentsBulkResponse]
Esempio

setCommentText 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: PublicAPISetCommentTextResponse
Esempio

unBlockUserFromComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Risposta
Returns: UnblockSuccess
Esempio

unFlagComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Risposta
Restituisce: FlagCommentResponse
Esempio

unLockComment 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

unPinComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: ChangeCommentPinStatusResponse
Esempio

updateComment 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

voteComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| commentId | string | path | Sì | |
| urlId | string | query | Sì | |
| broadcastId | string | query | Sì | |
| sessionId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: VoteResponse
Esempio

getCommentsForUser 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| userId | string | query | No | |
| direction | string | query | No | |
| repliesToUserId | string | query | No | |
| page | number | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| isCrawler | boolean | query | No |
Risposta
Restituisce: GetCommentsForUserResponse
Esempio

addDomainConfig 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: AddDomainConfigResponse
Esempio

deleteDomainConfig 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| domain | string | path | Sì |
Risposta
Restituisce: DeleteDomainConfigResponse
Esempio

getDomainConfig 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| domain | string | path | Sì |
Risposta
Restituisce: GetDomainConfigResponse
Esempio

getDomainConfigs 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: GetDomainConfigsResponse
Esempio

patchDomainConfig 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| domainToUpdate | string | path | Sì |
Risposta
Restituisce: PatchDomainConfigResponse
Esempio

putDomainConfig 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| domainToUpdate | string | path | Sì |
Risposta
Restituisce: PutDomainConfigResponse
Esempio

createEmailTemplate 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateEmailTemplateResponse
Esempio

deleteEmailTemplate 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

deleteEmailTemplateRenderError 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| errorId | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

getEmailTemplate 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetEmailTemplateResponse
Esempio

getEmailTemplateDefinitions 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: GetEmailTemplateDefinitionsResponse
Esempio

getEmailTemplateRenderErrors 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| skip | number | query | No |
Risposta
Restituisce: GetEmailTemplateRenderErrorsResponse
Esempio

getEmailTemplates 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| skip | number | query | No |
Risposta
Restituisce: GetEmailTemplatesResponse
Esempio

renderEmailTemplate 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| locale | string | query | No |
Risposta
Restituisce: RenderEmailTemplateResponse
Esempio

updateEmailTemplate 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

getEventLog 
req tenantId urlId userIdWS
Parametri
| Nome | Tipo | Location | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì | |
| userIdWS | string | query | Sì | |
| startTime | integer | query | Sì | |
| endTime | integer | query | No |
Risposta
Restituisce: GetEventLogResponse
Esempio

getGlobalEventLog 
req tenantId urlId userIdWS
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì | |
| userIdWS | string | query | Sì | |
| startTime | integer | query | Sì | |
| endTime | integer | query | No |
Risposta
Restituisce: GetEventLogResponse
Esempio

createFeedPost 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Risposta
Restituisce: CreateFeedPostsResponse
Esempio

createFeedPostPublic 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Restituisce: CreateFeedPostResponse
Esempio

deleteFeedPostPublic 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: DeleteFeedPostPublicResponse
Esempio

getFeedPosts 
req tenantId afterId
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
Risposta
Restituisce: GetFeedPostsResponse
Esempio

getFeedPostsPublic 
req tenantId afterId
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No | |
| sso | string | query | No | |
| isCrawler | boolean | query | No | |
| includeUserInfo | boolean | query | No |
Risposta
Restituisce: PublicFeedPostsResponse
Esempio

getFeedPostsStats 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| postIds | array | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: FeedPostsStatsResponse
Esempio

getUserReactsPublic 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Risposta
Restituisce: UserReactsResponse
Esempio

reactFeedPostPublic 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| postId | string | path | Sì | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ReactFeedPostResponse
Esempio

updateFeedPost 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

updateFeedPostPublic 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: CreateFeedPostResponse
Esempio

flagCommentPublic 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| isFlagged | boolean | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

getGifLarge 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| largeInternalURLSanitized | string | query | Sì |
Risposta
Restituisce: GifGetLargeResponse
Esempio

getGifsSearch 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| search | string | query | Sì | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Risposta
Restituisce: GetGifsSearchResponse
Esempio

getGifsTrending 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Risposta
Restituisce: GetGifsTrendingResponse
Esempio

addHashTag 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateHashTagResponse
Esempio

addHashTagsBulk 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: BulkCreateHashTagsResponse
Esempio

deleteHashTag 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| tag | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

getHashTags 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| page | number | query | No |
Risposta
Restituisce: GetHashTagsResponse
Esempio

patchHashTag 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Risposta
Restituisce: UpdateHashTagResponse
Esempio

deleteModerationVote 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| voteId | string | path | Sì | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: VoteDeleteResponse
Esempio

getApiComments 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationAPIGetCommentsResponse
Esempio

getApiExportStatus 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| batchJobId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationExportStatusResponse
Esempio

getApiIds 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationAPIGetCommentIdsResponse
Esempio

getBanUsersFromComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| sso | string | query | No |
Risposta
Restituisce: GetBannedUsersFromCommentResponse
Esempio

getCommentBanStatus 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| sso | string | query | No |
Risposta
Restituisce: GetCommentBanStatusResponse
Esempio

getCommentChildren 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| sso | string | query | No |
Risposta
Restituisce: ModerationAPIChildCommentsResponse
Esempio

getCount 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filter | string | query | No | |
| searchFilters | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationAPICountCommentsResponse
Esempio

getCounts 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: GetBannedUsersCountResponse
Esempio

getLogs 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Restituisce: ModerationAPIGetLogsResponse
Example

getManualBadges 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: GetTenantManualBadgesResponse
Esempio

getManualBadgesForUser 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
Risposta
Returns: GetUserManualBadgesResponse
Esempio

getModerationComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationAPICommentResponse
Esempio

getModerationCommentText 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| sso | string | query | No |
Risposta
Restituisce: GetCommentTextResponse
Esempio

getPreBanSummary 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Risposta
Restituisce: PreBanSummary
Esempio

getSearchCommentsSummary 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationCommentSearchResponse
Esempio

getSearchPages 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| value | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationPageSearchResponse
Esempio

getSearchSites 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| value | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationSiteSearchResponse
Esempio

getSearchSuggest 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| text-search | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationSuggestResponse
Esempio

getSearchUsers 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Response
Restituisce: ModerationUserSearchResponse
Example

getTrustFactor 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: GetUserTrustFactorResponse
Esempio

getUserBanPreference 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: APIModerateGetUserBanPreferencesResponse
Esempio

getUserInternalProfile 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: GetUserInternalProfileResponse
Esempio

postAdjustCommentVotes 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: AdjustVotesResponse
Esempio

postApiExport 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ModerationExportResponse
Esempio

postBanUserFromComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| banEmail | boolean | query | No | |
| banEmailDomain | boolean | query | No | |
| banIP | boolean | query | No | |
| deleteAllUsersComments | boolean | query | No | |
| bannedUntil | string | query | No | |
| isShadowBan | boolean | query | No | |
| updateId | string | query | No | |
| banReason | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: BanUserFromCommentResult
Esempio

postBanUserUndo 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

postBulkPreBanSummary 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Risposta
Restituisce: BulkPreBanSummary
Esempio

postCommentsByIds 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: ModerationAPIChildCommentsResponse
Esempio

postFlagComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

postRemoveComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: PostRemoveCommentApiResponse
Esempio

postRestoreDeletedComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Returns: APIEmptyResponse
Esempio

postSetCommentApprovalStatus 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: SetCommentApprovedResponse
Esempio

postSetCommentReviewStatus 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

postSetCommentSpamStatus 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

postSetCommentText 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | path | Sì | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: SetCommentTextResponse
Esempio

postUnFlagComment 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

postVote 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Returns: VoteResponse
Esempio

putAwardBadge 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| badgeId | string | query | Sì | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: AwardUserBadgeResponse
Esempio

putCloseThread 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Response
Restituisce: APIEmptyResponse
Example

putRemoveBadge 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: RemoveUserBadgeResponse
Esempio

putReopenThread 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

setTrustFactor 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Risposta
Restituisce: SetUserTrustFactorResponse
Esempio

createModerator 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateModeratorResponse
Esempio

deleteModerator 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| sendEmail | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

getModerator 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetModeratorResponse
Esempio

getModerators 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| skip | number | query | No |
Risposta
Restituisce: GetModeratorsResponse
Esempio

sendInvite 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| fromName | string | query | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

updateModerator 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

deleteNotificationCount 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

getCachedNotificationCount 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetCachedNotificationCountResponse
Esempio

getNotificationCount 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Risposta
Restituisce: GetNotificationCountResponse
Esempio

getNotifications 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
Risposta
Restituisce: GetNotificationsResponse
Esempio

updateNotification 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| userId | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

createV1PageReact 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì | |
| title | string | query | No |
Risposta
Restituisce: CreateV1PageReact
Esempio

createV2PageReact 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì | |
| id | string | query | Sì | |
| title | string | query | No |
Risposta
Restituisce: CreateV1PageReact
Esempio

deleteV1PageReact 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì |
Risposta
Restituisce: CreateV1PageReact
Esempio

deleteV2PageReact 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | percorso | Sì | |
| urlId | string | query | Sì | |
| id | string | query | Sì |
Risposta
Restituisce: CreateV1PageReact
Esempio

getV1PageLikes 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì |
Risposta
Restituisce: GetV1PageLikes
Esempio

getV2PageReacts 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì |
Risposta
Restituisce: GetV2PageReacts
Esempio

getV2PageReactUsers 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| urlId | string | query | Sì | |
| id | string | query | Sì |
Risposta
Restituisce: GetV2PageReactUsersResponse
Esempio

addPage 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: AddPageAPIResponse
Esempio

deletePage 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: DeletePageAPIResponse
Esempio

getOfflineUsers 
Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName}
index from afterName forward via $gt, no $skip cost.
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identificatore URL della pagina (pulito lato server). |
| afterName | string | query | No | Cursore: passa nextAfterName dalla risposta precedente. |
| afterUserId | string | query | No | Risoluzione di pareggio del cursore: passa nextAfterUserId dalla risposta precedente. Richiesto quando afterName è impostato affinché i pareggi di nome non eliminino voci. |
Response
Returns: PageUsersOfflineResponse
Esempio

getOnlineUsers 
Attualmente online visualizzatori di una pagina: persone la cui sessione websocket è iscritta alla pagina in questo momento.
Restituisce anonCount + totalCount (abbonati a livello di stanza, inclusi i visualizzatori anonimi che non elenchiamo).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identificatore URL della pagina (pulito lato server). |
| afterName | string | query | No | Cursore: passa nextAfterName dalla risposta precedente. |
| afterUserId | string | query | No | Cursore di scontro: passa nextAfterUserId dalla risposta precedente. Richiesto quando afterName è impostato affinché i pareggi di nome non elimino voci. |
Response
Restituisce: PageUsersOnlineResponse
Example

getPageByURLId 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlId | string | query | Sì |
Risposta
Restituisce: GetPageByURLIdAPIResponse
Esempio

getPages 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: GetPagesAPIResponse
Esempio

getPagesPublic 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Cursore di paginazione opaco restituito come nextCursor da una richiesta precedente. Legato allo stesso sortBy. |
| limit | integer | query | No | 1..200, predefinito 50 |
| q | string | query | No | Filtro opzionale del prefisso del titolo, insensibile al maiuscolo/minuscolo. |
| sortBy | string | query | No | Ordine di ordinamento. updatedAt (predefinito, più recenti per primi), commentCount (più commenti per primi), o title (alfabetico). |
| hasComments | boolean | query | No | Se true, restituisce solo le pagine con almeno un commento. |
Risposta
Restituisce: GetPublicPagesResponse
Esempio

getUsersInfo 
Informazioni utente in blocco per un tenant. Dato userIds, restituisce informazioni di visualizzazione da User / SSOUser. Usato dal widget dei commenti per arricchire gli utenti che sono appena apparsi tramite un evento di presenza. Nessun contesto di pagina: la privacy è applicata in modo uniforme (i profili privati sono mascherati).
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| ids | string | query | Sì | ID utente separati da virgola. |
Risposta
Restituisce: PageUsersInfoResponse
Esempio

patchPage 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: PatchPageAPIResponse
Esempio

deletePendingWebhookEvent 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

getPendingWebhookEventCount 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No |
Response
Restituisce: GetPendingWebhookEventCountResponse
Example

getPendingWebhookEvents 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No | |
| skip | number | query | No |
Risposta
Restituisce: GetPendingWebhookEventsResponse
Esempio

createQuestionConfig 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateQuestionConfigResponse
Esempio

deleteQuestionConfig 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

getQuestionConfig 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetQuestionConfigResponse
Esempio

getQuestionConfigs 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| skip | number | query | No |
Risposta
Restituisce: GetQuestionConfigsResponse
Esempio

updateQuestionConfig 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

createQuestionResult 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateQuestionResultResponse
Esempio

deleteQuestionResult 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

getQuestionResult 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetQuestionResultResponse
Esempio

getQuestionResults 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | |
| userId | string | query | No | |
| startDate | string | query | No | |
| questionId | string | query | No | |
| questionIds | string | query | No | |
| skip | number | query | No |
Risposta
Restituisce: GetQuestionResultsResponse
Esempio

updateQuestionResult 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

aggregateQuestionResults 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
Risposta
Restituisce: AggregateQuestionResultsResponse
Esempio

bulkAggregateQuestionResults 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| forceRecalculate | boolean | query | No |
Risposta
Restituisce: BulkAggregateQuestionResultsResponse
Esempio

combineCommentsWithQuestionResults 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Risposta
Restituisce: CombineQuestionResultsWithCommentsResponse
Esempio

addSSOUser 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: AddSSOUserAPIResponse
Esempio

deleteSSOUser 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
Risposta
Restituisce: DeleteSSOUserAPIResponse
Esempio

getSSOUserByEmail 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| string | path | Sì |
Risposta
Restituisce: GetSSOUserByEmailAPIResponse
Esempio

getSSOUserById 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetSSOUserByIdAPIResponse
Esempio

getSSOUsers 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| skip | integer | query | No |
Risposta
Restituisce: GetSSOUsersResponse
Esempio

patchSSOUser 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Risposta
Restituisce: PatchSSOUserAPIResponse
Esempio

putSSOUser 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Risposta
Restituisce: PutSSOUserAPIResponse
Esempio

createSubscription 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateSubscriptionAPIResponse
Esempio

deleteSubscription 
Parametri
| Name | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| userId | string | query | No |
Risposta
Restituisce: DeleteSubscriptionAPIResponse
Esempio

getSubscriptions 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | query | No |
Risposta
Restituisce: GetSubscriptionsAPIResponse
Esempio

updateSubscription 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| userId | string | query | No |
Risposta
Restituisce: UpdateSubscriptionAPIResponse
Esempio

getTenantDailyUsages 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Risposta
Restituisce: GetTenantDailyUsagesResponse
Esempio

createTenantPackage 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateTenantPackageResponse
Esempio

deleteTenantPackage 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

getTenantPackage 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetTenantPackageResponse
Esempio

getTenantPackages 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| skip | number | query | No |
Risposta
Restituisce: GetTenantPackagesResponse
Esempio

replaceTenantPackage 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

updateTenantPackage 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

createTenantUser 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateTenantUserResponse
Esempio

deleteTenantUser 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

getTenantUser 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetTenantUserResponse
Esempio

getTenantUsers 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| skip | number | query | No |
Risposta
Restituisce: GetTenantUsersResponse
Esempio

replaceTenantUser 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

sendLoginLink 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| redirectURL | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

updateTenantUser 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| updateComments | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

createTenant 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì |
Risposta
Restituisce: CreateTenantResponse
Esempio

deleteTenant 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| sure | string | query | No |
Risposta
Restituisce: APIEmptyResponse
Esempio

getTenant 
Parametri
| Nome | Type | Location | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Response
Restituisce: GetTenantResponse
Esempio

updateTenant 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptyResponse
Esempio

changeTicketState 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes | |
| id | string | path | Yes |
Risposta
Restituisce: ChangeTicketStateResponse
Esempio

createTicket 
Parametri
| Nome | Tipo | Posizione | Richiesto | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | query | Sì |
Risposta
Restituisce: CreateTicketResponse
Esempio

getTicket 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì | |
| userId | string | query | No |
Risposta
Restituisce: GetTicketResponse
Esempio

getTickets 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Risposta
Restituisce: GetTicketsResponse
Esempio

getTranslations 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| namespace | string | path | Sì | |
| component | string | path | Sì | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Risposta
Restituisce: GetTranslationsResponse
Esempio

uploadImage 
Carica e ridimensiona un'immagine
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | |
| sizePreset | string | query | No | Preset di dimensione: "Default" (1000x1000px) o "CrossPlatform" (crea dimensioni per dispositivi popolari) |
| urlId | string | query | No | ID pagina da cui avviene il caricamento, da configurare |
Risposta
Restituisce: UploadImageResponse
Esempio

getUserBadgeProgressById 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIGetUserBadgeProgressResponse
Esempio

getUserBadgeProgressByUserId 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | path | Sì |
Risposta
Restituisce: APIGetUserBadgeProgressResponse
Esempio

getUserBadgeProgressList 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Risposta
Returns: APIGetUserBadgeProgressListResponse
Esempio

createUserBadge 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Risposta
Restituisce: APICreateUserBadgeResponse
Esempio

deleteUserBadge 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptySuccessResponse
Esempio

getUserBadge 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIGetUserBadgeResponse
Esempio

getUserBadges 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Risposta
Restituisce: APIGetUserBadgesResponse
Esempio

updateUserBadge 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: APIEmptySuccessResponse
Esempio

getUserNotificationCount 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: GetUserNotificationCountResponse
Esempio

getUserNotifications 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Utilizzato per determinare se la pagina corrente è iscritta. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
Risposta
Restituisce: GetMyNotificationsResponse
Esempio

resetUserNotificationCount 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| sso | string | query | No |
Risposta
Restituisce: ResetUserNotificationsResponse
Esempio

resetUserNotifications 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Risposta
Restituisce: ResetUserNotificationsResponse
Esempio

updateUserNotificationCommentSubscriptionStatus 
Abilita o disabilita le notifiche per un commento specifico.
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Risposta
Restituisce: UpdateUserNotificationCommentSubscriptionStatusResponse
Esempio

updateUserNotificationPageSubscriptionStatus 
Abilita o disabilita le notifiche per una pagina. Quando gli utenti sono iscritti a una pagina, vengono create notifiche per i nuovi commenti principali, e anche
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlId | string | query | Sì | |
| url | string | query | Sì | |
| pageTitle | string | query | Sì | |
| subscribedOrUnsubscribed | string | path | Sì | |
| sso | string | query | No |
Risposta
Restituisce: UpdateUserNotificationPageSubscriptionStatusResponse
Esempio

updateUserNotificationStatus 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| notificationId | string | path | Sì | |
| newStatus | string | path | Sì | |
| sso | string | query | No |
Risposta
Restituisce: UpdateUserNotificationStatusResponse
Esempio

getUserPresenceStatuses 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlIdWS | string | query | Sì | |
| userIds | string | query | Sì |
Risposta
Restituisce: GetUserPresenceStatusesResponse
Esempio

searchUsers 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | No |
Risposta
Restituisce: SearchUsersResult
Esempio

getUser 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| id | string | path | Sì |
Risposta
Restituisce: GetUserResponse
Esempio

createVote 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| commentId | string | query | Sì | |
| direction | string | query | Sì | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Risposta
Restituisce: VoteResponse
Esempio

deleteVote 
Parametri
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| editKey | string | query | No |
Risposta
Restituisce: VoteDeleteResponse
Esempio

getVotes 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlId | string | query | Sì |
Risposta
Restituisce: GetVotesResponse
Esempio

getVotesForUser 
Parameters
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | query | Sì | |
| urlId | string | query | Sì | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
Restituisce: GetVotesForUserResponse
Example

Hai bisogno di aiuto?
Se riscontri problemi o hai domande sullo SDK Swift, per favore:
Contribuire
I contributi sono benvenuti! Visita il repository GitHub per le linee guida sui contributi.