Class UserOutgoingApproval<T>

UserOutgoingApproval defines the rules for the approval of an outgoing transfer from a user.

Type Parameters

T extends NumberType

Hierarchy (view full)

BaseNumberTypeClass<UserOutgoingApproval<T>>
- UserOutgoingApproval
  - UserOutgoingApprovalWithDetails

Implements

iUserOutgoingApproval<T>

Index

Constructors

constructor

new UserOutgoingApproval<T>(msg): UserOutgoingApproval<T>
Type Parameters
- T extends NumberType
Parameters
- msg: iUserOutgoingApproval<T>
Returns UserOutgoingApproval<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/core/approvals.ts:174

Properties

`Optional`approvalCriteria

approvalCriteria?: OutgoingApprovalCriteria<T>

approvalId

approvalId: string

badgeIds

badgeIds: UintRangeArray<T>

`Optional`customData

customData?: string

initiatedByListId

initiatedByListId: string

ownershipTimes

ownershipTimes: UintRangeArray<T>

toListId

toListId: string

transferTimes

transferTimes: UintRangeArray<T>

`Optional`uri

uri?: string

Methods

clone

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

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

convert

convert<U>(convertFunction, options?): UserOutgoingApproval<U>
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 UserOutgoingApproval<U>
Overrides BaseNumberTypeClass.convert
- Defined in src/core/approvals.ts:187

equals

equals<U>(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<U>
Parameters
- other: undefined | null | CustomType<U>
- 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.UserOutgoingApproval
Returns proto.badges.UserOutgoingApproval
- Defined in src/core/approvals.ts:191

`Static`fromJson

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

`Static`fromJsonString

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

`Static`fromProto

fromProto<U>(item, convertFunction): UserOutgoingApproval<U>
Type Parameters
- U extends NumberType
Parameters
- item: proto.badges.UserOutgoingApproval
- convertFunction: ((item: NumberType) => U)
  - - (item): U
    - Parameters
      item: NumberType
      Returns U
Returns UserOutgoingApproval<U>
- Defined in src/core/approvals.ts:211