Topic

java.lang.Object
- co.tinode.tinodesdk.Topic<DP,DR,SP,SR>

Type Parameters:

DP - is the type of Desc.Public

DR - is the type of Desc.Private

SP - is the type of Subscription.Public

SR - is the type of Subscription.Private

All Implemented Interfaces:

LocalData, java.lang.Comparable<Topic>

Direct Known Subclasses:

ComTopic, FndTopic, MeTopic
```
public class Topic<DP,DR,SP,SR>
extends java.lang.Object
implements LocalData, java.lang.Comparable<Topic>
```
Class for handling communication on a single topic Generic parameters:

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Topic.Listener<DP,DR,SP,SR>`
`static class`	`Topic.MetaGetBuilder` Helper class for generating query parameters for {sub get} and {get} packets.
`protected static class`	`Topic.NoteType`
`static class`	`Topic.TopicType`

Nested classes/interfaces inherited from interface co.tinode.tinodesdk.LocalData
LocalData.Payload

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`mAttached`
`protected boolean`	`mDeleted`
`protected Description<DP,DR>`	`mDesc`
`protected long`	`mLastKeyPress`
`protected Topic.Listener<DP,DR,SP,SR>`	`mListener`
`protected int`	`mMaxDel`
`protected java.lang.String`	`mName`
`protected boolean`	`mOnline`
`protected java.util.HashMap<java.lang.String,Subscription<SP,SR>>`	`mSubs`
`protected java.util.Date`	`mSubsUpdated`
`protected java.lang.String[]`	`mTags`
`protected Tinode`	`mTinode`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Topic(Tinode tinode, java.lang.String name, Description<DP,DR> desc)`
`protected`	`Topic(Tinode tinode, java.lang.String name, Topic.Listener<DP,DR,SP,SR> l)` Create a named topic.
`protected`	`Topic(Tinode tinode, Subscription<SP,SR> sub)`
`protected`	`Topic(Tinode tinode, Topic.Listener<DP,DR,SP,SR> l, boolean isChannel)` Start a new topic.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addSubToCache(Subscription<SP,SR> sub)` Add subscription to cache.
`protected void`	`allMessagesReceived(java.lang.Integer count)`
`protected void`	`allSubsReceived()`
`int`	`compareTo(@NotNull Topic t)`
`PromisedReply<ServerMessage>`	`delete(boolean hard)` Delete topic
`PromisedReply<ServerMessage>`	`delMessages(boolean hard)` Delete all messages.
`PromisedReply<ServerMessage>`	`delMessages(int fromId, int toId, boolean hard)` Delete message range.
`PromisedReply<ServerMessage>`	`delMessages(MsgRange[] ranges, boolean hard)` Delete messages with id in the provided list.
`PromisedReply<ServerMessage>`	`eject(java.lang.String uid, boolean ban)` Eject subscriber from topic.
`protected void`	`expunge(boolean hard)` Remove topic from DB or mark it as deleted.
`Acs`	`getAccessMode()`
`AcsHelper`	`getAnonAcs()`
`java.lang.String`	`getAnonAcsStr()`
`AcsHelper`	`getAuthAcs()`
`java.lang.String`	`getAuthAcsStr()`
`MsgRange`	`getCachedMessagesRange()`
`int`	`getClear()`
`java.util.Date`	`getCreated()`
`Defacs`	`getDefacs()`
`java.util.Date`	`getLastSeen()` Get timestamp when the topic was last online, if available.
`java.lang.String`	`getLastSeenUA()` Get user agent string associated with the time when the topic was last online.
`LocalData.Payload`	`getLocal()`
`int`	`getMaxDel()`
`PromisedReply<ServerMessage>`	`getMeta(MsgGetMeta query)` Query topic for data or metadata
`Topic.MetaGetBuilder`	`getMetaGetBuilder()`
`MsgRange`	`getMissingMessageRange()`
`java.lang.String`	`getName()`
`boolean`	`getOnline()` Get topic's online status.
`DR`	`getPriv()`
`DP`	`getPub()`
`int`	`getRead()`
`int`	`getRecv()`
`int`	`getSeq()` Get greatest known seq ID as reported by the server.
`Subscription<SP,SR>`	`getSubscription(java.lang.String key)`
`java.util.Collection<Subscription<SP,SR>>`	`getSubscriptions()`
`java.util.Date`	`getSubsUpdated()` Get timestamp of the latest update to subscriptions.
`java.lang.String[]`	`getTags()`
`Topic.TopicType`	`getTopicType()` Get type of the topic.
`static Topic.TopicType`	`getTopicTypeByName(java.lang.String name)` Get type of the topic from the given topic name.
`java.util.Date`	`getTouched()`
`TrustedType`	`getTrusted()`
`int`	`getUnreadCount()`
`java.util.Date`	`getUpdated()`
`PromisedReply<ServerMessage>`	`invite(java.lang.String uid, java.lang.String mode)` Invite user to the topic.
`boolean`	`isApprover()` Check if user has an Approver (A) permission.
`boolean`	`isArchived()` Checks if the topic is archived.
`boolean`	`isAttached()`
`boolean`	`isBlocked()` Check if current user is blocked in the topic (does not have J permission on the Given side).
`boolean`	`isDeleted()` Checks if the topic is deleted by remote.
`boolean`	`isDeleter()` Check if user has permission to hard-delete messages (D).
`boolean`	`isFndType()` Check if topic is 'fnd' type.
`boolean`	`isGrpType()` Check if topic is 'grp' type.
`static boolean`	`isGrpType(java.lang.String name)` Check if the type of the given topic name is Group.
`boolean`	`isJoiner()` Check if user has Join (J) permission on both sides: 'want' and 'given'.
`boolean`	`isManager()` Check if user has O or A permissions.
`boolean`	`isMeType()` Check if topic is 'me' type.
`boolean`	`isMuted()`
`boolean`	`isNew()` Check if topic is not yet synchronized to the server.
`static boolean`	`isNew(java.lang.String name)` Checks if given topic name is a new (unsynchronized) topic.
`boolean`	`isOwner()` Check if user is the Owner (O) of the topic.
`boolean`	`isP2PType()` Check if topic is 'p2p' type.
`static boolean`	`isP2PType(java.lang.String name)` Check if the type of the given topic name is P2P.
`protected boolean`	`isPersisted()` Check if the topic is stored.
`boolean`	`isReader()` Check if user has Read (R) permission.
`boolean`	`isSharer()` Check if user has a Sharer (S) permission.
`protected boolean`	`isTrusted(java.lang.String key)`
`boolean`	`isTrustedDanger()`
`boolean`	`isTrustedStaff()`
`boolean`	`isTrustedVerified()`
`boolean`	`isUserType()` Check if topic is a communication topic, i.e.
`boolean`	`isValid()`
`boolean`	`isWriter()` Check if user has Write (W) permission.
`PromisedReply<ServerMessage>`	`leave()` Leave topic without unsubscribing
`PromisedReply<ServerMessage>`	`leave(boolean unsub)` Leave topic
`protected int`	`loadSubs()`
`int`	`msgReadCount(int seq)` Tells how many topic subscribers have reported the message as read.
`int`	`msgRecvCount(int seq)` Tells how many topic subscribers have reported the message as received.
`void`	`noteKeyPress()` Send a key press notification to server.
`int`	`noteRead()` Notify the server that the client read the last message.
`int`	`noteRead(boolean fromMe, int seq)`
`int`	`noteRead(int seq)`
`protected int`	`noteReadRecv(Topic.NoteType what, boolean fromMe, int seq)` Let server know the seq id of the most recent received/read message.
`int`	`noteRecv()` Notify the server that the messages is stored on the client
`protected int`	`noteRecv(boolean fromMe)`
`protected void`	`persist()` Store topic to DB.
`protected void`	`processSub(Subscription<SP,SR> newsub)`
`PromisedReply<ServerMessage>`	`publish(Drafty content)` Publish message to a topic.
`PromisedReply<ServerMessage>`	`publish(Drafty content, java.util.Map<java.lang.String,java.lang.Object> extraHeaders)` Publish message to a topic.
`protected PromisedReply<ServerMessage>`	`publish(Drafty content, java.util.Map<java.lang.String,java.lang.Object> head, long msgId)`
`PromisedReply<ServerMessage>`	`publish(java.lang.String content)` Convenience method for plain text messages.
`protected void`	`removeSubFromCache(Subscription<SP,SR> sub)` Remove subscription to cache.
`protected void`	`routeData(MsgServerData data)`
`protected void`	`routeInfo(MsgServerInfo info)`
`protected void`	`routeMeta(MsgServerMeta<DP,DR,SP,SR> meta)`
`protected void`	`routeMetaDel(int clear, MsgRange[] delseq)`
`protected void`	`routeMetaDesc(MsgServerMeta<DP,DR,SP,SR> meta)`
`protected void`	`routeMetaSub(MsgServerMeta<DP,DR,SP,SR> meta)`
`protected void`	`routeMetaTags(java.lang.String[] tags)`
`protected void`	`routePres(MsgServerPres pres)`
`void`	`setAccessMode(Acs mode)`
`void`	`setClear(int clear)`
`void`	`setCreated(java.util.Date created)`
`void`	`setDefacs(Defacs da)`
`void`	`setDefacs(java.lang.String auth, java.lang.String anon)`
`void`	`setDeleted(boolean status)` Mark topic as deleted.
`PromisedReply<ServerMessage>`	`setDescription(DP pub, DR priv, java.lang.String[] attachments)` Update topic description.
`protected PromisedReply<ServerMessage>`	`setDescription(MetaSetDesc<DP,DR> desc)` Update topic description.
`protected void`	`setLastSeen(java.util.Date when)` Update timestamp of when the topic was last online.
`void`	`setLastSeen(java.util.Date when, java.lang.String ua)` Update timestamp and user agent of when the topic was last online.
`void`	`setListener(Topic.Listener<DP,DR,SP,SR> l)`
`void`	`setLocal(LocalData.Payload value)`
`void`	`setMaxDel(int max_del)`
`PromisedReply<ServerMessage>`	`setMeta(MsgSetMeta<DP,DR> meta)` Update topic metadata
`protected void`	`setName(java.lang.String name)`
`protected void`	`setOnline(boolean online)`
`void`	`setPriv(DR priv)`
`void`	`setPub(DP pub)`
`void`	`setRead(int read)`
`protected void`	`setReadRecvByRemote(java.lang.String userId, java.lang.String what, int seq)`
`void`	`setRecv(int recv)`
`void`	`setSeq(int seq)` Update greatest known seq ID.
`protected void`	`setSeqAndFetch(int seq)` Set new seq value and if it's greater than the current value make a network call to fetch new messages.
`protected void`	`setStorage(Storage store)` Assign pointer to cache.
`protected PromisedReply<ServerMessage>`	`setSubscription(MetaSetSub sub)` Update subscription.
`void`	`setTags(java.lang.String[] tags)`
`void`	`setTouched(java.util.Date touched)`
`void`	`setTrusted(TrustedType trusted)`
`void`	`setTypes(java.lang.Class<?> typeOfDescPublic, java.lang.Class<?> typeOfDescPrivate, java.lang.Class<?> typeOfSubPublic, java.lang.Class<?> typeOfSubPrivate)` Set types of payload: {data} as well as public and private content.
`void`	`setTypes(com.fasterxml.jackson.databind.JavaType typeOfDescPublic, com.fasterxml.jackson.databind.JavaType typeOfDescPrivate, com.fasterxml.jackson.databind.JavaType typeOfSubPublic, com.fasterxml.jackson.databind.JavaType typeOfSubPrivate)` Set custom types of payload: {data} as well as public and private content.
`void`	`setTypes(java.lang.String typeOfDescPublic, java.lang.String typeOfDescPrivate, java.lang.String typeOfSubPublic, java.lang.String typeOfSubPrivate)` Set types of payload: {data} content as well as public and private fields of topic.
`void`	`setUpdated(java.util.Date updated)`
`protected PromisedReply<ServerMessage>`	`subscribe()` Subscribe to topic.
`PromisedReply<ServerMessage>`	`subscribe(MsgSetMeta<DP,DR> set, MsgGetMeta get)` Subscribe to topic with parameters, optionally in background.
`<ML extends java.util.Iterator<Storage.Message> & java.io.Closeable> PromisedReply<ServerMessage>`	`syncAll()` Re-send pending messages, delete messages marked for deletion.
`PromisedReply<ServerMessage>`	`syncOne(long msgDatabaseId)` Try to sync one message.
`protected void`	`topicLeft(boolean unsub, int code, java.lang.String reason)` Called when the topic receives leave() confirmation.
`protected void`	`update(Description<DP,DR> desc)` Update topic parameters from a Description object.
`protected void`	`update(java.util.Map<java.lang.String,java.lang.Object> params, MetaSetSub sSub)` Topic sent an update to subscription, got a confirmation.
`protected void`	`update(MetaSetDesc<DP,DR> desc)` Topic sent an update to topic parameters, got a confirmation, now copy these parameters to topic description.
`protected void`	`update(MsgServerCtrl ctrl, MsgSetMeta<DP,DR> meta)` Topic sent an update to description or subscription, got a confirmation, now update local data with the new info.
`protected void`	`update(java.lang.String[] tags)` Update topic parameters from a tags array.
`protected boolean`	`update(Subscription<SP,SR> sub)` Update topic parameters from a Subscription object.
`boolean`	`updateAccessMode(AccessChange ac)`
`PromisedReply<ServerMessage>`	`updateAdmin(boolean admin)`
`PromisedReply<ServerMessage>`	`updateDefAcs(java.lang.String auth, java.lang.String anon)` Update topic's default access
`PromisedReply<ServerMessage>`	`updateMode(java.lang.String update)` Update own access mode.
`PromisedReply<ServerMessage>`	`updateMode(java.lang.String uid, java.lang.String update)` Update another user's access mode.
`PromisedReply<ServerMessage>`	`updateMuted(boolean muted)`
`PromisedReply<ServerMessage>`	`updateSharer(boolean sharer)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mTinode
```
protected Tinode mTinode
```
  - mName
