scuttlebutt / org.apache.tuweni.scuttlebutt / Invite

Invite

class Invite (source)

An invite code as defined by the Secure Scuttlebutt protocol guide.

See https://ssbc.github.io/scuttlebutt-protocol-guide/ for a detailed description of invites.

Constructors

<init>

Default constructor

Invite(host: String!, port: Int, identity: Identity!, seedKey: Seed!)

Functions

fromCanonicalForm

Takes an invite string in its canonical form and parses it into an Invite object, throwing an error if it is not of the expected format.

static fun fromCanonicalForm(inviteCode: String!): Invite!

host

fun host(): String!

identity

fun identity(): Identity!

port

fun port(): Int

seedKey

The secret key the user may use while redeeming the invite to make the publisher follow them back.

fun seedKey(): Seed!

toCanonicalForm

Provides the invite as a string that is understood by other Secure Scuttlebutt clients.

fun toCanonicalForm(): String!

toString

fun toString(): String