co.tinode.tinodesdk

Class Tinode

java.lang.Object

co.tinode.tinodesdk.Tinode

public class Tinode
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tinode.EventListener Callback interface called by Connection when it receives events from the websocket.
static interface	Tinode.MimeTypeResolver Interface for converting mime type string to Jackson's JavaType.
static interface	Tinode.TopicFilter<T extends Topic> Interface to be implemented by those clients which want to fetch topics using getFilteredTopics(co.tinode.tinodesdk.Tinode.TopicFilter)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHANNEL_NEW
static java.lang.String	MAX_FILE_UPLOAD_SIZE
static java.lang.String	MAX_MESSAGE_SIZE
static java.lang.String	MAX_SUBSCRIBER_COUNT
static java.lang.String	MAX_TAG_COUNT
static java.lang.String	MAX_TAG_LENGTH
static java.lang.String	MIN_TAG_LENGTH
protected static java.lang.String	NOTE_KP
protected static java.lang.String	NOTE_READ
protected static java.lang.String	NOTE_RECV
static java.lang.String	NULL_VALUE
protected static java.text.SimpleDateFormat	sDateFormat
protected static com.fasterxml.jackson.databind.type.TypeFactory	sTypeFactory
static java.lang.String	TOPIC_CHN_PREFIX
static java.lang.String	TOPIC_FND
static java.lang.String	TOPIC_GRP_PREFIX
static java.lang.String	TOPIC_ME
static java.lang.String	TOPIC_NEW
static java.lang.String	TOPIC_SYS
static java.lang.String	TOPIC_USR_PREFIX
static java.lang.String	USER_NEW

Constructor Summary

Constructors

Constructor and Description
Tinode(java.lang.String appname, java.lang.String apikey) Initialize Tinode package
Tinode(java.lang.String appname, java.lang.String apikey, Storage store, Tinode.EventListener listener) Initialize Tinode package
Tinode(java.lang.String appname, java.lang.String apikey, Tinode.EventListener listener) Initialize Tinode package

Method Summary