```
protected java.lang.String mName
```
  - mDesc
```
protected Description<DP,DR> mDesc
```
  - mSubs
```
protected java.util.HashMap<java.lang.String,Subscription<SP,SR>> mSubs
```
  - mSubsUpdated
```
protected java.util.Date mSubsUpdated
```
  - mTags
```
protected java.lang.String[] mTags
```
  - mAttached
```
protected boolean mAttached
```
  - mListener
```
protected Topic.Listener<DP,DR,SP,SR> mListener
```
  - mLastKeyPress
```
protected long mLastKeyPress
```
  - mOnline
```
protected boolean mOnline
```
  - mMaxDel
```
protected int mMaxDel
```
  - mDeleted
```
protected boolean mDeleted
```
- Constructor Detail
  - Topic
```
protected Topic(Tinode tinode,
                Subscription<SP,SR> sub)
```
  - Topic
```
protected Topic(Tinode tinode,
                java.lang.String name,
                Description<DP,DR> desc)
```
  - Topic
```
protected Topic(Tinode tinode,
                java.lang.String name,
                Topic.Listener<DP,DR,SP,SR> l)
```
    Create a named topic.
    
    Parameters:
    
    tinode - instance of Tinode object to communicate with the server
    
    name - name of the topic
    
    l - event listener, optional
    
    Throws:
    
    java.lang.IllegalArgumentException - if 'tinode' argument is null
  - Topic
