Class UserOutgoingApprovalPermission<T>

UserOutgoingApprovalPermission represents the permissions of a user and whether they can update their approved outgoing transfers.

Constructors

constructor

new UserOutgoingApprovalPermission<T>(msg): UserOutgoingApprovalPermission<T>
Type Parameters
- T extends NumberType
Parameters
- msg: iUserOutgoingApprovalPermission<T>
Returns UserOutgoingApprovalPermission<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/core/permissions.ts:139

Properties

approvalId

approvalId: string

The approval ID of the approved outgoing transfers. Can use "All" to represent all IDs, "!approvalId" to represent all IDs except approvalId, or "approvalId" to represent only approvalId.

badgeIds

badgeIds: UintRangeArray<T>

The badge IDs of the approved outgoing transfers.

initiatedByListId

initiatedByListId: string

The list ID of the initiatedBy addresses of the approved outgoing transfers.

ownershipTimes

ownershipTimes: UintRangeArray<T>

The owned times of the approved outgoing transfers.

permanentlyForbiddenTimes

permanentlyForbiddenTimes: UintRangeArray<T>

The forbidden times of the approved outgoing transfers.

permanentlyPermittedTimes

permanentlyPermittedTimes: UintRangeArray<T>

The permitted times of the approved outgoing transfers.

toListId

toListId: string

The list ID of the to addresses of the approved outgoing transfers.

transferTimes

transferTimes: UintRangeArray<T>

The transfer times of the approved outgoing transfers.

Methods

castToCollectionApprovalPermission

castToCollectionApprovalPermission(address): CollectionApprovalPermission<T>
Parameters
- address: string
Returns CollectionApprovalPermission<T>
- Defined in src/core/permissions.ts:191

clone

clone(): UserOutgoingApprovalPermission<T>
Deep copies the object and returns a new instance.

Returns UserOutgoingApprovalPermission<T>
Inherited from BaseNumberTypeClass.clone
- Defined in src/common/base.ts:121

convert

convert(convertFunction, options?): UserOutgoingApprovalPermission
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optionaloptions: ConvertOptions
Returns UserOutgoingApprovalPermission
Overrides BaseNumberTypeClass.convert
- Defined in src/core/permissions.ts:151

equals

equals(other, normalizeNumberTypes?): boolean
Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").
Type Parameters
- U extends CustomType
Parameters
- other: undefined | null | CustomType
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Inherited from BaseNumberTypeClass.equals
- Defined in src/common/base.ts:117

getNumberFieldNames

getNumberFieldNames(): string[]
Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns string[]
Inherited from BaseNumberTypeClass.getNumberFieldNames
- Defined in src/common/base.ts:127

hasNumberFields

hasNumberFields(): boolean
Checks if the object has number fields.

Returns boolean
Inherited from BaseNumberTypeClass.hasNumberFields
- Defined in src/common/base.ts:131

toJson

toJson(): JsonObject
Converts the object to a JSON object with all primitive types.

Returns JsonObject
Inherited from BaseNumberTypeClass.toJson
- Defined in src/common/base.ts:109

toJsonString

toJsonString(): string
Converts the object to a JSON string.

Returns string
Inherited from BaseNumberTypeClass.toJsonString
- Defined in src/common/base.ts:113

toProto

toProto(): proto.badges.UserOutgoingApprovalPermission
Returns proto.badges.UserOutgoingApprovalPermission
- Defined in src/core/permissions.ts:155

`Static`check

check(details, permissions, time?): null | Error
Checks if a certain approvals can be updated based on the permissions.
Type Parameters
- U extends NumberType
Parameters
- details: {
 amountTrackerIdList: AddressList;
 approvalIdList: AddressList;
 badgeIds: UintRangeArray;
 challengeTrackerIdList: AddressList;
 fromList: AddressList;
 initiatedByList: AddressList;
 ownershipTimes: UintRangeArray;
 toList: AddressList;
 transferTimes: UintRangeArray;
 }[]
- permissions: UserOutgoingApprovalPermissionWithDetails[]
- Optionaltime: U
Returns null | Error
- Defined in src/core/permissions.ts:219

`Static`fromJson

fromJson(jsonValue, convertFunction, options?): UserOutgoingApprovalPermission
Type Parameters
- U extends NumberType
Parameters
- jsonValue: JsonValue
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optionaloptions: Partial<JsonReadOptions>
Returns UserOutgoingApprovalPermission
- Defined in src/core/permissions.ts:159

`Static`fromJsonString

fromJsonString(jsonString, convertFunction, options?): UserOutgoingApprovalPermission
Type Parameters
- U extends NumberType
Parameters
- jsonString: string
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optionaloptions: Partial<JsonReadOptions>
Returns UserOutgoingApprovalPermission
- Defined in src/core/permissions.ts:167

`Static`fromProto

fromProto(protoMsg, convertFunction): UserOutgoingApprovalPermission
Type Parameters
- U extends NumberType
Parameters
- protoMsg: proto.badges.UserOutgoingApprovalPermission
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
Returns UserOutgoingApprovalPermission
- Defined in src/core/permissions.ts:175

`Static`validateUpdate

validateUpdate(permissions, newPermission): null | Error
Validates the update of the user outgoing approval permissions from old to new. No permanently frozen times can be edited.
Type Parameters
- U extends NumberType
Parameters
- permissions: UserOutgoingApprovalPermissionWithDetails[]
- newPermission: UserOutgoingApprovalPermissionWithDetails[]
Returns null | Error
- Defined in src/core/permissions.ts:202

Class UserOutgoingApprovalPermission<T>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UserOutgoingApprovalPermission<T>

Properties

approvalId

badgeIds

initiatedByListId

ownershipTimes

permanentlyForbiddenTimes

permanentlyPermittedTimes

toListId

transferTimes

Methods

castToCollectionApprovalPermission

Parameters

Returns CollectionApprovalPermission<T>

clone

Returns UserOutgoingApprovalPermission<T>

convert

Type Parameters

Parameters

Parameters

Returns U

Returns UserOutgoingApprovalPermission<U>

equals

Type Parameters

Parameters

Returns boolean

getNumberFieldNames

Returns string[]

hasNumberFields

Returns boolean

toJson

Returns JsonObject

toJsonString

Returns string

toProto

Returns proto.badges.UserOutgoingApprovalPermission

Staticcheck

Type Parameters

Parameters

Returns null | Error

StaticfromJson

Type Parameters

Parameters

Parameters

Returns U

Returns UserOutgoingApprovalPermission<U>

StaticfromJsonString

Type Parameters

Parameters

Parameters

Returns U

Returns UserOutgoingApprovalPermission<U>

StaticfromProto

Type Parameters

Parameters

Parameters

Returns U

Returns UserOutgoingApprovalPermission<U>

StaticvalidateUpdate

Type Parameters

Parameters

Returns null | Error

Settings

On This Page

`Static`check

`Static`fromJson

`Static`fromJsonString

`Static`fromProto

`Static`validateUpdate