Modifier and Type	Method and Description
protected <Pu,Pr> PromisedReply<ServerMessage>	account(java.lang.String uid, java.lang.String scheme, java.lang.String secret, boolean loginNow, java.lang.String[] tags, MetaSetDesc<Pu,Pr> desc, Credential[] cred) Create new account.
void	addListener(Tinode.EventListener listener) Add listener which will receive event notifications.
PromisedReply<ServerMessage>	connect(@Nullable java.lang.String hostName, boolean tls, boolean background) Open a websocket connection to the server, process handshake exchange then optionally login.
protected PromisedReply<ServerMessage>	connect(@NotNull java.net.URI serverURI, boolean background) Open a websocket connection to the server, process handshake exchange then optionally login.
<Pu,Pr> PromisedReply<ServerMessage>	createAccountBasic(java.lang.String uname, java.lang.String password, boolean login, java.lang.String[] tags, MetaSetDesc<Pu,Pr> desc, Credential[] cred) Create account using a single basic authentication scheme.
PromisedReply<ServerMessage>	delCredential(Credential cred) Low-level request to delete a credential.
PromisedReply<ServerMessage>	delCurrentUser(boolean hard) Request to delete account of the current user.
PromisedReply<ServerMessage>	delMessage(java.lang.String topicName, int seqId, boolean hard) Low-level request to delete one message from a topic.
PromisedReply<ServerMessage>	delMessage(java.lang.String topicName, int fromId, int toId, boolean hard) Low-level request to delete all messages from the topic with ids in the given range.
PromisedReply<ServerMessage>	delMessage(java.lang.String topicName, MsgRange[] ranges, boolean hard) Low-level request to delete messages from a topic.
PromisedReply<ServerMessage>	delSubscription(java.lang.String topicName, java.lang.String user) Low-level request to delete a subscription.
PromisedReply<ServerMessage>	delTopic(java.lang.String topicName, boolean hard) Low-level request to delete topic.
void	disconnect(boolean fromBkg) Disconnect from the server.
java.lang.String	getApiKey() Get API key that was used for configuring this Tinode instance.
java.lang.String	getAuthToken() Get server-provided authentication token.
java.util.Date	getAuthTokenExpiration() Get expiration time of the authentication token, see getAuthToken()
java.net.URL	getBaseUrl() Get configured server address as an HTTP(S) URL.
LargeFileHelper	getFileUploader() Get LargeFileHelper object initialized for use with file uploading.
<T extends Topic> java.util.Collection<T>	getFilteredTopics(Tinode.TopicFilter filter) Return a list of topics which satisfy the filters.
<DP> FndTopic<DP>	getFndTopic() Obtain a 'fnd' topic (FndTopic).
java.lang.String	getHttpOrigin() Get server address suitable for use as an Origin: header for CORS compliance.
static com.fasterxml.jackson.databind.ObjectMapper	getJsonMapper()
protected static long	getKeyPressDelay() Get minimum delay between two subsequent key press notifications.
Storage.Message	getLastMessage(java.lang.String topicName) Get the latest cached message in the given topic.
PromisedReply<ServerMessage>	getMeta(java.lang.String topicName, MsgGetMeta query) Low-level request to query topic for metadata.
<DP> MeTopic<DP>	getMeTopic() Obtain a 'me' topic (MeTopic).
java.lang.String	getMyId() Get ID of the current logged in user.
<DP> FndTopic<DP>	getOrCreateFndTopic() Get 'fnd' topic from cache.
<DP> MeTopic<DP>	getOrCreateMeTopic() Get 'me' topic from cache.
java.util.Map<java.lang.String,java.lang.String>	getRequestHeaders() Get map with HTTP request parameters suitable for requests to Tinode server.
java.lang.String	getServerBuild() Get server build stamp reported at the last connection
long	getServerLimit(java.lang.String key, long defaultValue) Get server-provided limit.
java.lang.String	getServerVersion() Get the protocol version of the server that was reported at the last connection.
Topic	getTopic(java.lang.String name) Get topic by name.
java.util.Collection<Topic>	getTopics() Return a list of topics sorted by Topic.touched in descending order.
java.util.Date	getTopicsUpdated() Get the most recent timestamp of update to any topic.
static com.fasterxml.jackson.databind.type.TypeFactory	getTypeFactory()
protected com.fasterxml.jackson.databind.JavaType	getTypeOfMetaPacket(java.lang.String topicName) Obtain previously assigned type of Meta packet.
<SP> User<SP>	getUser(@NotNull java.lang.String uid) Look up user in a local cache: first in memory, then in persistent storage.
static java.util.Map<java.lang.String,java.lang.Object>	headersForReply(int seq) Headers for a reply message.
PromisedReply<ServerMessage>	hello(java.lang.Boolean background) Send a handshake packet to the server.
boolean	isAuthenticated() Check if the current session is authenticated.
boolean	isConnected() Check if connection is in a connected state.
boolean	isMe(java.lang.String uid) Check if the given user ID belong to the current logged in user.
static boolean	isNull(java.lang.Object obj)
boolean	isTrustedURL(java.net.URL url) Check if the given URL is trusted: points to Tinode server using HTTP or HTTPS protocol.
static <T> T	jsonDeserialize(java.lang.String input, java.lang.String canonicalName) Convert JSON to an object.
static <T> T[]	jsonDeserializeArray(java.lang.String input, java.lang.String canonicalName) Convert JSON to an array of objects.
static java.lang.String	jsonSerialize(java.lang.Object o) Convert object to JSON string.
PromisedReply<ServerMessage>	leave(java.lang.String topicName, boolean unsub) Low-level request to unsubscribe topic.
protected PromisedReply<ServerMessage>	login(java.lang.String combined)
protected PromisedReply<ServerMessage>	login(java.lang.String scheme, java.lang.String secret, Credential[] creds)
PromisedReply<ServerMessage>	loginBasic(java.lang.String uname, java.lang.String password) Send a basic login packet to the server.
PromisedReply<ServerMessage>	loginToken(java.lang.String token) Send a basic login packet to the server.
PromisedReply<ServerMessage>	loginToken(java.lang.String token, Credential[] creds) Send a basic login packet to the server.
void	logout() Log out current user.
protected java.lang.String	makeUserAgent() Compose User Agent string to be sent to the server.
protected Topic	maybeCreateTopic(MsgServerMeta meta) Instantiate topic from {meta} packet using meta.desc.
void	networkProbe() Probe connection to the server by sending a test packet.
Topic	newTopic(java.lang.String name, Topic.Listener l) Instantiate topic of an appropriate class given the name.
static Topic	newTopic(Tinode tinode, java.lang.String name, Topic.Listener l) Instantiate topic of an appropriate class given the name.
protected void	note(java.lang.String topicName, java.lang.String what, int seq) Inform all other topic subscribers of activity, such as receiving/reading a message or a typing notification.
void	noteKeyPress(java.lang.String topicName) Send typing notification to all other topic subscribers.
void	noteRead(java.lang.String topicName, int seq) Read receipt.
void	noteRecv(java.lang.String topicName, int seq) Received receipt.
void	oobNotification(java.util.Map<java.lang.String,java.lang.String> data, java.lang.String authToken) Out of band notification handling.
protected ServerMessage	parseServerMessageFromJson(java.lang.String jsonMessage) Parse JSON received from the server into ServerMessage
PromisedReply<ServerMessage>	publish(java.lang.String topicName, java.lang.Object data, java.util.Map<java.lang.String,java.lang.Object> head, java.lang.String[] attachments) Low-level request to publish data.
void	reconnectNow(boolean interactive, boolean reset, boolean background) Make sure connection is either already established or being established: - If connection is already established do nothing - If connection does not exist, create - If not connected and waiting for backoff timer, wake it up.
boolean	removeListener(Tinode.EventListener listener) Remove listener.
PromisedReply<ServerMessage>	requestResetSecret(java.lang.String scheme, java.lang.String method, java.lang.String value) Reset authentication secret, such as password.
protected void	send(ClientMessage message) Takes ClientMessage, converts it to string writes to websocket.
protected void	send(java.lang.String message) Writes a string to websocket.
protected PromisedReply<ServerMessage>	sendWithPromise(ClientMessage message, java.lang.String id) Takes ClientMessage, converts it to string writes to websocket.
void	setAutoLogin(java.lang.String scheme, java.lang.String secret) Tell Tinode to automatically login after connecting.
void	setAutoLoginToken(java.lang.String token) Tell Tinode to automatically login after connecting using token authentication scheme.
void	setDefaultTypeOfMetaPacket(java.lang.Class<?> typeOfPublic, java.lang.Class<?> typeOfPrivate) Assign default types of generic parameters.
void	setDefaultTypeOfMetaPacket(com.fasterxml.jackson.databind.JavaType typeOfPublic, com.fasterxml.jackson.databind.JavaType typeOfPrivate) Assign default types of generic parameters.
PromisedReply<ServerMessage>	setDeviceToken(java.lang.String token) Set device token for push notifications
void	setFndTypeOfMetaPacket(java.lang.Class<?> typeOfSubPublic) Assign type of generic Public parameter of 'fnd' topic results.
void	setFndTypeOfMetaPacket(com.fasterxml.jackson.databind.JavaType typeOfSubPublic) Assign type of generic Public parameter of 'fnd' topic results.
void	setLanguage(java.lang.String lang) Set device language
<Pu,Pr> PromisedReply<ServerMessage>	setMeta(java.lang.String topicName, MsgSetMeta<Pu,Pr> meta) Low-level request to update topic metadata.
void	setMeTypeOfMetaPacket(java.lang.Class<?> typeOfDescPublic) Assign type of generic Public parameter to 'me' topic.
void	setMeTypeOfMetaPacket(com.fasterxml.jackson.databind.JavaType typeOfDescPublic) Assign type of generic Public parameter to 'me' topic.
void	setOsString(java.lang.String os) Set non-default version of OS string for User-Agent
void	setServer(@NotNull java.lang.String host, boolean tls) Set server address and TLS status to be used in subsequent connections.
void	setTypeOfMetaPacket(java.lang.String topicName, com.fasterxml.jackson.databind.JavaType typeOfDescPublic, com.fasterxml.jackson.databind.JavaType typeOfDescPrivate, com.fasterxml.jackson.databind.JavaType typeOfSubPublic, com.fasterxml.jackson.databind.JavaType typeOfSubPrivate) Assign types of generic parameters to topic type.
<Pu,Pr> PromisedReply<ServerMessage>	subscribe(java.lang.String topicName, MsgSetMeta<Pu,Pr> set, MsgGetMeta get) Low-level subscription request.
java.net.URL	toAbsoluteURL(java.lang.String origUrl) Convert relative URL to absolute URL using Tinode server address as base.
PromisedReply<ServerMessage>	updateAccountBasic(java.lang.String uid, java.lang.String uname, java.lang.String password) Change user name and password for accounts using Basic auth scheme.
protected PromisedReply<ServerMessage>	updateAccountSecret(java.lang.String uid, java.lang.String scheme, java.lang.String secret)