```
protected Topic(Tinode tinode,
                Topic.Listener<DP,DR,SP,SR> l,
                boolean isChannel)
```
    Start a new topic.
    Construct typeOfT} with one of com.fasterxml.jackson.databind.type.TypeFactory.constructXYZ() methods such as mMyConnectionInstance.getTypeFactory().constructType(MyPayloadClass.class).
    The actual topic name will be set after completion of a successful subscribe call
    
    Parameters:
    
    tinode - tinode instance
    
    l - event listener, optional
- Method Detail
  - getTopicTypeByName
```
public static Topic.TopicType getTopicTypeByName(java.lang.String name)
```
    Get type of the topic from the given topic name.
    
    Parameters:
    
    name - name to get type from.
    
    Returns:
    
    type of the topic name.
  - isP2PType
```
public static boolean isP2PType(java.lang.String name)
```
    Check if the type of the given topic name is P2P.
    
    Parameters:
    
    name - name of the topic to check.
    
    Returns:
    
    true if the given name is P2P, false otherwise.
  - isGrpType
```
public static boolean isGrpType(java.lang.String name)
```
    Check if the type of the given topic name is Group.
    
    Parameters:
    
    name - name of the topic to check.
    
    Returns:
    
    true if the given name is Group, false otherwise.
  - isNew
