G-index

A B C D F G I J M O P Q R S T V

G

generateRandomSalt() - function in tbdex.sdk.protocol.models.Rfq.Companion

Generate random salt, used for salted hashes in RfqPrivateData

getAmount() - function in tbdex.sdk.protocol.models.CreateSelectedPayinMethod

Amount of currency Alice wants to pay in exchange for payout currency

getAmount() - function in tbdex.sdk.protocol.models.QuoteDetails

The amount of currency paid to the PFI or by the PFI excluding fees

getAmount() - function in tbdex.sdk.protocol.models.SelectedPayinMethod

Amount of currency Alice wants to pay in exchange for payout currency

getAvailable() - function in tbdex.sdk.protocol.models.BalanceData

The amount available to be transacted with

getCause() - function in kotlin.Throwable

getClaims() - function in tbdex.sdk.protocol.models.CreateRfqData

an array of hashes claims that fulfill the requirements declared in the referenced Offering

getClaims() - function in tbdex.sdk.protocol.models.RfqPrivateData

claims that fulfill the requirements declared in an Offering

getClaimsHash() - function in tbdex.sdk.protocol.models.RfqData

hash of claims that fulfill the requirements declared in the referenced Offering

getCreatedAt() - function in tbdex.sdk.protocol.models.MessageMetadata

ISO 8601 timestamp

getCreatedAt() - function in tbdex.sdk.protocol.models.ResourceMetadata

ISO 8601 timestamp

getCurrencyCode() - function in tbdex.sdk.protocol.models.BalanceData

ISO 3166 currency code string

getCurrencyCode() - function in tbdex.sdk.protocol.models.PaymentDetails

ISO 3166 currency code string.

getCurrencyCode() - function in tbdex.sdk.protocol.models.PaymentDetails

ISO 3166 currency code string.

getCurrencyCode() - function in tbdex.sdk.protocol.models.QuoteDetails

ISO 3166 currency code string

getData() - function in tbdex.sdk.protocol.models.Balance

The actual resource content.

getData() - function in tbdex.sdk.protocol.models.Close

The actual message content.

getData() - function in tbdex.sdk.protocol.models.Message

getData() - function in tbdex.sdk.protocol.models.Offering

The actual resource content.

getData() - function in tbdex.sdk.protocol.models.Order

The actual message content.

getData() - function in tbdex.sdk.protocol.models.OrderStatus

The actual message content.

getData() - function in tbdex.sdk.protocol.models.Quote

The actual message content.

getData() - function in tbdex.sdk.protocol.models.Resource

getData() - function in tbdex.sdk.protocol.models.Rfq

The actual message content.

getDescription() - function in tbdex.sdk.protocol.models.OfferingData

Brief description of what is being offered

getDescription() - function in tbdex.sdk.protocol.models.PaymentMethod

Blurb containing helpful information about the payment method.

getDescription() - function in tbdex.sdk.protocol.models.PaymentMethod

Blurb containing helpful information about the payment method.

getEntries() - function in tbdex.sdk.protocol.models.MessageKind

An enum representing all possible Message kinds.

getEntries() - function in tbdex.sdk.protocol.models.ResourceKind

An enum representing all possible Resource kinds.

getErrors() - function in tbdex.sdk.protocol.ValidatorException

getEstimatedSettlementTime() - function in tbdex.sdk.protocol.models.PayoutMethod

Estimated time taken to settle an order.

getExchangeId() - function in tbdex.sdk.protocol.models.MessageMetadata

ID for an "exchange" of messages between Alice <-> PFI.

getExpiresAt() - function in tbdex.sdk.protocol.models.QuoteData

When this quote expires.

getExternalId() - function in tbdex.sdk.protocol.models.MessageMetadata

Arbitrary ID for the caller to associate with the message.

getFee() - function in tbdex.sdk.protocol.models.PaymentMethod

Fee charged to use this payment method.

getFee() - function in tbdex.sdk.protocol.models.PaymentMethod

Fee charged to use this payment method.

getFee() - function in tbdex.sdk.protocol.models.QuoteDetails

The amount paid in fees

getFrom() - function in tbdex.sdk.protocol.models.MessageMetadata