Methods inherited from class java.lang.Object

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

Field Detail

USER_NEW

public static final java.lang.String USER_NEW

See Also:

Constant Field Values

TOPIC_NEW

public static final java.lang.String TOPIC_NEW

See Also:

Constant Field Values

CHANNEL_NEW

public static final java.lang.String CHANNEL_NEW

See Also:

Constant Field Values

TOPIC_ME

public static final java.lang.String TOPIC_ME

See Also:

Constant Field Values

TOPIC_FND

public static final java.lang.String TOPIC_FND

See Also:

Constant Field Values

TOPIC_SYS

public static final java.lang.String TOPIC_SYS

See Also:

Constant Field Values

TOPIC_GRP_PREFIX

public static final java.lang.String TOPIC_GRP_PREFIX

See Also:

Constant Field Values

TOPIC_CHN_PREFIX

public static final java.lang.String TOPIC_CHN_PREFIX

See Also:

Constant Field Values

TOPIC_USR_PREFIX

public static final java.lang.String TOPIC_USR_PREFIX

See Also:

Constant Field Values

MAX_MESSAGE_SIZE

public static final java.lang.String MAX_MESSAGE_SIZE

See Also:

Constant Field Values

MAX_SUBSCRIBER_COUNT

public static final java.lang.String MAX_SUBSCRIBER_COUNT

See Also:

Constant Field Values

MAX_TAG_LENGTH

public static final java.lang.String MAX_TAG_LENGTH

See Also:

Constant Field Values

MIN_TAG_LENGTH

public static final java.lang.String MIN_TAG_LENGTH

See Also:

Constant Field Values

MAX_TAG_COUNT

public static final java.lang.String MAX_TAG_COUNT

See Also:

Constant Field Values

MAX_FILE_UPLOAD_SIZE

public static final java.lang.String MAX_FILE_UPLOAD_SIZE

See Also:

Constant Field Values

NULL_VALUE

public static final java.lang.String NULL_VALUE

See Also:

Constant Field Values

NOTE_KP

