Package io.ably.lib.types

Class SummaryClientIdList

java.lang.Object
io.ably.lib.types.SummaryClientIdList
public class SummaryClientIdList extends Object
The summary entry for aggregated annotations that use the flag.v1 aggregation method; also the per-name value for some other aggregation methods.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final List<String>
    clientIds
    A list of the clientIds of all clients who have published an annotation with this name (or type, depending on context).
    final boolean
    clipped
    Whether the list of clientIds has been clipped due to exceeding the maximum number of clients.
    final int
    total
    The sum of the counts from all clients who have published an annotation with this name

  • Constructor Summary

    Constructors
    Constructor
    Description
    SummaryClientIdList(int total, List<String> clientIds, boolean clipped)
     

  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • total

      public final int total
      The sum of the counts from all clients who have published an annotation with this name

    • clientIds

      public final List<String> clientIds
      A list of the clientIds of all clients who have published an annotation with this name (or type, depending on context).

    • clipped

      public final boolean clipped
      Whether the list of clientIds has been clipped due to exceeding the maximum number of clients.

  • Constructor Details

    • SummaryClientIdList

      public SummaryClientIdList(int total, List<String> clientIds, boolean clipped)