Index

A C D E G H I M N O R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

amount() - Method in record class net.voidnote.CryptoOrder

Returns the value of the amount record component.

amountUsd() - Method in record class net.voidnote.CryptoOrder

Returns the value of the amountUsd record component.

API - Enum constant in enum class net.voidnote.VoidNoteException.Kind

Other server-side or crypto error.

apiKey - Variable in class net.voidnote.CreateOptions

Required: your API key (vn_...).

apiKey - Variable in class net.voidnote.StreamOptions

Required: your API key (vn_...).

C

chain() - Method in record class net.voidnote.CryptoOrder

Returns the value of the chain record component.

close() - Method in class net.voidnote.StreamHandle

Closes the stream.

content() - Method in record class net.voidnote.ReadResult

Returns the value of the content record component.

create(String, CreateOptions) - Static method in class net.voidnote.VoidNote

Encrypts content client-side and creates a self-destructing note.

createCryptoOrder(String, String, String, String) - Static method in class net.voidnote.VoidNote

Creates a crypto payment order.

CreateOptions - Class in net.voidnote

Options for VoidNote.create(java.lang.String, net.voidnote.CreateOptions).

CreateResult - Record Class in net.voidnote

Result of VoidNote.create(java.lang.String, net.voidnote.CreateOptions).

CreateResult(String, String) - Constructor for record class net.voidnote.CreateResult

Creates an instance of a CreateResult record class.

createStream(StreamOptions) - Static method in class net.voidnote.VoidNote

Opens a live encrypted stream.

credits() - Method in record class net.voidnote.CryptoOrder

Returns the value of the credits record component.

credits() - Method in record class net.voidnote.SubmitPaymentResult

Returns the value of the credits record component.

creditsAdded() - Method in record class net.voidnote.SubmitPaymentResult

Returns the value of the creditsAdded record component.

CryptoOrder - Record Class in net.voidnote

Result of VoidNote.createCryptoOrder(java.lang.String, java.lang.String, java.lang.String, java.lang.String).

CryptoOrder(String, String, String, String, double, String, int, String) - Constructor for record class net.voidnote.CryptoOrder

Creates an instance of a CryptoOrder record class.

D

DECRYPTION_FAILED - Enum constant in enum class net.voidnote.VoidNoteException.Kind

Ciphertext tampered, or wrong key.

destroyed() - Method in record class net.voidnote.ReadResult

Returns the value of the destroyed record component.

E

equals(Object) - Method in record class net.voidnote.CreateResult

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class net.voidnote.CryptoOrder

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class net.voidnote.ReadResult

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class net.voidnote.SubmitPaymentResult

Indicates whether some other object is "equal to" this one.

expiresAt - Variable in class net.voidnote.StreamHandle

ISO 8601 expiry timestamp.

expiresAt() - Method in record class net.voidnote.CreateResult

Returns the value of the expiresAt record component.

expiresAt() - Method in record class net.voidnote.CryptoOrder

Returns the value of the expiresAt record component.

expiresIn - Variable in class net.voidnote.CreateOptions

Expiry in hours.

G

getKind() - Method in exception class net.voidnote.VoidNoteException

H

hashCode() - Method in record class net.voidnote.CreateResult

Returns a hash code value for this object.

hashCode() - Method in record class net.voidnote.CryptoOrder

Returns a hash code value for this object.

hashCode() - Method in record class net.voidnote.ReadResult

Returns a hash code value for this object.

hashCode() - Method in record class net.voidnote.SubmitPaymentResult

Returns a hash code value for this object.

I

INVALID_TOKEN - Enum constant in enum class net.voidnote.VoidNoteException.Kind

Token string is not 64 hex chars.

M

maxViews - Variable in class net.voidnote.CreateOptions

Destroy after this many reads (1–100).

maxViews() - Method in record class net.voidnote.ReadResult

Returns the value of the maxViews record component.

N

net.voidnote - package net.voidnote

NETWORK - Enum constant in enum class net.voidnote.VoidNoteException.Kind

HTTP transport failure.

NOT_FOUND - Enum constant in enum class net.voidnote.VoidNoteException.Kind

404 — note or stream not found, or already destroyed.

noteType - Variable in class net.voidnote.CreateOptions

Note type: "secure" (default, encrypted static note) or "pipe" (streaming append mode).

O

of(String) - Static method in class net.voidnote.CreateOptions