protected static final java.lang.String NOTE_KP

See Also:

Constant Field Values

NOTE_READ

protected static final java.lang.String NOTE_READ

See Also:

Constant Field Values

NOTE_RECV

protected static final java.lang.String NOTE_RECV

See Also:

Constant Field Values

sTypeFactory

protected static final com.fasterxml.jackson.databind.type.TypeFactory sTypeFactory

sDateFormat

protected static final java.text.SimpleDateFormat sDateFormat

Constructor Detail

Tinode

public Tinode(java.lang.String appname,
              java.lang.String apikey,
              Storage store,
              Tinode.EventListener listener)

Initialize Tinode package

Parameters:

appname - name of the calling application to be included in User Agent on handshake.

apikey - API key generated by key-gen utility

store - persistence

listener - EventListener which will receive notifications

Tinode

public Tinode(java.lang.String appname,
              java.lang.String apikey,
              Tinode.EventListener listener)

Initialize Tinode package

Parameters:

appname - name of the calling application to be included in User Agent on handshake.

apikey - API key generated by key-gen utility

listener - EventListener which will receive notifications

Tinode

public Tinode(java.lang.String appname,
              java.lang.String apikey)

Initialize Tinode package

Parameters:

appname - name of the calling application to be included in User Agent on handshake.

apikey - API key generated by key-gen utility

Method Detail

getTypeFactory

public static com.fasterxml.jackson.databind.type.TypeFactory getTypeFactory()

getJsonMapper

public static com.fasterxml.jackson.databind.ObjectMapper getJsonMapper()

isNull

public static boolean isNull(java.lang.Object obj)

jsonSerialize

public static java.lang.String jsonSerialize(java.lang.Object o)
                                      throws com.fasterxml.jackson.core.JsonProcessingException

Convert object to JSON string. Exported for convenience.

Parameters:

o - object to convert

Returns:

JSON as string.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if object cannot be converted

jsonDeserialize

public static <T> T jsonDeserialize(java.lang.String input,
                                    java.lang.String canonicalName)

Convert JSON to an object. Exported for convenience.

Parameters:

input - JSON string to parse

canonicalName - name of the class to generate from JSON.

Returns:

converted object.

jsonDeserializeArray

public static <T> T[] jsonDeserializeArray(java.lang.String input,
                                           java.lang.String canonicalName)

Convert JSON to an array of objects. Exported for convenience.

Parameters:

input - JSON string to parse

canonicalName - name of the base class to use as elements of array.

Returns:

converted array of objects.

getKeyPressDelay

protected static long getKeyPressDelay()

Get minimum delay between two subsequent key press notifications.

newTopic

public static Topic newTopic(Tinode tinode,
                             java.lang.String name,
                             Topic.Listener l)

Instantiate topic of an appropriate class given the name.

Parameters:

tinode - instance of core Tinode to attach topic to

name - name of the topic to create

l - event listener; could be null

Returns:

topic of an appropriate class

headersForReply

public static java.util.Map<java.lang.String,java.lang.Object> headersForReply(int seq)

Headers for a reply message.

Parameters:

seq - message ID being replied to.

Returns:

headers in as map "header key : header value"

addListener

public void addListener(Tinode.EventListener listener)

Add listener which will receive event notifications.

Parameters:

listener - event listener to be notified. Should not be null.

removeListener

public boolean removeListener(Tinode.EventListener listener)

Remove listener.

Parameters:

listener - event listener to be removed. Should not be null.

setOsString

public void setOsString(java.lang.String os)

Set non-default version of OS string for User-Agent

connect

protected PromisedReply<ServerMessage> connect(@NotNull
                                               @NotNull java.net.URI serverURI,
                                               boolean background)

Open a websocket connection to the server, process handshake exchange then optionally login.

Parameters:

serverURI - address of the server to connect to.

background - this is a background connection: the server will delay user's online announcement for 5 sec.

Returns:

PromisedReply to be resolved or rejected when the connection is completed.

connect

public PromisedReply<ServerMessage> connect(@Nullable
                                            @Nullable java.lang.String hostName,
                                            boolean tls,
                                            boolean background)

Open a websocket connection to the server, process handshake exchange then optionally login.

Parameters:

hostName - address of the server to connect to; if hostName is null a saved address will be used.

tls - use transport layer security (wss); ignored if hostName is null.

Returns:

PromisedReply to be resolved or rejected when the connection is completed.

reconnectNow

public void reconnectNow(boolean interactive,
                         boolean reset,
                         boolean background)

Make sure connection is either already established or being established: - If connection is already established do nothing - If connection does not exist, create - If not connected and waiting for backoff timer, wake it up.

Parameters:

interactive - set to true if user directly requested a reconnect.

reset - if true drop connection and reconnect; happens when cluster is reconfigured.

disconnect

public void disconnect(boolean fromBkg)

Disconnect from the server.

Parameters:

fromBkg - request to disconnect background connection.

networkProbe

public void networkProbe()

Probe connection to the server by sending a test packet. It does not check connection for validity before sending. Use isConnected() first.

getBaseUrl