```
public static boolean isNew(java.lang.String name)
```
    Checks if given topic name is a new (unsynchronized) topic.
    
    Parameters:
    
    name - name to check
    
    Returns:
    
    true if the name is a name of a new topic, false otherwise.
  - setTypes
```
public void setTypes(com.fasterxml.jackson.databind.JavaType typeOfDescPublic,
                     com.fasterxml.jackson.databind.JavaType typeOfDescPrivate,
                     com.fasterxml.jackson.databind.JavaType typeOfSubPublic,
                     com.fasterxml.jackson.databind.JavaType typeOfSubPrivate)
```
    Set custom types of payload: {data} as well as public and private content. Needed for deserialization of server messages.
    
    Parameters:
    
    typeOfDescPublic - type of {meta.desc.public}
    
    typeOfDescPrivate - type of {meta.desc.private}
    
    typeOfSubPublic - type of {meta.subs[].public}
    
    typeOfSubPrivate - type of {meta.subs[].private}
  - setTypes
```
public void setTypes(java.lang.Class<?> typeOfDescPublic,
                     java.lang.Class<?> typeOfDescPrivate,
                     java.lang.Class<?> typeOfSubPublic,
                     java.lang.Class<?> typeOfSubPrivate)
```
    Set types of payload: {data} as well as public and private content. Needed for deserialization of server messages.
    
    Parameters:
    
    typeOfDescPublic - type of {meta.desc.public}
    
    typeOfDescPrivate - type of {meta.desc.private}
    
    typeOfSubPublic - type of {meta.sub[].public}
    
    typeOfSubPrivate - type of {meta.sub[].private}
  - setTypes
```
public void setTypes(java.lang.String typeOfDescPublic,
                     java.lang.String typeOfDescPrivate,
                     java.lang.String typeOfSubPublic,
                     java.lang.String typeOfSubPrivate)
              throws java.lang.IllegalArgumentException
```
    Set types of payload: {data} content as well as public and private fields of topic. Type names must be generated by ResolvedType.toCanonical()
    
    Parameters:
    
    typeOfDescPublic - type of {meta.desc.public}
    
    typeOfDescPrivate - type of {meta.desc.private}
    
    typeOfSubPublic - type of {meta.desc.public}
    
    typeOfSubPrivate - type of {meta.desc.private}
    
    Throws:
    
    java.lang.IllegalArgumentException - if types cannot be parsed
  - update
```
protected boolean update(Subscription<SP,SR> sub)
```
    Update topic parameters from a Subscription object. Called by MeTopic.
    
    Parameters:
    
    sub - updated topic parameters
  - update
```
protected void update(Description<DP,DR> desc)
```
    Update topic parameters from a Description object.
    
    Parameters:
    
    desc - updated topic parameters
  - update
```
protected void update(java.util.Map<java.lang.String,java.lang.Object> params,
                      MetaSetSub sSub)
```
    Topic sent an update to subscription, got a confirmation.
    
    Parameters:
    
    params - {ctrl} parameters returned by the server (could be null).
    
    sSub - updated topic parameters.
  - update
```
protected void update(MetaSetDesc<DP,DR> desc)
```
    Topic sent an update to topic parameters, got a confirmation, now copy these parameters to topic description.
    
    Parameters:
    
    desc - updated topic parameters
  - update