Creates options with only the required API key.

of(String) - Static method in class net.voidnote.StreamOptions

Creates options with only the required API key.

orderId() - Method in record class net.voidnote.CryptoOrder

Returns the value of the orderId record component.

R

read(String) - Static method in class net.voidnote.VoidNote

Fetches and decrypts a VoidNote.

readFrom(String, String) - Static method in class net.voidnote.VoidNote

Like VoidNote.read(java.lang.String) but with a custom API base URL (for self-hosted instances).

ReadResult - Record Class in net.voidnote

Decrypted content of a VoidNote.

ReadResult(String, String, int, int, boolean) - Constructor for record class net.voidnote.ReadResult

Creates an instance of a ReadResult record class.

S

StreamHandle - Class in net.voidnote

A live Void Stream.

StreamOptions - Class in net.voidnote

Options for VoidNote.createStream(net.voidnote.StreamOptions).

submitCryptoPayment(String, String, String) - Static method in class net.voidnote.VoidNote

Submits a completed on-chain transaction for verification.

SubmitPaymentResult - Record Class in net.voidnote

Result of VoidNote.submitCryptoPayment(java.lang.String, java.lang.String, java.lang.String).

SubmitPaymentResult(int, int) - Constructor for record class net.voidnote.SubmitPaymentResult

Creates an instance of a SubmitPaymentResult record class.

T

title - Variable in class net.voidnote.CreateOptions

Optional note title (stored in plaintext).

title - Variable in class net.voidnote.StreamOptions

Optional stream title.

title() - Method in record class net.voidnote.ReadResult

Returns the value of the title record component.

toAddress() - Method in record class net.voidnote.CryptoOrder

Returns the value of the toAddress record component.

token() - Method in record class net.voidnote.CryptoOrder

Returns the value of the token record component.

toString() - Method in record class net.voidnote.CreateResult

Returns a string representation of this record class.

toString() - Method in record class net.voidnote.CryptoOrder

Returns a string representation of this record class.

toString() - Method in record class net.voidnote.ReadResult

Returns a string representation of this record class.

toString() - Method in record class net.voidnote.SubmitPaymentResult

Returns a string representation of this record class.

ttlSeconds - Variable in class net.voidnote.StreamOptions

Stream lifetime in seconds.

U

UNAUTHORIZED - Enum constant in enum class net.voidnote.VoidNoteException.Kind

401 — invalid or missing API key.

url - Variable in class net.voidnote.StreamHandle

Shareable URL.

url() - Method in record class net.voidnote.CreateResult

Returns the value of the url record component.

V

valueOf(String) - Static method in enum class net.voidnote.VoidNoteException.Kind

Returns the enum constant of this class with the specified name.

values() - Static method in enum class net.voidnote.VoidNoteException.Kind

Returns an array containing the constants of this enum class, in the order they are declared.

viewCount() - Method in record class net.voidnote.ReadResult

Returns the value of the viewCount record component.

VoidNote - Class in net.voidnote

Official Java SDK for VoidNote.

VoidNoteException - Exception Class in net.voidnote

Thrown when a VoidNote SDK operation fails.

VoidNoteException(VoidNoteException.Kind, String) - Constructor for exception class net.voidnote.VoidNoteException

VoidNoteException(VoidNoteException.Kind, String, Throwable) - Constructor for exception class net.voidnote.VoidNoteException

VoidNoteException.Kind - Enum Class in net.voidnote

W

watch(String, Consumer<String>) - Static method in class net.voidnote.VoidNote

Watches a stream, calling onMessage for each decrypted event.

watch(Consumer<String>) - Method in class net.voidnote.StreamHandle

Subscribes to this stream, calling onMessage for each decrypted event.

withExpiresIn(int) - Method in class net.voidnote.CreateOptions

Set expiry in hours.

withMaxViews(int) - Method in class net.voidnote.CreateOptions

withNoteType(String) - Method in class net.voidnote.CreateOptions

Set note type: "secure" or "pipe".

withTitle(String) - Method in class net.voidnote.CreateOptions

withTitle(String) - Method in class net.voidnote.StreamOptions

withTtl(int) - Method in class net.voidnote.StreamOptions

write(String) - Method in class net.voidnote.StreamHandle

Encrypts content client-side and pushes it to the stream.

A C D E G H I M N O R S T U V W
All Classes and Interfaces|All Packages|Serialized Form