public java.net.URL getBaseUrl()
                        throws java.net.MalformedURLException

Get configured server address as an HTTP(S) URL.

Returns:

Server URL.

Throws:

java.net.MalformedURLException - thrown if server address is not yet configured.

getHttpOrigin

public java.lang.String getHttpOrigin()

Get server address suitable for use as an Origin: header for CORS compliance.

Returns:

server internet address

oobNotification

public void oobNotification(java.util.Map<java.lang.String,java.lang.String> data,
                            java.lang.String authToken)

Out of band notification handling. Called externally by the FCM push service. Must not be called on the UI thread.

Parameters:

data - FCM payload.

authToken - authentication token to use in case login is needed.

getApiKey

public java.lang.String getApiKey()

Get API key that was used for configuring this Tinode instance.

Returns:

API key

getMyId

public java.lang.String getMyId()

Get ID of the current logged in user.

Returns:

user ID of the current user.

isMe

public boolean isMe(java.lang.String uid)

Check if the given user ID belong to the current logged in user.

Parameters:

uid - ID of the user to check.

Returns:

true if the ID belong to the current user, false otherwise.

getAuthToken

public java.lang.String getAuthToken()

Get server-provided authentication token.

Returns:

authentication token

getAuthTokenExpiration

public java.util.Date getAuthTokenExpiration()

Get expiration time of the authentication token, see getAuthToken()

Returns:

time when the token expires or null.

isAuthenticated

public boolean isAuthenticated()

Check if the current session is authenticated.

Returns:

true if the session is authenticated, false otherwise.

getServerVersion

public java.lang.String getServerVersion()

Get the protocol version of the server that was reported at the last connection.

Returns:

server protocol version.

getServerBuild

public java.lang.String getServerBuild()

Get server build stamp reported at the last connection

Returns:

server build stamp.

setServer

public void setServer(@NotNull
                      @NotNull java.lang.String host,
                      boolean tls)

Set server address and TLS status to be used in subsequent connections.

getServerLimit

public long getServerLimit(java.lang.String key,
                           long defaultValue)

Get server-provided limit.

Parameters:

key - name of the limit.

defaultValue - default value if limit is missing.

Returns:

limit or default value.

isConnected

public boolean isConnected()

Check if connection is in a connected state. Does not check if the network is actually alive.

Returns:

true if connection is initialized and in connected state, false otherwise.

setDefaultTypeOfMetaPacket

public void setDefaultTypeOfMetaPacket(com.fasterxml.jackson.databind.JavaType typeOfPublic,
                                       com.fasterxml.jackson.databind.JavaType typeOfPrivate)

Assign default types of generic parameters. Needed for packet deserialization.

Parameters:

typeOfPublic - - type of public values in Desc and Subscription.

typeOfPrivate - - type of private values in Desc and Subscription.

setDefaultTypeOfMetaPacket

public void setDefaultTypeOfMetaPacket(java.lang.Class<?> typeOfPublic,
                                       java.lang.Class<?> typeOfPrivate)

Assign default types of generic parameters. Needed for packet deserialization.

Parameters:

typeOfPublic - - type of public values

typeOfPrivate - - type of private values

setTypeOfMetaPacket

public void setTypeOfMetaPacket(java.lang.String topicName,
                                com.fasterxml.jackson.databind.JavaType typeOfDescPublic,
                                com.fasterxml.jackson.databind.JavaType typeOfDescPrivate,
                                com.fasterxml.jackson.databind.JavaType typeOfSubPublic,
                                com.fasterxml.jackson.databind.JavaType typeOfSubPrivate)

Assign types of generic parameters to topic type. Needed for packet deserialization.

Parameters:

topicName - - name of the topic to assign type values for.

typeOfDescPublic - - type of public values

typeOfDescPrivate - - type of private values

typeOfSubPublic - - type of public values

typeOfSubPrivate - - type of private values

setMeTypeOfMetaPacket

public void setMeTypeOfMetaPacket(com.fasterxml.jackson.databind.JavaType typeOfDescPublic)

Assign type of generic Public parameter to 'me' topic. Needed for packet deserialization.

Parameters:

typeOfDescPublic - - type of public values

setMeTypeOfMetaPacket

public void setMeTypeOfMetaPacket(java.lang.Class<?> typeOfDescPublic)

Assign type of generic Public parameter to 'me' topic. Needed for packet deserialization.

Parameters:

typeOfDescPublic - - type of public values

setFndTypeOfMetaPacket

public void setFndTypeOfMetaPacket(com.fasterxml.jackson.databind.JavaType typeOfSubPublic)

Assign type of generic Public parameter of 'fnd' topic results. Needed for packet deserialization.

Parameters:

typeOfSubPublic - - type of subscription (search result) public values

setFndTypeOfMetaPacket

public void setFndTypeOfMetaPacket(java.lang.Class<?> typeOfSubPublic)

Assign type of generic Public parameter of 'fnd' topic results. Needed for packet deserialization.

Parameters:

typeOfSubPublic - - type of subscription (search result) public values

getTypeOfMetaPacket

