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)
     .withTitle("Deploy token");
 

Field Summary

Fields

Modifier and Type	Field	Description
final String	apiKey	Required: your API key (vn_...).
final Integer	maxViews	Destroy after this many reads.
final String	title	Optional note title (stored encrypted).
final Integer	ttlMinutes	Expire after this many minutes.

Method Summary

Modifier and Type	Method	Description
static CreateOptions	of(String apiKey)	Creates options with only the required API key.
CreateOptions	withMaxViews(int maxViews)
CreateOptions	withTitle(String title)
CreateOptions	withTtlMinutes(int ttlMinutes)

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

maxViews

public final Integer maxViews

Destroy after this many reads. null = server default.

ttlMinutes

public final Integer ttlMinutes

Expire after this many minutes. null = server default.

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)

withTtlMinutes

public CreateOptions withTtlMinutes(int ttlMinutes)