Index (voidnote-java 0.1.0 API)

A

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_...).

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.
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.

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.

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.ReadResult: 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.

hashCode() - Method in record class net.voidnote.CreateResult: Returns a hash code value for this object.
hashCode() - Method in record class net.voidnote.ReadResult: Returns a hash code value for this object.

INVALID_TOKEN - Enum constant in enum class net.voidnote.VoidNoteException.Kind: Token string is not 64 hex chars.

maxViews - Variable in class net.voidnote.CreateOptions: Destroy after this many reads.
maxViews() - Method in record class net.voidnote.ReadResult: Returns the value of the maxViews record component.

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.

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.

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.

StreamHandle - Class in net.voidnote: A live Void Stream.
StreamOptions - Class in net.voidnote: Options for VoidNote.createStream(net.voidnote.StreamOptions).

title - Variable in class net.voidnote.CreateOptions: Optional note title (stored encrypted).
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.
toString() - Method in record class net.voidnote.CreateResult: Returns a string representation of this record class.
toString() - Method in record class net.voidnote.ReadResult: Returns a string representation of this record class.
ttlMinutes - Variable in class net.voidnote.CreateOptions: Expire after this many minutes.
ttlSeconds - Variable in class net.voidnote.StreamOptions: Stream lifetime in seconds.

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.

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

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.
withMaxViews(int) - Method in class net.voidnote.CreateOptions
withTitle(String) - Method in class net.voidnote.CreateOptions
withTitle(String) - Method in class net.voidnote.StreamOptions
withTtl(int) - Method in class net.voidnote.StreamOptions
withTtlMinutes(int) - Method in class net.voidnote.CreateOptions
write(String) - Method in class net.voidnote.StreamHandle: Encrypts content client-side and pushes it to the stream.