The sender's DID

getFrom() - function in tbdex.sdk.protocol.models.ResourceMetadata

The author's DID

getGroup() - function in tbdex.sdk.protocol.models.PaymentMethod

Value that can be used to group specific payment methods together e.g.

getGroup() - function in tbdex.sdk.protocol.models.PaymentMethod

Value that can be used to group specific payment methods together e.g.

getId() - function in tbdex.sdk.protocol.models.MessageMetadata

The message's ID

getId() - function in tbdex.sdk.protocol.models.ResourceMetadata

The resource's ID

getInstruction() - function in tbdex.sdk.protocol.models.PaymentInstruction

Instruction on how Alice can pay PFI or how Alice can be paid by the PFI

getJsonMapper() - function in tbdex.sdk.protocol.serialization.Json

The Jackson object mapper instance, shared across the lib.

getKind() - function in tbdex.sdk.protocol.models.CreateSelectedPaymentMethod

type of payment method

getKind() - function in tbdex.sdk.protocol.models.CreateSelectedPaymentMethod

type of payment method

getKind() - function in tbdex.sdk.protocol.models.MessageMetadata

e.g.

getKind() - function in tbdex.sdk.protocol.models.PaymentMethod

Unique string identifying a single kind of payment method.

getKind() - function in tbdex.sdk.protocol.models.PaymentMethod

Unique string identifying a single kind of payment method.

getKind() - function in tbdex.sdk.protocol.models.ResourceMetadata

the data property's type.

getKind() - function in tbdex.sdk.protocol.models.SelectedPaymentMethod

type of payment method

getKind() - function in tbdex.sdk.protocol.models.SelectedPaymentMethod

type of payment method

getLink() - function in tbdex.sdk.protocol.models.PaymentInstruction

Link to allow Alice to pay PFI, or be paid by the PFI

getLocalizedMessage() - function in kotlin.Throwable

getMax() - function in tbdex.sdk.protocol.models.PaymentDetails

Minimum amount of currency that the offer is valid for.

getMax() - function in tbdex.sdk.protocol.models.PaymentDetails

Minimum amount of currency that the offer is valid for.

getMax() - function in tbdex.sdk.protocol.models.PaymentMethod

Maximum amount allowed when using this payment method.

getMax() - function in tbdex.sdk.protocol.models.PaymentMethod

Maximum amount allowed when using this payment method.

getMessage() - function in tbdex.sdk.protocol.ValidatorException

getMetadata() - function in tbdex.sdk.protocol.models.Balance

An object containing fields about the resource

getMetadata() - function in tbdex.sdk.protocol.models.Close

An object containing fields about the message

getMetadata() - function in tbdex.sdk.protocol.models.Message

getMetadata() - function in tbdex.sdk.protocol.models.Offering

An object containing fields about the resource

getMetadata() - function in tbdex.sdk.protocol.models.Order

An object containing fields about the message

getMetadata() - function in tbdex.sdk.protocol.models.OrderStatus

An object containing fields about the message

getMetadata() - function in tbdex.sdk.protocol.models.Quote

An object containing fields about the message

getMetadata() - function in tbdex.sdk.protocol.models.Resource

getMetadata() - function in tbdex.sdk.protocol.models.Rfq

An object containing fields about the message

getMethods() - function in tbdex.sdk.protocol.models.PaymentDetails

A list of payment methods to select from.

getMethods() - function in tbdex.sdk.protocol.models.PaymentDetails

A list of payment methods to select from.

getMin() - function in tbdex.sdk.protocol.models.PaymentDetails

Minimum amount of currency that the offer is valid for.

getMin() - function in tbdex.sdk.protocol.models.PaymentDetails

Minimum amount of currency that the offer is valid for.

getMin() - function in tbdex.sdk.protocol.models.PaymentMethod

Minimum amount required to use this payment method.

getMin() - function in tbdex.sdk.protocol.models.PaymentMethod

Minimum amount required to use this payment method.

getName() - function in kotlin.MessageKind

getName() - function in kotlin.ResourceKind

getName() - function in tbdex.sdk.protocol.models.PaymentMethod

Payment Method name.

getName() - function in tbdex.sdk.protocol.models.PaymentMethod

