Class GenericVerifyAssetsSuccessResponse

Hierarchy (view full)

CustomTypeClass<GenericVerifyAssetsSuccessResponse>
- GenericVerifyAssetsSuccessResponse

Implements

iGenericVerifyAssetsSuccessResponse

Index

Constructors

Properties

errorMessage? success

Methods

clone convert equals getNumberFieldNames toJson toJsonString

Constructors

constructor

new GenericVerifyAssetsSuccessResponse(data): GenericVerifyAssetsSuccessResponse
Parameters
- data: iGenericVerifyAssetsSuccessResponse
Returns GenericVerifyAssetsSuccessResponse
Overrides CustomTypeClass.constructor
- Defined in src/api-indexer/requests/requests.ts:1379

Properties

`Optional` errorMessage

errorMessage?: string

success

success: boolean

Success response of the verification check. Use this to determine if the verification was successful.

Status code will be 200 both if the user meets or does not meet requirements, so you must check this success field to determine the result.

Methods

clone

clone(): GenericVerifyAssetsSuccessResponse
Deep copies the object and returns a new instance.

Returns GenericVerifyAssetsSuccessResponse
Inherited from CustomTypeClass.clone
- Defined in src/common/base.ts:58

convert

convert<U>(_convertFunction?): CustomType<any>
Type Parameters
- U extends NumberType
Parameters
- Optional _convertFunction: ((val) => U)
  - - (val): U
    - Parameters
      val: NumberType
      Returns U
Returns CustomType<any>
Deprecated
This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.
Inherited from CustomTypeClass.convert
- Defined in src/common/base.ts:73

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>
- Optional normalizeNumberTypes: boolean
Returns boolean
Inherited from CustomTypeClass.equals
- Defined in src/common/base.ts:54

getNumberFieldNames

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

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

toJson

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

Returns JsonObject
Inherited from CustomTypeClass.toJson
- Defined in src/common/base.ts:46

toJsonString

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

Returns string
Inherited from CustomTypeClass.toJsonString
- Defined in src/common/base.ts:50