Skip to main content

ably_chat_openapi/models/
client_id_list.rs

1/*
2 * Ably Chat REST API
3 *
4 * REST API for [Ably Chat](https://ably.com/docs/chat).  This specification describes the HTTP surface of the Ably Chat REST API (path prefix `/chat/v4`) that the official Chat client SDKs use for request/response operations such as sending, editing, deleting and querying messages, message reactions and room occupancy.  ## Scope & provenance Ably does **not** publish an official OpenAPI document for the Chat REST API (the official `ably/open-specs` `platform-v1.yaml` covers only the generic pub/sub REST API: `/channels`, `/push`, `/keys`, `/stats`, `/time`). This document was reconstructed from the `@ably/chat` JavaScript SDK v1.4.0 REST layer (`src/core/chat-api.ts`, `src/core/rest-types.ts`) together with Ably's documented REST conventions (host, authentication, versioning, pagination, error envelope).  It therefore covers the endpoints the client SDK exercises. It is **not** an exhaustive description of every server capability, and there are intentionally no endpoints for creating or deleting rooms: Chat rooms are channel-backed and implicit — they are not provisioned via REST.  ## Realtime vs REST Many Chat features (presence, typing indicators, room reactions, subscribing to live messages and reaction summaries) are delivered over Ably's realtime/pub-sub transport, not this REST API, and are out of scope here. 
5 *
6 * The version of the OpenAPI document: 4
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// ClientIdList : Aggregated set of client IDs for a unique/distinct reaction.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct ClientIdList {
17    /// Total number of clients that applied this reaction.
18    #[serde(rename = "total")]
19    pub total: i32,
20    /// The client IDs that applied this reaction.
21    #[serde(rename = "clientIds")]
22    pub client_ids: Vec<String>,
23    /// Whether the `clientIds` list was truncated because there were too many reacting clients. 
24    #[serde(rename = "clipped", skip_serializing_if = "Option::is_none")]
25    pub clipped: Option<bool>,
26}
27
28impl ClientIdList {
29    /// Aggregated set of client IDs for a unique/distinct reaction.
30    pub fn new(total: i32, client_ids: Vec<String>) -> ClientIdList {
31        ClientIdList {
32            total,
33            client_ids,
34            clipped: None,
35        }
36    }
37}
38