Interface Restriction

Represents a restriction.

Restrictions forbid certain user operations in the wallet. Determine the restricted action based on the restriction name. Check the requiredActions field to determine the course of action for resolving the restrictions.

interface Restriction {
    activationTime?: string;
    dueDate?: string;
    id: string;
    lastChangedDate?: string;
    name: RestrictionName;
    requiredActions?: RestrictionAction[];
}

Properties

activationTime? dueDate? id lastChangedDate? name requiredActions?

Properties

Optional activationTime

activationTime?: string

Activation time of the restriction.

Format should be ISO 8601 in UTC. Represents RFC 3339, section 5.6 date-time.

Example

"2021-07-15T17:54:12Z"

Optional dueDate

dueDate?: string

Due date of the restriction.

Format should be ISO 8601 in UTC. Represents RFC 3339, section 5.6 date-time.

Example

"2021-07-15T17:54:12Z"

id

id: string

Restriction id.

Optional lastChangedDate

lastChangedDate?: string

Date of the last change in the restriction. Represents ISO-3166 Alpha 2 country code.

Example

"GB"

name

name: RestrictionName

The name of the restriction.

Optional requiredActions

requiredActions?: RestrictionAction[]

Actions to be completed in order to resolve the restriction.

Settings

Member Visibility

Theme

On This Page

activationTimedueDateidlastChangedDatenamerequiredActions