Adds and joins a new thread
The name of the new thread
Schema ID for the new thread
A locally unique key used by an app to identify this thread on recovery
The type of thread, must be one of 'private' (default), 'read_only', 'public', or 'open'
The sharing style of thread, must be one of 'notshared' (default), 'invite_only', or 'shared'
An array of contact addresses. When supplied, the thread will not allow additional peers, useful for 1-1 chat/file sharing or private threads.
The newly generated thread info
Adds or updates a thread directly, usually from a backup
ID of the thread
Thread object
Retrieve a thread by ID
ID of the thread
A thread object
Retrieve a thread by Key
Key of the thread
A thread object
Retrieve threads by Name
Name of the thread
An array thread objects
Lists all local threads
An array of threads
List all peers in a thread
ID of the thread (default is 'default').
An array of thread contacts
Leave and remove a thread by ID
ID of the thread
Whether the thread removal was successfull
Leave and remove a thread by Key
thread.key of the thread
Whether the thread removal was successfull
Renames a thread
Note: Only initiators can rename a thread.
ID of the thread
New name for the thread
Whether the rename was successfully
Threads is an API module for managing Textile threads
Threads are distributed sets of encrypted files between peers governed by build-in or custom Schemas.
Thread type controls read (R), annotate (A), and write (W) access:
private --> initiator: RAW, whitelist: readonly --> initiator: RAW, whitelist: R public --> initiator: RAW, whitelist: RA open --> initiator: RAW, whitelist: RAW
Thread sharing style controls if (Y/N) a thread can be shared:
notshared --> initiator: N, whitelist: N inviteonly --> initiator: Y, whitelist: N shared --> initiator: Y, whitelist: Y
API