co.tinode.tinodesdk

Class ComTopic<DP extends TheCard>

java.lang.Object

co.tinode.tinodesdk.Topic<DP,PrivateType,DP,PrivateType>

co.tinode.tinodesdk.ComTopic<DP>

All Implemented Interfaces:

LocalData, java.lang.Comparable<Topic>

public class ComTopic<DP extends TheCard>
extends Topic<DP,PrivateType,DP,PrivateType>

Communication topic: a P2P or Group.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComTopic.ComListener<DP>

Nested classes/interfaces inherited from class co.tinode.tinodesdk.Topic

Topic.Listener<DP,DR,SP,SR>, Topic.MetaGetBuilder, Topic.NoteType, Topic.TopicType

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

LocalData.Payload

Field Summary

Fields inherited from class co.tinode.tinodesdk.Topic

mAttached, mDeleted, mDesc, mLastKeyPress, mListener, mMaxDel, mName, mOnline, mSubs, mSubsUpdated, mTags, mTinode

Constructor Summary

Constructors

Constructor and Description
ComTopic(Tinode tinode, java.lang.String name, Description<DP,PrivateType> desc)
ComTopic(Tinode tinode, java.lang.String name, Topic.Listener<DP,PrivateType,DP,PrivateType> l)
ComTopic(Tinode tinode, Subscription<DP,PrivateType> sub)
ComTopic(Tinode tinode, Topic.Listener l, boolean isChannel)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComment() Read comment from the Private field.
Subscription<DP,PrivateType>	getPeer() In P2P topics get peer's subscription.
boolean	hasChannelAccess() Checks if the topic can be accessed as channel.
boolean	isArchived() Checks if the topic is archived.
boolean	isChannel() Checks if the topic is archived.
static boolean	isChannel(java.lang.String name) Checks if given topic name is a name of a channel.
void	setComment(java.lang.String comment)
void	setHasChannelAccess(boolean access) Sets flag that the topic is accessible as a channel.
PromisedReply<ServerMessage>	subscribe() Subscribe to topic.
PromisedReply<ServerMessage>	updateArchived(boolean arch) Archive topic by issuing Topic.setMeta(co.tinode.tinodesdk.model.MsgSetMeta<DP, DR>) with priv set to {arch: true/false}.

Methods inherited from class co.tinode.tinodesdk.Topic

addSubToCache, allMessagesReceived, allSubsReceived, compareTo, delete, delMessages, delMessages, delMessages, eject, expunge, getAccessMode, getAnonAcs, getAnonAcsStr, getAuthAcs, getAuthAcsStr, getCachedMessagesRange, getClear, getCreated, getDefacs, getLastSeen, getLastSeenUA, getLocal, getMaxDel, getMeta, getMetaGetBuilder, getMissingMessageRange, getName, getOnline, getPriv, getPub, getRead, getRecv, getSeq, getSubscription, getSubscriptions, getSubsUpdated, getTags, getTopicType, getTopicTypeByName, getTouched, getTrusted, getUnreadCount, getUpdated, invite, isApprover, isAttached, isBlocked, isDeleted, isDeleter, isFndType, isGrpType, isGrpType, isJoiner, isManager, isMeType, isMuted, isNew, isNew, isOwner, isP2PType, isP2PType, isPersisted, isReader, isSharer, isTrusted, isTrustedDanger, isTrustedStaff, isTrustedVerified, isUserType, isValid, isWriter, leave, leave, loadSubs, msgReadCount, msgRecvCount, noteKeyPress, noteRead, noteRead, noteRead, noteReadRecv, noteRecv, noteRecv, persist, processSub, publish, publish, publish, publish, removeSubFromCache, routeData, routeInfo, routeMeta, routeMetaDel, routeMetaDesc, routeMetaSub, routeMetaTags, routePres, setAccessMode, setClear, setCreated, setDefacs, setDefacs, setDeleted, setDescription, setDescription, setLastSeen, setLastSeen, setListener, setLocal, setMaxDel, setMeta, setName, setOnline, setPriv, setPub, setRead, setReadRecvByRemote, setRecv, setSeq, setSeqAndFetch, setStorage, setSubscription, setTags, setTouched, setTrusted, setTypes, setTypes, setTypes, setUpdated, subscribe, syncAll, syncOne, topicLeft, update, update, update, update, update, update, updateAccessMode, updateAdmin, updateDefAcs, updateMode, updateMode, updateMuted, updateSharer

Methods inherited from class java.lang.Object

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

Constructor Detail

ComTopic

public ComTopic(Tinode tinode,
                Subscription<DP,PrivateType> sub)

ComTopic

public ComTopic(Tinode tinode,
                java.lang.String name,
                Description<DP,PrivateType> desc)

ComTopic

public ComTopic(Tinode tinode,
                java.lang.String name,
                Topic.Listener<DP,PrivateType,DP,PrivateType> l)

ComTopic

public ComTopic(Tinode tinode,
                Topic.Listener l,
                boolean isChannel)

Method Detail

subscribe

public PromisedReply<ServerMessage> subscribe()

Subscribe to topic.

Overrides:

subscribe in class Topic<DP extends TheCard,PrivateType,DP extends TheCard,PrivateType>

setComment

public void setComment(java.lang.String comment)

getComment

public java.lang.String getComment()

Read comment from the Private field.

Returns:

comment or null if comment or Private is not set.

isArchived

public boolean isArchived()

Checks if the topic is archived. Not all topics support archiving.

Overrides:

isArchived in class Topic<DP extends TheCard,PrivateType,DP extends TheCard,PrivateType>

Returns:

true if the topic is archived, false otherwise.

isChannel

public boolean isChannel()

Checks if the topic is archived. Not all topics support archiving.

Returns:

true if the topic is archived, false otherwise.

isChannel

public static boolean isChannel(java.lang.String name)

Checks if given topic name is a name of a channel.

Parameters:

name - name to check.

Returns:

true if the name is a name of a channel, false otherwise.

hasChannelAccess

public boolean hasChannelAccess()

Checks if the topic can be accessed as channel.

Returns:

true if the topic is accessible as a channel.

setHasChannelAccess

public void setHasChannelAccess(boolean access)

Sets flag that the topic is accessible as a channel.

Parameters:

access - true to indicate that the topic is accessible as a channel.

getPeer

public Subscription<DP,PrivateType> getPeer()

In P2P topics get peer's subscription.

Returns:

peer's subscription.

updateArchived

public PromisedReply<ServerMessage> updateArchived(boolean arch)

Archive topic by issuing Topic.setMeta(co.tinode.tinodesdk.model.MsgSetMeta<DP, DR>) with priv set to {arch: true/false}.

Throws:

NotSubscribedException - if the client is not subscribed to the topic

NotConnectedException - if there is no connection to the server