Package io.ably.lib.types

Class Annotation

java.lang.Object

io.ably.lib.types.BaseMessage

io.ably.lib.types.Annotation

All Implemented Interfaces:

Cloneable

public class Annotation
extends BaseMessage

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Annotation.ActionSerializer
static class	Annotation.Serializer

Field Summary

Fields

Modifier and Type	Field	Description
AnnotationAction	action	(TAN2b) The action, whether this is an annotation being added or removed, one of the AnnotationAction enum values.
Integer	count	(TAN2e) An optional count, only relevant to certain aggregation methods, see aggregation methods documentation for more info.
MessageExtras	extras	(TAN2l) A JSON object for metadata and/or ancillary payloads.
String	messageSerial	(TAN2j) The serial of the message (of type `MESSAGE_CREATE`) that this annotation is annotating.
String	name	(TAN2d) The name of this annotation.
String	serial	(TAN2i) This annotation's unique serial (lexicographically totally ordered).
String	type	(TAN2k) The type of annotation it is, typically some identifier together with an aggregation method; for example: "emoji:distinct.v1".

Fields inherited from class io.ably.lib.types.BaseMessage

clientId, connectionId, data, encoding, id, timestamp

Constructor Summary

Constructors

Constructor	Description
Annotation()

Method Summary

Modifier and Type	Method	Description
static Annotation	fromMsgpack(org.msgpack.core.MessageUnpacker unpacker)
protected void	read(com.google.gson.JsonObject map)	Populate fields from JSON.

Methods inherited from class io.ably.lib.types.BaseMessage

countFields, decode, decode, encode, getDetails, readInt, readLong, readString, toJsonObject

Methods inherited from class java.lang.Object

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

Field Details

action

public AnnotationAction action

(TAN2b) The action, whether this is an annotation being added or removed, one of the AnnotationAction enum values.

serial

public String serial

(TAN2i) This annotation's unique serial (lexicographically totally ordered).

messageSerial

public String messageSerial

(TAN2j) The serial of the message (of type `MESSAGE_CREATE`) that this annotation is annotating.

type

public String type

(TAN2k) The type of annotation it is, typically some identifier together with an aggregation method; for example: "emoji:distinct.v1". Handled opaquely by the SDK and validated serverside. |

name

public String name

(TAN2d) The name of this annotation. This is the field that most annotation aggregations will operate on. For example, using "distinct.v1" aggregation (specified in the type), the message summary will show a list of clients who have published an annotation with each distinct annotation.name.

count

public Integer count

(TAN2e) An optional count, only relevant to certain aggregation methods, see aggregation methods documentation for more info.

extras

public MessageExtras extras

(TAN2l) A JSON object for metadata and/or ancillary payloads.

Constructor Details

Annotation

public Annotation()

Method Details

fromMsgpack

public static Annotation fromMsgpack(org.msgpack.core.MessageUnpacker unpacker)
                              throws IOException

Throws:

IOException

read

protected void read(com.google.gson.JsonObject map)
             throws MessageDecodeException

Description copied from class: BaseMessage

Populate fields from JSON.

Overrides:

read in class BaseMessage

Throws:

MessageDecodeException