Skip to content

Class: SIWBBRequestDoc<T>

T extends NumberType

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2105

Extends

Type Parameters

T

T extends NumberType

Implements

Constructors

Constructor

new SIWBBRequestDoc<T>(data): SIWBBRequestDoc<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2124

Parameters

data

iSIWBBRequestDoc<T>

Returns

SIWBBRequestDoc<T>

Overrides

BaseNumberTypeClass.constructor

Properties

_docId

_docId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2106

A unique stringified document ID

Implementation of

iSIWBBRequestDoc._docId

_id?

optional _id?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2107

A unique document ID (Mongo DB ObjectID)

Implementation of

iSIWBBRequestDoc._id

address

address: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2119

The native address of the signer

Implementation of

iSIWBBRequestDoc.address

bitbadgesAddress

bitbadgesAddress: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2113

The BitBadges address of the signer

Implementation of

iSIWBBRequestDoc.bitbadgesAddress

chain

chain: SupportedChain

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2120

The native chain for the user

Implementation of

iSIWBBRequestDoc.chain

clientId

clientId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2109

The client ID of the app that requested the signature

Implementation of

iSIWBBRequestDoc.clientId

code

code: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2108

The actual code itself

Implementation of

iSIWBBRequestDoc.code

codeChallenge?

optional codeChallenge?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2121

The code challenge for the SIWBB request (if used with PKCE).

Implementation of

iSIWBBRequestDoc.codeChallenge

codeChallengeMethod?

optional codeChallengeMethod?: "S256" | "plain"

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2122

The code challenge method for the SIWBB request (if used with PKCE).

Implementation of

iSIWBBRequestDoc.codeChallengeMethod

createdAt

createdAt: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2114

The timestamp of when the signature was created (milliseconds since epoch)

Implementation of

iSIWBBRequestDoc.createdAt

deletedAt?

optional deletedAt?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2117

If deleted, we still store temporarily for a period of time. We use a deletedAt timestamp to determine when to delete.

Implementation of

iSIWBBRequestDoc.deletedAt

description?

optional description?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2111

Implementation of

iSIWBBRequestDoc.description

expiresAt

expiresAt: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2116

Implementation of

iSIWBBRequestDoc.expiresAt

image?

optional image?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2112

Implementation of

iSIWBBRequestDoc.image

name?

optional name?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2110

Implementation of

iSIWBBRequestDoc.name

redirectUri?

optional redirectUri?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2118

The redirect URI of the app

Implementation of

iSIWBBRequestDoc.redirectUri

scopes

scopes: OAuthScopeDetails[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2115

Implementation of

iSIWBBRequestDoc.scopes

Methods

clone()

clone(): SIWBBRequestDoc

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:151

Deep copies the object and returns a new instance.

Returns

SIWBBRequestDoc

Inherited from

BaseNumberTypeClass.clone

convert()

convert<U>(convertFunction, options?): SIWBBRequestDoc<U>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2149

Converts the object to a different NumberType equivalent.

Type Parameters

U

U extends NumberType

Parameters

convertFunction

(item) => U

options?

ConvertOptions

Returns

SIWBBRequestDoc<U>

Overrides

BaseNumberTypeClass.convert

equals()

equals<U>(other, normalizeNumberTypes?): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:147

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

U extends CustomType<U>

Parameters

other

CustomType<U> | null | undefined

normalizeNumberTypes?

boolean

Returns

boolean

Inherited from

BaseNumberTypeClass.equals

getNumberFieldNames()

getNumberFieldNames(): string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:2145

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns

string[]

Overrides

BaseNumberTypeClass.getNumberFieldNames

hasNumberFields()

hasNumberFields(): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:161

Checks if the object has number fields.

Returns

boolean

Inherited from

BaseNumberTypeClass.hasNumberFields

toJson()

toJson(): JsonObject

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:139

Converts the object to a JSON object with all primitive types.

Returns

JsonObject

Inherited from

BaseNumberTypeClass.toJson

toJsonString()

toJsonString(): string

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:143

Converts the object to a JSON string.

Returns

string

Inherited from

BaseNumberTypeClass.toJsonString

Edit this page on GitHub