External module "threads"

Index

Functions

Functions

add

add(config: IAddThreadConfig): Promise<IThread>

- Defined in threads.ts:27
Add a new Thread.
```
Textile.threads.add(config);
```
Parameters
- config: IAddThreadConfig
Returns Promise<IThread>

addOrUpdate

addOrUpdate(thread: IThread): Promise<void>

- Defined in threads.ts:41
Add a Thread or update metadata if new.
```
Textile.threads.addOrUpdate(thread);
```
Parameters
- thread: IThread
Returns Promise<void>

cancelSearchSnapshots

cancelSearchSnapshots(): Promise<void>

- Defined in threads.ts:133
Cancel an ongoing thread snapshots search.
```
Textile.threads.cancelSearchSnapshots();
```
Returns Promise<void>

get

get(threadId: string): Promise<IThread>

- Defined in threads.ts:62
Get Thread details by ThreadId.
```
Textile.threads.get(threadId);
```
Parameters
- threadId: string
Returns Promise<IThread>

list

list(): Promise<IThreadList>

- Defined in threads.ts:74
List all Threads.
```
Textile.threads.list();
```
Returns Promise<IThreadList>

peers

peers(threadId: string): Promise<IPeerList>

- Defined in threads.ts:85
Request all Peers in a Thread by ThreadId.
```
Textile.threads.peers(threadId);
```
Parameters
- threadId: string
Returns Promise<IPeerList>

remove

remove(id_: string): Promise<string>

- Defined in threads.ts:96
Remove a Thread by ThreadId.
```
Textile.threads.remove(id);
```
Parameters
- id_: string
Returns Promise<string>

rename

rename(threadId: string, name: string): Promise<void>

- Defined in threads.ts:52
Rename a Thread by ThreadId.
```
Textile.threads.rename(threadId, name);
```
Parameters
- threadId: string
- name: string
Returns Promise<void>

searchSnapshots

searchSnapshots(query: IThreadSnapshotQuery, options: IQueryOptions): Promise<string>

- Defined in threads.ts:117
Locate all Thread snapshots.
```
const snapshots = Textile.threads.searchSnapshots(query, options);
```
Parameters
- query: IThreadSnapshotQuery
- options: IQueryOptions
Returns Promise<string>

snapshot

snapshot(): Promise<void>

- Defined in threads.ts:107
Snapshot all threads for active cafe sessions.
```
Textile.threads.snapshot();
```
Returns Promise<void>