Package net.voidnote

Class CreateOptions

java.lang.Object

net.voidnote.CreateOptions

public final class CreateOptions
extends Object

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

 CreateOptions opts = CreateOptions.of("vn_...")
     .withMaxViews(1)
     .withExpiresIn(6)      // hours: 1, 6, 24, 72, 168, 720
     .withNoteType("pipe")  // "secure" (default) or "pipe"
     .withTitle("Deploy token");
 

Field Summary

Fields

Modifier and Type	Field	Description
final String	apiKey	Required: your API key (vn_...).
final Integer	expiresIn	Expiry in hours.
final Integer	maxViews	Destroy after this many reads (1–100).
final String	noteType	Note type: "secure" (default, encrypted static note) or "pipe" (streaming append mode).
final String	title	Optional note title (stored in plaintext).

Method Summary

Modifier and Type	Method	Description
static CreateOptions	of(String apiKey)	Creates options with only the required API key.
CreateOptions	withExpiresIn(int hours)	Set expiry in hours.
CreateOptions	withMaxViews(int maxViews)
CreateOptions	withNoteType(String noteType)	Set note type: "secure" or "pipe".
CreateOptions	withTitle(String title)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

apiKey

public final String apiKey

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

title

public final String title

Optional note title (stored in plaintext).

maxViews

public final Integer maxViews

Destroy after this many reads (1–100). null = server default (1).

expiresIn

public final Integer expiresIn

Expiry in hours. Must be one of: 1, 6, 24, 72, 168, 720. null = server default (24h).

noteType

public final String noteType

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

Method Details

of

public static CreateOptions of(String apiKey)

Creates options with only the required API key.

withTitle

public CreateOptions withTitle(String title)

withMaxViews

public CreateOptions withMaxViews(int maxViews)

withExpiresIn

public CreateOptions withExpiresIn(int hours)

Set expiry in hours. Must be one of: 1, 6, 24, 72, 168, 720.

Throws:

IllegalArgumentException - if the value is not in the allowed set.

withNoteType

public CreateOptions withNoteType(String noteType)

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

Throws:

IllegalArgumentException - if the value is not recognised.