Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Snapshots

Snapshots is an API module for managing thread snapshots

extends

API

Hierarchy

  • API
    • Snapshots

Index

Constructors

Methods

Constructors

constructor

Methods

apply

  • apply(id?: undefined | string, wait?: undefined | number): Promise<ReadableStream<QueryResult>>

  • Apply a single thread snapshot

    Parameters

    • Optional id: undefined | string

      The snapshot id (omit to find and apply all snapshots)

    • Optional wait: undefined | number

      Stops searching after 'wait' seconds have elapsed (max 30 default 2)

    Returns Promise<ReadableStream<QueryResult>>

    A ReadableStream of QueryResult objects.

applySnapshot

  • applySnapshot(snapshot: QueryResult): Promise<boolean>

create

  • create(): Promise<boolean>

  • Snapshot all threads and push to registered cafes

    Returns Promise<boolean>

    Whether the snapshot process was successfull

search

  • search(wait?: undefined | number): Promise<ReadableStream<QueryResult>>

  • Search the network for thread snapshots

    Parameters

    • Optional wait: undefined | number

      Stops searching after 'wait' seconds have elapsed (max 30 default 2)

    Returns Promise<ReadableStream<QueryResult>>

    A ReadableStream of QueryResult objects.