Skip to main content

CapabilityIssueOptions

@iota/audit-trails API documentation

Class: CapabilityIssueOptions

Capability issuance options.

Remarks​

These fields configure restrictions on the issued capability object. Matching against the current caller and the on-chain timestamp happens whenever the capability is later presented for authorization, not at issue time.

Constructors​

Constructor​

new CapabilityIssueOptions(issued_to?, valid_from_ms?, valid_until_ms?): CapabilityIssueOptions

Creates capability issuance options.

Parameters​

issued_to?​

string | null

valid_from_ms?​

bigint | null

valid_until_ms?​

bigint | null

Returns​

CapabilityIssueOptions

Accessors​

issuedTo​

Get Signature​

get issuedTo(): string | undefined

Address that should own the issued capability. When null, the capability is transferred to the caller.

Returns​

string | undefined

Set Signature​

set issuedTo(value): void

Address that should own the issued capability. When null, the capability is transferred to the caller.

Parameters​
value​

string | null | undefined

Returns​

void

validFromMs​

Get Signature​

get validFromMs(): bigint | undefined

Earliest millisecond timestamp (since the Unix epoch) at which the capability becomes valid. When null, the capability is valid from its creation time.

Returns​

bigint | undefined

Set Signature​

set validFromMs(value): void

Earliest millisecond timestamp (since the Unix epoch) at which the capability becomes valid. When null, the capability is valid from its creation time.

Parameters​
value​

bigint | null | undefined

Returns​

void

validUntilMs​

Get Signature​

get validUntilMs(): bigint | undefined

Latest millisecond timestamp (since the Unix epoch) at which the capability is still valid. When null, the capability does not expire.

Returns​

bigint | undefined

Set Signature​

set validUntilMs(value): void

Latest millisecond timestamp (since the Unix epoch) at which the capability is still valid. When null, the capability does not expire.

Parameters​
value​

bigint | null | undefined

Returns​

void

Methods​

toJSON()​

toJSON(): Object

  • Return copy of self without private attributes.

Returns​

Object

toString()​

toString(): string

Return stringified version of self.

Returns​

string