protected com.fasterxml.jackson.databind.JavaType getTypeOfMetaPacket(java.lang.String topicName)

Obtain previously assigned type of Meta packet.

Returns:

type of Meta packet.

makeUserAgent

protected java.lang.String makeUserAgent()

Compose User Agent string to be sent to the server.

Returns:

composed User Agent string.

getFileUploader

public LargeFileHelper getFileUploader()

Get LargeFileHelper object initialized for use with file uploading.

Returns:

LargeFileHelper object.

setDeviceToken

public PromisedReply<ServerMessage> setDeviceToken(java.lang.String token)

Set device token for push notifications

Parameters:

token - device token; to delete token pass NULL_VALUE

setLanguage

public void setLanguage(java.lang.String lang)

Set device language

Parameters:

lang - ISO 639-1 code for language

hello

public PromisedReply<ServerMessage> hello(java.lang.Boolean background)

Send a handshake packet to the server. A connection must be established prior to calling this method.

Parameters:

background - indicator that this session should be treated as a service request, i.e. presence notifications will be delayed.

Returns:

PromisedReply of the reply ctrl message.

account

protected <Pu,Pr> PromisedReply<ServerMessage> account(java.lang.String uid,
                                                       java.lang.String scheme,
                                                       java.lang.String secret,
                                                       boolean loginNow,
                                                       java.lang.String[] tags,
                                                       MetaSetDesc<Pu,Pr> desc,
                                                       Credential[] cred)

Create new account. Connection must be established prior to calling this method.

Parameters:

uid - uid of the user to affect

scheme - authentication scheme to use

secret - authentication secret for the chosen scheme

loginNow - use the new account to login immediately

desc - default access parameters for this account

Returns:

PromisedReply of the reply ctrl message

createAccountBasic

public <Pu,Pr> PromisedReply<ServerMessage> createAccountBasic(java.lang.String uname,
                                                               java.lang.String password,
                                                               boolean login,
                                                               java.lang.String[] tags,
                                                               MetaSetDesc<Pu,Pr> desc,
                                                               Credential[] cred)

Create account using a single basic authentication scheme. A connection must be established prior to calling this method.

Parameters:

uname - user name

password - password

login - use the new account for authentication

tags - discovery tags

desc - account parameters, such as full name etc.

cred - account credential, such as email or phone

Returns:

PromisedReply of the reply ctrl message

updateAccountSecret

protected PromisedReply<ServerMessage> updateAccountSecret(java.lang.String uid,
                                                           java.lang.String scheme,
                                                           java.lang.String secret)

updateAccountBasic

public PromisedReply<ServerMessage> updateAccountBasic(java.lang.String uid,
                                                       java.lang.String uname,
                                                       java.lang.String password)

Change user name and password for accounts using Basic auth scheme.

Parameters:

uid - user ID being updated

uname - new login or null to keep the old login.

password - new password.

Returns:

PromisedReply of the reply ctrl message.

loginBasic

public PromisedReply<ServerMessage> loginBasic(java.lang.String uname,
                                               java.lang.String password)

Send a basic login packet to the server. A connection must be established prior to calling this method. Success or failure will be reported through Tinode.EventListener.onLogin(int, String)

Parameters:

uname - user name

password - password

Returns:

PromisedReply of the reply ctrl message

loginToken

public PromisedReply<ServerMessage> loginToken(java.lang.String token,
                                               Credential[] creds)

Send a basic login packet to the server. A connection must be established prior to calling this method. Success or failure will be reported through Tinode.EventListener.onLogin(int, String)

Parameters:

token - server-provided security token

creds - validation credentials.

Returns:

PromisedReply of the reply ctrl message

loginToken

public PromisedReply<ServerMessage> loginToken(java.lang.String token)

Send a basic login packet to the server. A connection must be established prior to calling this method. Success or failure will be reported through Tinode.EventListener.onLogin(int, String)

Parameters:

token - server-provided security token

Returns:

PromisedReply of the reply ctrl message

requestResetSecret

public PromisedReply<ServerMessage> requestResetSecret(java.lang.String scheme,
                                                       java.lang.String method,
                                                       java.lang.String value)

Reset authentication secret, such as password.

Parameters:

scheme - authentication scheme being reset.

method - validation method to use, such as 'email' or 'tel'.

value - address to send validation request to using the method above, e.g. 'jdoe@example.com'.

Returns:

PromisedReply of the reply ctrl message

login

protected PromisedReply<ServerMessage> login(java.lang.String combined)

login

protected PromisedReply<ServerMessage> login(java.lang.String scheme,
                                             java.lang.String secret,
                                             Credential[] creds)

Parameters:

scheme - authentication scheme

secret - base64-encoded authentication secret

creds - credentials for validation

Returns:

PromisedReply resolved or rejected on completion.

setAutoLogin

public void setAutoLogin(java.lang.String scheme,
                         java.lang.String secret)

Tell Tinode to automatically login after connecting.

Parameters:

scheme - authentication scheme to use

secret - authentication secret

setAutoLoginToken

public void setAutoLoginToken(java.lang.String token)

Tell Tinode to automatically login after connecting using token authentication scheme.