```
protected void update(MsgServerCtrl ctrl,
                      MsgSetMeta<DP,DR> meta)
```
    Topic sent an update to description or subscription, got a confirmation, now update local data with the new info.
    
    Parameters:
    
    ctrl - {ctrl} packet sent by the server
    
    meta - original {meta} packet updated topic parameters
  - update
```
protected void update(java.lang.String[] tags)
```
    Update topic parameters from a tags array.
    
    Parameters:
    
    tags - updated topic tags
  - setStorage
```
protected void setStorage(Storage store)
```
    Assign pointer to cache. Called by Tinode from Tinode.startTrackingTopic(Topic)
    
    Parameters:
    
    store - storage object
  - getCreated
```
public java.util.Date getCreated()
```
  - setCreated
```
public void setCreated(java.util.Date created)
```
  - getUpdated
```
public java.util.Date getUpdated()
```
  - setUpdated
```
public void setUpdated(java.util.Date updated)
```
  - getTouched
```
public java.util.Date getTouched()
```
  - setTouched
```
public void setTouched(java.util.Date touched)
```
  - compareTo
```
public int compareTo(@NotNull
                     @NotNull Topic t)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Topic>
  - getSubsUpdated
```
public java.util.Date getSubsUpdated()
```
    Get timestamp of the latest update to subscriptions.
    
    Returns:
    
    timestamp of the latest update to subscriptions
  - getSeq
```
public int getSeq()
```
    Get greatest known seq ID as reported by the server.
    
    Returns:
    
    greatest known seq ID.
  - setSeq
```
public void setSeq(int seq)
```
    Update greatest known seq ID.
    
    Parameters:
    
    seq - new seq ID.
  - setSeqAndFetch
```
protected void setSeqAndFetch(int seq)
```
    Set new seq value and if it's greater than the current value make a network call to fetch new messages.
    
    Parameters:
    
    seq - sequential ID to assign.
  - getClear
```
public int getClear()
```
  - setClear
```
public void setClear(int clear)
```
  - getMaxDel
```
public int getMaxDel()
```
  - setMaxDel
```
public void setMaxDel(int max_del)
```
  - getRead
```
public int getRead()
```
  - setRead
```
public void setRead(int read)
```
  - getRecv
```
public int getRecv()
```
  - setRecv
```
public void setRecv(int recv)
```
  - getTags
```
public java.lang.String[] getTags()
```
  - setTags
```
public void setTags(java.lang.String[] tags)
```
  - getPub
```
public DP getPub()
```
  - setPub
```
public void setPub(DP pub)
```
  - getTrusted
```
public TrustedType getTrusted()
```
  - setTrusted
```
public void setTrusted(TrustedType trusted)
```
  - getPriv
```
public DR getPriv()
```
  - setPriv
```
public void setPriv(DR priv)
```
  - isArchived
```
public boolean isArchived()
```
    Checks if the topic is archived. Not all topics support archiving.
    
    Returns:
    
    true if the topic is archived, false otherwise.
  - isDeleted
```
public boolean isDeleted()
```
    Checks if the topic is deleted by remote.
    
    Returns:
    
    true if the topic is deleted by remote, false otherwise.
  - setDeleted
```
public void setDeleted(boolean status)
```
    Mark topic as deleted.
    
    Parameters:
    
    status - true to mark topic as deleted, false to restore.
  - getCachedMessagesRange
```
public MsgRange getCachedMessagesRange()
```
  - getMissingMessageRange
```
public MsgRange getMissingMessageRange()
```
  - getAccessMode
```
public Acs getAccessMode()
```
  - setAccessMode
```
public void setAccessMode(Acs mode)
```
  - updateAccessMode
```
public boolean updateAccessMode(AccessChange ac)
```
  - isApprover
```
public boolean isApprover()
```
    Check if user has an Approver (A) permission.
    
    Returns:
    
    true if the user has the permission.
  - updateAdmin
```
public PromisedReply<ServerMessage> updateAdmin(boolean admin)
```
  - isManager
```
public boolean isManager()
```
    Check if user has O or A permissions.
    
    Returns:
    
    true if current user is the owner (O) or approver (A).
  - isSharer
```
public boolean isSharer()
```
    Check if user has a Sharer (S) permission.
    
    Returns:
    
    true if user has the permission.
  - updateSharer
```
public PromisedReply<ServerMessage> updateSharer(boolean sharer)
```
  - isMuted
```
public boolean isMuted()
```
  - updateMuted
```
public PromisedReply<ServerMessage> updateMuted(boolean muted)
```
  - isOwner
```
public boolean isOwner()
```
    Check if user is the Owner (O) of the topic.
  - isReader
```
public boolean isReader()
```
    Check if user has Read (R) permission.
  - isWriter
```
public boolean isWriter()
```
    Check if user has Write (W) permission.
  - isJoiner
```
public boolean isJoiner()
```
    Check if user has Join (J) permission on both sides: 'want' and 'given'.
  - isBlocked
```
public boolean isBlocked()
```
    Check if current user is blocked in the topic (does not have J permission on the Given side).
  - isDeleter
```
public boolean isDeleter()
```
    Check if user has permission to hard-delete messages (D).
  - getDefacs
```
public Defacs getDefacs()
```
  - setDefacs
```
public void setDefacs(Defacs da)
```
  - setDefacs
```
public void setDefacs(java.lang.String auth,
                      java.lang.String anon)