Payment Method name.

getOfferingId() - function in tbdex.sdk.protocol.models.CreateRfqData

Offering which Alice would like to get a quote for

getOfferingId() - function in tbdex.sdk.protocol.models.RfqData

Offering which Alice would like to get a quote for

getOrderStatus() - function in tbdex.sdk.protocol.models.OrderStatusData

Current status of Order that's being executed

getOrdinal() - function in kotlin.MessageKind

getOrdinal() - function in kotlin.ResourceKind

getPayin() - function in tbdex.sdk.protocol.models.CreateRfqData

selected payin amount, method, and cleartext payment details

getPayin() - function in tbdex.sdk.protocol.models.OfferingData

Details and options associated to the payin currency

getPayin() - function in tbdex.sdk.protocol.models.QuoteData

the amount of payin currency that the PFI will receive

getPayin() - function in tbdex.sdk.protocol.models.RfqData

selected payin amount, method, and hashed details

getPayin() - function in tbdex.sdk.protocol.models.RfqPrivateData

A container for the cleartext payin.paymentDetails

getPaymentDetails() - function in tbdex.sdk.protocol.models.CreateSelectedPaymentMethod

An object containing the properties defined in an Offering's requiredPaymentDetails json schema

getPaymentDetails() - function in tbdex.sdk.protocol.models.CreateSelectedPaymentMethod

An object containing the properties defined in an Offering's requiredPaymentDetails json schema

getPaymentDetails() - function in tbdex.sdk.protocol.models.PrivatePaymentDetails

An object containing the properties defined in the respective Offering's requiredPaymentDetails json schema.

getPaymentDetailsHash() - function in tbdex.sdk.protocol.models.SelectedPaymentMethod

getPaymentInstruction() - function in tbdex.sdk.protocol.models.QuoteDetails

Object that describes how to pay the PFI and how to get paid by the PFI (e.g.

getPayout() - function in tbdex.sdk.protocol.models.CreateRfqData

selected payout method, and cleartext payment details

getPayout() - function in tbdex.sdk.protocol.models.OfferingData

Details and options associated to the payout currency

getPayout() - function in tbdex.sdk.protocol.models.QuoteData

the amount of payout currency that Alice will receive

getPayout() - function in tbdex.sdk.protocol.models.RfqData

selected payout method, and hashed details

getPayout() - function in tbdex.sdk.protocol.models.RfqPrivateData

A container for the cleartext payout.paymentDetails

getPayoutUnitsPerPayinUnit() - function in tbdex.sdk.protocol.models.OfferingData

Number of payout units alice would get for 1 payin unit

getPrivateData() - function in tbdex.sdk.protocol.models.Rfq

getProtocol() - function in tbdex.sdk.protocol.models.MessageMetadata

Version of the protocol in use (x.x format).

getProtocol() - function in tbdex.sdk.protocol.models.ResourceMetadata

Version of the protocol in use (x.x format).

getReason() - function in tbdex.sdk.protocol.models.CloseData

an explanation of why the exchange is being closed/completed

getRequiredClaims() - function in tbdex.sdk.protocol.models.OfferingData

Claim(s) required when submitting an RFQ for this offering

getRequiredPaymentDetails() - function in tbdex.sdk.protocol.models.PaymentMethod

A JSON Schema containing the fields that need to be collected in the RFQ's selected payment methods in order to use this payment method.

getRequiredPaymentDetails() - function in tbdex.sdk.protocol.models.PaymentMethod

A JSON Schema containing the fields that need to be collected in the RFQ's selected payment methods in order to use this payment method.

getRequiredPaymentDetailsSchema() - function in tbdex.sdk.protocol.models.PaymentMethod

Parse the contents of requiredPaymentDetails into a JsonSchema that can do validation.

getRequiredPaymentDetailsSchema() - function in tbdex.sdk.protocol.models.PaymentMethod

Parse the contents of requiredPaymentDetails into a JsonSchema that can do validation.

getSalt() - function in tbdex.sdk.protocol.models.RfqPrivateData

Randomly generated cryptographic salt used to hash privateData fields

getSignature() - function in tbdex.sdk.protocol.models.Balance