Parameters:

token - auth token to use or null to disable auth-login.

logout

public void logout()

Log out current user.

subscribe

public <Pu,Pr> PromisedReply<ServerMessage> subscribe(java.lang.String topicName,
                                                      MsgSetMeta<Pu,Pr> set,
                                                      MsgGetMeta get)

Low-level subscription request. The subsequent messages on this topic will not be automatically dispatched. A Topic.subscribe() should be normally used instead.

Parameters:

topicName - name of the topic to subscribe to

set - values to be assign to topic on success.

get - query for topic values.

Returns:

PromisedReply of the reply ctrl message

leave

public PromisedReply<ServerMessage> leave(java.lang.String topicName,
                                          boolean unsub)

Low-level request to unsubscribe topic. A Topic.leave(boolean) should be normally used instead.

Parameters:

topicName - name of the topic to subscribe to

Returns:

PromisedReply of the reply ctrl message

publish

public PromisedReply<ServerMessage> publish(java.lang.String topicName,
                                            java.lang.Object data,
                                            java.util.Map<java.lang.String,java.lang.Object> head,
                                            java.lang.String[] attachments)

Low-level request to publish data. A Topic.publish(co.tinode.tinodesdk.model.Drafty, java.util.Map<java.lang.String, java.lang.Object>, long) should be normally used instead.

Parameters:

topicName - name of the topic to publish to

data - payload to publish to topic

head - message header

attachments - URLs of out-of-band attachments contained in the message.

Returns:

PromisedReply of the reply ctrl message

getMeta

public PromisedReply<ServerMessage> getMeta(java.lang.String topicName,
                                            MsgGetMeta query)

Low-level request to query topic for metadata. A Topic.getMeta(co.tinode.tinodesdk.model.MsgGetMeta) should be normally used instead.

Parameters:

topicName - name of the topic to query.

query - metadata query

Returns:

PromisedReply of the reply ctrl or meta message

setMeta

public <Pu,Pr> PromisedReply<ServerMessage> setMeta(java.lang.String topicName,
                                                    MsgSetMeta<Pu,Pr> meta)

Low-level request to update topic metadata. A Topic.setMeta(co.tinode.tinodesdk.model.MsgSetMeta<DP, DR>) should be normally used instead.

Parameters:

topicName - name of the topic to publish to

meta - metadata to assign

Returns:

PromisedReply of the reply ctrl or meta message

delMessage

public PromisedReply<ServerMessage> delMessage(java.lang.String topicName,
                                               int fromId,
                                               int toId,
                                               boolean hard)

Low-level request to delete all messages from the topic with ids in the given range. Use Topic.delMessages(int, int, boolean) instead.

Parameters:

topicName - name of the topic to inform

fromId - minimum ID to delete, inclusive (closed)

toId - maximum ID to delete, exclusive (open)

Returns:

PromisedReply of the reply ctrl message

delMessage

public PromisedReply<ServerMessage> delMessage(java.lang.String topicName,
                                               MsgRange[] ranges,
                                               boolean hard)

Low-level request to delete messages from a topic. Use Topic.delMessages(MsgRange[], boolean) instead.

Parameters:

topicName - name of the topic to inform

ranges - delete all messages with ids these ranges

Returns:

PromisedReply of the reply ctrl message

delMessage

public PromisedReply<ServerMessage> delMessage(java.lang.String topicName,
                                               int seqId,
                                               boolean hard)

Low-level request to delete one message from a topic. Use Topic.delMessages(MsgRange[], boolean) instead.

Parameters:

topicName - name of the topic to inform

seqId - seqID of the message to delete.

Returns:

PromisedReply of the reply ctrl message

delTopic

public PromisedReply<ServerMessage> delTopic(java.lang.String topicName,
                                             boolean hard)

Low-level request to delete topic. Use Topic.delete(boolean) instead.

Parameters:

topicName - name of the topic to delete

hard - hard-delete topic.

Returns:

PromisedReply of the reply ctrl message

delSubscription

public PromisedReply<ServerMessage> delSubscription(java.lang.String topicName,
                                                    java.lang.String user)

Low-level request to delete a subscription. Use Topic.eject(String, boolean) ()} instead.

Parameters:

topicName - name of the topic

user - user ID to unsubscribe

Returns:

PromisedReply of the reply ctrl message

delCredential

public PromisedReply<ServerMessage> delCredential(Credential cred)

Low-level request to delete a credential. Use MeTopic.delCredential(String, String) ()} instead.

Parameters:

cred - credential to delete.

Returns:

PromisedReply of the reply ctrl message

delCurrentUser

public PromisedReply<ServerMessage> delCurrentUser(boolean hard)

Request to delete account of the current user.

Parameters:

hard - hard-delete

Returns:

PromisedReply of the reply ctrl message

note

protected void note(java.lang.String topicName,
                    java.lang.String what,
                    int seq)

Inform all other topic subscribers of activity, such as receiving/reading a message or a typing notification. This method does not return a PromisedReply because the server does not acknowledge {note} packets.

Parameters:

topicName - name of the topic to inform