```
  - getAuthAcs
```
public AcsHelper getAuthAcs()
```
  - getAuthAcsStr
```
public java.lang.String getAuthAcsStr()
```
  - getAnonAcs
```
public AcsHelper getAnonAcs()
```
  - getAnonAcsStr
```
public java.lang.String getAnonAcsStr()
```
  - getUnreadCount
```
public int getUnreadCount()
```
  - getOnline
```
public boolean getOnline()
```
    Get topic's online status.
    
    Returns:
    
    true if topic is online, false otherwise.
  - setOnline
```
protected void setOnline(boolean online)
```
  - isPersisted
```
protected boolean isPersisted()
```
    Check if the topic is stored.
    
    Returns:
    
    true if the topic is persisted in local storage, false otherwise
  - persist
```
protected void persist()
```
    Store topic to DB.
  - expunge
```
protected void expunge(boolean hard)
```
    Remove topic from DB or mark it as deleted.
  - isTrusted
```
protected boolean isTrusted(java.lang.String key)
```
  - isTrustedVerified
```
public boolean isTrustedVerified()
```
  - isTrustedStaff
```
public boolean isTrustedStaff()
```
  - isTrustedDanger
```
public boolean isTrustedDanger()
```
  - setLastSeen
```
public void setLastSeen(java.util.Date when,
                        java.lang.String ua)
```
    Update timestamp and user agent of when the topic was last online.
  - setLastSeen
```
protected void setLastSeen(java.util.Date when)
```
    Update timestamp of when the topic was last online.
  - getLastSeen
```
public java.util.Date getLastSeen()
```
    Get timestamp when the topic was last online, if available.
  - getLastSeenUA
```
public java.lang.String getLastSeenUA()
```
    Get user agent string associated with the time when the topic was last online.
  - subscribe
```
protected PromisedReply<ServerMessage> subscribe()
```
    Subscribe to topic.
  - subscribe
```
public PromisedReply<ServerMessage> subscribe(MsgSetMeta<DP,DR> set,
                                              MsgGetMeta get)
```
    Subscribe to topic with parameters, optionally in background.
    
    Throws:
    
    NotConnectedException - if there is no live connection to the server
    
    AlreadySubscribedException - if the client is already subscribed to the given topic
  - getMetaGetBuilder
```
public Topic.MetaGetBuilder getMetaGetBuilder()
```
  - leave
```
public PromisedReply<ServerMessage> leave(boolean unsub)
```
    Leave topic
    
    Parameters:
    
    unsub - true to disconnect and unsubscribe from topic, otherwise just disconnect
  - leave
```
public PromisedReply<ServerMessage> leave()
```
    Leave topic without unsubscribing
  - publish
```
protected PromisedReply<ServerMessage> publish(Drafty content,
                                               java.util.Map<java.lang.String,java.lang.Object> head,
                                               long msgId)
```
  - publish
```
public PromisedReply<ServerMessage> publish(Drafty content)
```
    Publish message to a topic. It will attempt to publish regardless of subscription status.
    
    Parameters:
    
    content - payload
  - publish
```
public PromisedReply<ServerMessage> publish(Drafty content,
                                            java.util.Map<java.lang.String,java.lang.Object> extraHeaders)
```
    Publish message to a topic. It will attempt to publish regardless of subscription status.
    
    Parameters:
    
    content - payload
    
    extraHeaders - additional message headers.
  - publish
```
public PromisedReply<ServerMessage> publish(java.lang.String content)
```
    Convenience method for plain text messages. Will convert message to Drafty.
    
    Parameters:
    
    content - message to send
    
    Returns:
    
    PromisedReply
  - syncAll
```
public <ML extends java.util.Iterator<Storage.Message> & java.io.Closeable> PromisedReply<ServerMessage> syncAll()
```
    Re-send pending messages, delete messages marked for deletion. Processing will stop on the first error.
    
    Returns:
    
    PromisedReply of the last sent command.
    
    Throws:
    
    NotSubscribedException - if the client is not subscribed to the topic
    
    NotConnectedException - if there is no connection to server
  - syncOne
```
public PromisedReply<ServerMessage> syncOne(long msgDatabaseId)
```
    Try to sync one message.
    
    Returns:
    
    PromisedReply resolved on result of the operation.
    
    Throws:
    
    NotSubscribedException - if the client is not subscribed to the topic
    
    NotConnectedException - if there is no connection to server
  - getMeta
```
public PromisedReply<ServerMessage> getMeta(MsgGetMeta query)
```
    Query topic for data or metadata
  - setMeta
```
public PromisedReply<ServerMessage> setMeta(MsgSetMeta<DP,DR> meta)
```
    Update topic metadata
    
    Throws:
    
    NotSubscribedException - if the client is not subscribed to the topic
    
    NotConnectedException - if there is no connection to the server
  - setDescription
```
protected PromisedReply<ServerMessage> setDescription(MetaSetDesc<DP,DR> desc)
```
    Update topic description. Calls setMeta(co.tinode.tinodesdk.model.MsgSetMeta<DP, DR>).
    
    Parameters:
    
    desc - new description (public, private, default access)
    
    Throws:
    
    NotSubscribedException - if the client is not subscribed to the topic
    
    NotConnectedException - if there is no connection to the server
  - setDescription
```
public PromisedReply<ServerMessage> setDescription(DP pub,
                                                   DR priv,
                                                   java.lang.String[] attachments)
