Interface UserRestriction

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 UserRestriction {
    activationTime?: string;
    dueDate?: string;
    id: string;
    lastChangedDate?: string;
    name: UserRestrictionName;
    requiredActions?: RestrictionAction[];
}

Index

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. Format must be ISO 8601 in UTC. Represents an RFC 3339, section 5.6 date-time.

Example

"2024-05-08T14:43:33Z"

name

name: UserRestrictionName

The name of the user restriction.

`Optional`requiredActions

requiredActions?: RestrictionAction[]

Actions to be completed in order to resolve the restriction.

Interface UserRestriction

Index

Properties

Properties

`Optional`activationTime

Example

`Optional`dueDate

Example

id

`Optional`lastChangedDate

Example

name

`Optional`requiredActions

Settings

On This Page

Interface UserRestriction

Index

Properties

Properties

OptionalactivationTime

Example

OptionaldueDate

Example

id

OptionallastChangedDate

Example

name

OptionalrequiredActions

Settings

On This Page

`Optional`activationTime

`Optional`dueDate

`Optional`lastChangedDate

`Optional`requiredActions