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>

Invite(host: String, port: Int, identity: Identity, secretKey: SecretKey)

Default constructor

Functions

host

fun host(): String

identity

fun identity(): Identity

port

fun port(): Int

secretKey

fun secretKey(): SecretKey

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

toCanonicalForm

fun toCanonicalForm(): String

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

toString

fun toString(): String