Hub JS Package

Hub JS Package

  • Users
  • Buckets
  • Threads
  • Textile Docs

›Client

Client

  • Client.withUserAuth() method
  • Client.withKeyInfo() method
  • Client.getToken() method
  • Client.getTokenChallenge() method
  • Client.newDB() method
  • Client.open() method
  • Client.deleteDB() method
  • Client.getDBInfo() method
  • Client.joinFromInfo() method
  • Client.newDBFromAddr() method
  • Client.listen() method
  • Client.listDBs() method
  • Client.newCollection() method
  • Client.newCollectionFromObject() method
  • Client.deleteCollection() method
  • Client.updateCollection() method
  • Client.getCollectionIndexes() method
  • Client.getCollectionInfo() method
  • Client.listCollections() method
  • Client.create() method
  • Client.save() method
  • Client.delete() method
  • Client.find() method
  • Client.findByID() method
  • Client.has() method
  • Client.readTransaction() method
  • Client.writeTransaction() method

WriteTransaction

  • WriteTransaction class
  • WriteTransaction.create() method
  • WriteTransaction.delete() method
  • WriteTransaction.find() method
  • WriteTransaction.findByID() method
  • WriteTransaction.has() method
  • WriteTransaction.save() method
  • WriteTransaction.start() method
  • WriteTransaction.discard() method

ReadTransaction

  • ReadTransaction class
  • ReadTransaction.find() method
  • ReadTransaction.findByID() method
  • ReadTransaction.has() method
  • ReadTransaction.start() method

Types

  • Action enum
  • DBInfo interface
  • Filter interface
  • Query class
  • Update interface
  • Where variable

@textile/hub > Client > getTokenChallenge

Client.getTokenChallenge() method

Obtain a token per user (identity) for interacting with the remote API.

Signature:

getTokenChallenge(publicKey: string, callback: (challenge: Uint8Array) => Uint8Array | Promise<Uint8Array>, ctx?: ContextInterface): Promise<string>;

Parameters

ParameterTypeDescription
publicKeystringThe public key of a user identity to use for creating records in the database. A random identity can be created with `Client.randomIdentity(), however, it is not easy/possible to migrate identities after the fact. Please store or otherwise persist any identity information if you wish to retrieve user data later, or use an external identity provider.
callback(challenge: Uint8Array) => Uint8Array | Promise<Uint8Array>A callback function that takes a challenge argument and returns a signed message using the input challenge and the private key associated with publicKey.
ctxContextInterfaceContext object containing web-gRPC headers and settings.

Returns:

Promise<string>

Remarks

publicKey must be the corresponding public key of the private key used in callback.

← Client.getToken() methodNext →
  • Client.getTokenChallenge() method
  • Parameters
  • Remarks
Hub JS Package
Docs
Getting StartedThreadDBBuckets
Resources
All DocumentationProject SlackBlog
More
GitHubStar
Follow @textileio