```
    Update topic description. Calls setMeta(co.tinode.tinodesdk.model.MsgSetMeta<DP, DR>).
    
    Parameters:
    
    pub - new public info
    
    priv - new private info
    
    attachments - URLs of out-of-band attachments contained in the values of pub (or priv).
    
    Throws:
    
    NotSubscribedException - if the client is not subscribed to the topic
    
    NotConnectedException - if there is no connection to the server
  - updateDefAcs
```
public PromisedReply<ServerMessage> updateDefAcs(java.lang.String auth,
                                                 java.lang.String anon)
```
    Update topic's default access
    
    Parameters:
    
    auth - default access mode for authenticated users
    
    anon - default access mode for anonymous users
    
    Throws:
    
    NotSubscribedException - if the client is not subscribed to the topic
    
    NotConnectedException - if there is no connection to the server
  - setSubscription
```
protected PromisedReply<ServerMessage> setSubscription(MetaSetSub sub)
```
    Update subscription. Calls setMeta(co.tinode.tinodesdk.model.MsgSetMeta<DP, DR>).
    
    Throws:
    
    NotSubscribedException - if the client is not subscribed to the topic
    
    NotConnectedException - if there is no connection to the server
  - updateMode
```
public PromisedReply<ServerMessage> updateMode(java.lang.String update)
```
    Update own access mode.
    
    Parameters:
    
    update - string which defines the update. It could be a full value or a change.
  - updateMode
```
public PromisedReply<ServerMessage> updateMode(java.lang.String uid,
                                               java.lang.String update)
```
    Update another user's access mode.
    
    Parameters:
    
    uid - UID of the user to update.
    
    update - string which defines the update. It could be a full value or a change.
  - invite
```
public PromisedReply<ServerMessage> invite(java.lang.String uid,
                                           java.lang.String mode)
```
    Invite user to the topic.
    
    Parameters:
    
    uid - ID of the user to invite to topic
    
    mode - access mode granted to user
  - eject
```
public PromisedReply<ServerMessage> eject(java.lang.String uid,
                                          boolean ban)
```
    Eject subscriber from topic.
    
    Parameters:
    
    uid - id of the user to unsubscribe from the topic
    
    ban - ban user (set mode.Given = 'N')
  - delMessages
```
public PromisedReply<ServerMessage> delMessages(int fromId,
                                                int toId,
                                                boolean hard)
```
    Delete message range.
    
    Parameters:
    
    hard - hard-delete messages
  - delMessages
```
public PromisedReply<ServerMessage> delMessages(MsgRange[] ranges,
                                                boolean hard)
```
    Delete messages with id in the provided list.
    
    Parameters:
    
    ranges - delete messages with ids in these ranges.
    
    hard - hard-delete messages
  - delMessages
```
public PromisedReply<ServerMessage> delMessages(boolean hard)
```
    Delete all messages.
    
    Parameters:
    
    hard - hard-delete messages
  - delete
```
public PromisedReply<ServerMessage> delete(boolean hard)
```
    Delete topic
    
    Parameters:
    
    hard - hard-delete topic.
  - noteReadRecv
```
protected int noteReadRecv(Topic.NoteType what,
                           boolean fromMe,
                           int seq)
```
    Let server know the seq id of the most recent received/read message.
    
    Parameters:
    
    what - "read" or "recv" to indicate which action to report
    
    fromMe - indicates if the message is from the current user; update cache but do not send a message.
    
    seq - explicit ID to acknowledge; ignored if <= 0.
    
    Returns:
    
    ID of the acknowledged message or 0.
  - noteRead
```
public int noteRead()
```
    Notify the server that the client read the last message.
  - noteRead
```
public int noteRead(int seq)
```
  - noteRead
```
public int noteRead(boolean fromMe,
                    int seq)
