tinode-sdk

Classes

Tinode

Type Definitions

AccountParams

Properties:
Name Type Attributes Description
defacs DefAcs <optional>
 Default access parameters for user's me topic.
public Object <optional>
 Public application-defined data exposed on me topic.
private Object <optional>
 Private application-defined data accessible on me topic.
trusted Object <optional>
 Trusted user data which can be set by a root user only.
tags Array.<string> array of string tags for user discovery.
scheme string Temporary authentication scheme for password reset.
secret string Temporary authentication secret for password reset.
attachments Array.<string> <optional>
 Array of references to out of band attachments used in account description.
Source:
Type:
  • Object

AuthToken

Properties:
Name Type Description
token string Token value.
expires Date Token expiration time.
Source:
Type:
  • Object

Credential

Properties:
Name Type Description
meth string validation method.
val string value to validate (e.g. email or phone number).
resp string validation response.
params Object validation parameters.
Source:
Type:
  • Object

DefAcs

Properties:
Name Type Attributes Description
auth string <optional>
 Access mode for me for authenticated users.
anon string <optional>
 Access mode for me for anonymous users.
Source:
Type:
  • Object

DelRange

Range of message IDs to delete.
Properties:
Name Type Attributes Description
low number low end of the range, inclusive (closed).
hi number <optional>
 high end of the range, exclusive (open).
Source:
Type:
  • Object

GetDataType

Properties:
Name Type Attributes Description
since number <optional>
 Load messages with seq id equal or greater than this value.
before number <optional>
 Load messages with seq id lower than this number.
limit number <optional>
 Maximum number of results to return.
Source:
Type:
  • Object

GetOptsType

Properties:
Name Type Attributes Description
ims Date <optional>
 "If modified since", fetch data only it was was modified since stated date.
limit number <optional>
 Maximum number of results to return. Ignored when querying topic description.
Source:
Type:
  • Object

GetQuery

Properties:
Name Type Attributes Description
desc GetOptsType <optional>
 If provided (even if empty), fetch topic description.
sub GetOptsType <optional>
 If provided (even if empty), fetch topic subscriptions.
data GetDataType <optional>
 If provided (even if empty), get messages.
Source:
Type:
  • Object

onConnect(code, text, params)

Source:
Parameters:
Name Type Description
code number Result code
text string Text epxplaining the completion, i.e "OK" or an error message.
params ServerParams Parameters returned by the server.

onLogin(code, text)

Source:
Parameters:
Name Type Description
code number NUmeric completion code, same as HTTP status codes.
text string Explanation of the completion code.

ServerParams

Properties:
Name Type Attributes Description
ver string Server version
build string Server build
sid string <optional>
 Session ID, long polling connections only.
Source:
Type:
  • Object

SetDesc

Properties:
Name Type Attributes Description
defacs DefAcs <optional>
 Default access mode.
public Object <optional>
 Free-form topic description, publically accessible.
private Object <optional>
 Free-form topic description accessible only to the owner.
trusted Object <optional>
 Trusted user data which can be set by a root user only.
Source:
Type:
  • Object

SetParams

Properties:
Name Type Attributes Description
desc SetDesc <optional>
 Topic initialization parameters when creating a new topic or a new subscription.
sub SetSub <optional>
 Subscription initialization parameters.
attachments Array.<string> <optional>
 URLs of out of band attachments used in parameters.
Source:
Type:
  • Object

SetSub

Properties:
Name Type Attributes Description
user string <optional>
 UID of the user affected by the request. Default (empty) - current user.
mode string <optional>
 User access mode, either requested or assigned dependent on context.
Source:
Type:
  • Object