what - one or "read", "recv", "kp"

seq - id of the message being acknowledged

noteKeyPress

public void noteKeyPress(java.lang.String topicName)

Send typing notification to all other topic subscribers. This method does not return a PromisedReply because the server does not acknowledge {note} packets.

Parameters:

topicName - name of the topic to inform

noteRead

public void noteRead(java.lang.String topicName,
                     int seq)

Read receipt. This method does not return a PromisedReply because the server does not acknowledge {note} packets.

Parameters:

topicName - name of the topic to inform

seq - id of the message being acknowledged

noteRecv

public void noteRecv(java.lang.String topicName,
                     int seq)

Received receipt. This method does not return a PromisedReply because the server does not acknowledge {note} packets.

Parameters:

topicName - name of the topic to inform

seq - id of the message being acknowledged

send

protected void send(java.lang.String message)

Writes a string to websocket.

Parameters:

message - string to write to websocket

send

protected void send(ClientMessage message)
             throws com.fasterxml.jackson.core.JsonProcessingException

Takes ClientMessage, converts it to string writes to websocket.

Parameters:

message - string to write to websocket

Throws:

com.fasterxml.jackson.core.JsonProcessingException

sendWithPromise

protected PromisedReply<ServerMessage> sendWithPromise(ClientMessage message,
                                                       java.lang.String id)

Takes ClientMessage, converts it to string writes to websocket.

Parameters:

message - string to write to websocket.

id - string used to identify message response so the promise can be resolved.

Returns:

PromisedReply of the reply ctrl message

newTopic

public Topic newTopic(java.lang.String name,
                      Topic.Listener l)

Instantiate topic of an appropriate class given the name.

Parameters:

name - name of the topic to create

l - event listener; could be null

Returns:

topic of an appropriate class

getOrCreateMeTopic

public <DP> MeTopic<DP> getOrCreateMeTopic()

Get 'me' topic from cache. If missing, instantiate it.

Type Parameters:

DP - type of Public value.

Returns:

'me' topic.

getOrCreateFndTopic

public <DP> FndTopic<DP> getOrCreateFndTopic()

Get 'fnd' topic from cache. If missing, instantiate it.

Type Parameters:

DP - type of Public value.

Returns:

'fnd' topic.

maybeCreateTopic

protected Topic maybeCreateTopic(MsgServerMeta meta)

Instantiate topic from {meta} packet using meta.desc.

Returns:

new topic or null if meta.desc is null.

getMeTopic

public <DP> MeTopic<DP> getMeTopic()

Obtain a 'me' topic (MeTopic).

Returns:

'me' topic or null if 'me' has never been subscribed to

getFndTopic

public <DP> FndTopic<DP> getFndTopic()

Obtain a 'fnd' topic (FndTopic).

Returns:

'fnd' topic or null if 'fnd' has never been subscribed to

getTopics

public java.util.Collection<Topic> getTopics()

Return a list of topics sorted by Topic.touched in descending order.

Returns:

a List of topics

getTopicsUpdated

public java.util.Date getTopicsUpdated()

Get the most recent timestamp of update to any topic.

Returns:

timestamp of the last update to any topic.

getFilteredTopics

public <T extends Topic> java.util.Collection<T> getFilteredTopics(Tinode.TopicFilter filter)

Return a list of topics which satisfy the filters. Topics are sorted by Topic.touched in descending order.

Parameters:

filter - filter object to select topics.

Returns:

a List of topics

getTopic

public Topic getTopic(java.lang.String name)

Get topic by name.

Parameters:

name - name of the topic to find.

Returns:

existing topic or null if no such topic was found

getLastMessage

public Storage.Message getLastMessage(java.lang.String topicName)

Get the latest cached message in the given topic.

Parameters:

topicName - name of the topic to get message for.

Returns:

last cached message or null.

getUser

public <SP> User<SP> getUser(@NotNull
                             @NotNull java.lang.String uid)

Look up user in a local cache: first in memory, then in persistent storage.

Parameters:

uid - ID of the user to find.

Returns:

User object or null if no such user is found in local cache.

parseServerMessageFromJson

protected ServerMessage parseServerMessageFromJson(java.lang.String jsonMessage)

Parse JSON received from the server into ServerMessage

Parameters:

jsonMessage - message to parse

Returns:

ServerMessage or null

toAbsoluteURL

public java.net.URL toAbsoluteURL(java.lang.String origUrl)

Convert relative URL to absolute URL using Tinode server address as base. If the URL is already absolute it's left unchanged.

Parameters:

origUrl - possibly relative URL to convert to absolute.

Returns:

absolute URL or null if origUrl is invalid.

isTrustedURL

public boolean isTrustedURL(java.net.URL url)

Check if the given URL is trusted: points to Tinode server using HTTP or HTTPS protocol.

Parameters:

url - URL to check.

Returns:

true if the URL is trusted, false otherwise.

getRequestHeaders

public java.util.Map<java.lang.String,java.lang.String> getRequestHeaders()

Get map with HTTP request parameters suitable for requests to Tinode server.

Returns:

Map with API key, authentication headers and User agent.