```
  - noteRecv
```
public int noteRecv()
```
    Notify the server that the messages is stored on the client
  - noteRecv
```
protected int noteRecv(boolean fromMe)
```
  - noteKeyPress
```
public void noteKeyPress()
```
    Send a key press notification to server. Ensure we do not sent too many.
  - getName
```
public java.lang.String getName()
```
  - setName
```
protected void setName(java.lang.String name)
```
  - loadSubs
```
protected int loadSubs()
```
  - addSubToCache
```
protected void addSubToCache(Subscription<SP,SR> sub)
```
    Add subscription to cache. Needs to be overriden in MeTopic because it keeps subs indexed by topic.
    
    Parameters:
    
    sub - subscription to add to cache
  - removeSubFromCache
```
protected void removeSubFromCache(Subscription<SP,SR> sub)
```
    Remove subscription to cache. Needs to be overriden in MeTopic because it keeps subs indexed by topic.
    
    Parameters:
    
    sub - subscription to remove from cache
  - getSubscription
```
public Subscription<SP,SR> getSubscription(java.lang.String key)
```
  - getSubscriptions
```
public java.util.Collection<Subscription<SP,SR>> getSubscriptions()
```
  - isAttached
```
public boolean isAttached()
```
  - isValid
```
public boolean isValid()
```
  - msgRecvCount
```
public int msgRecvCount(int seq)
```
    Tells how many topic subscribers have reported the message as received.
    
    Parameters:
    
    seq - sequence id of the message to test
    
    Returns:
    
    count of recepients who claim to have received the message
  - msgReadCount
```
public int msgReadCount(int seq)
```
    Tells how many topic subscribers have reported the message as read.
    
    Parameters:
    
    seq - sequence id of the message to test.
    
    Returns:
    
    count of recipients who claim to have read the message.
  - getTopicType
```
public Topic.TopicType getTopicType()
```
    Get type of the topic.
    
    Returns:
    
    topic type.
  - isMeType
```
public boolean isMeType()
```
    Check if topic is 'me' type.
    
    Returns:
    
    true if topic is 'me' type, false otherwise.
  - isP2PType
```
public boolean isP2PType()
```
    Check if topic is 'p2p' type.
    
    Returns:
    
    true if topic is 'p2p' type, false otherwise.
  - isUserType
```
public boolean isUserType()
```
    Check if topic is a communication topic, i.e. a 'p2p' or 'grp' type.
    
    Returns:
    
    true if topic is 'p2p' or 'grp', false otherwise.
  - isFndType
```
public boolean isFndType()
```
    Check if topic is 'fnd' type.
    
    Returns:
    
    true if topic is 'fnd' type, false otherwise.
  - isGrpType
```
public boolean isGrpType()
```
    Check if topic is 'grp' type.
    
    Returns:
    
    true if topic is 'grp' type, false otherwise.
  - isNew
```
public boolean isNew()
```
    Check if topic is not yet synchronized to the server.
    
    Returns:
    
    true is topic is new (i.e. no name is yet assigned by the server)
  - topicLeft
```
protected void topicLeft(boolean unsub,
                         int code,
                         java.lang.String reason)
```
    Called when the topic receives leave() confirmation. Overriden in 'me'.
    
    Parameters:
    
    unsub - - not just detached but also unsubscribed
    
    code - result code, always 200
    
    reason - usually "OK"
  - routeMeta
```
protected void routeMeta(MsgServerMeta<DP,DR,SP,SR> meta)
```
  - routeMetaDesc
```
protected void routeMetaDesc(MsgServerMeta<DP,DR,SP,SR> meta)
```
  - processSub
```
protected void processSub(Subscription<SP,SR> newsub)
```
  - routeMetaSub
```
protected void routeMetaSub(MsgServerMeta<DP,DR,SP,SR> meta)
```
  - routeMetaDel
```
protected void routeMetaDel(int clear,
                            MsgRange[] delseq)
```
  - routeMetaTags
```
protected void routeMetaTags(java.lang.String[] tags)
```
  - routeData
```
protected void routeData(MsgServerData data)
```
  - allMessagesReceived
```
protected void allMessagesReceived(java.lang.Integer count)
```
  - allSubsReceived
```
protected void allSubsReceived()
```
  - routePres
```
protected void routePres(MsgServerPres pres)
```
  - setReadRecvByRemote
```
protected void setReadRecvByRemote(java.lang.String userId,
                                   java.lang.String what,
                                   int seq)
```
  - routeInfo
```
protected void routeInfo(MsgServerInfo info)
```
  - getLocal
```
public LocalData.Payload getLocal()
```
    Specified by:
    
    getLocal in interface LocalData
  - setLocal
```
public void setLocal(LocalData.Payload value)
```
    Specified by:
    
    setLocal in interface LocalData
  - setListener
```
public void setListener(Topic.Listener<DP,DR,SP,SR> l)
```

Class Topic<DP,DR,SP,SR>

Nested Class Summary

Nested classes/interfaces inherited from interface co.tinode.tinodesdk.LocalData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mTinode

mName

mDesc

mSubs

mSubsUpdated

mTags

mAttached

mListener

mLastKeyPress

mOnline

mMaxDel

mDeleted

Constructor Detail

Topic

Topic

Topic

Topic

Method Detail

getTopicTypeByName

isP2PType

isGrpType

isNew

setTypes

setTypes

setTypes

update

update

update

update

update

update

setStorage

getCreated

setCreated

getUpdated

setUpdated

getTouched

setTouched

compareTo

getSubsUpdated

getSeq

setSeq

setSeqAndFetch

getClear

setClear

getMaxDel

setMaxDel

getRead

setRead

getRecv

setRecv

getTags

setTags

getPub

setPub

getTrusted

setTrusted

getPriv

setPriv

isArchived

isDeleted

setDeleted

getCachedMessagesRange

getMissingMessageRange

getAccessMode

setAccessMode

updateAccessMode

isApprover

updateAdmin

isManager

isSharer

updateSharer