RevokeSponsorshipOperation | @pinetwork-js/nodepi

Structure representing a Stellar Revoke Sponsorship Operation.

Hierarchy

Operation<Horizon.OperationResponseType.revokeSponsorship, Horizon.OperationResponseTypeI.revokeSponsorship>
- RevokeSponsorshipOperation

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RevokeSponsorshipOperation(client: Client, data: RevokeSponsorshipOperationRecord): RevokeSponsorshipOperation

Overrides Operation.constructor
- Defined in src/structures/ressources/stellar/operations/RevokeSponsorshipOperation.ts:62
Parameters
- client: Client
- data: RevokeSponsorshipOperationRecord
Returns RevokeSponsorshipOperation

Properties

Optional accountId

accountId: string

The id of the account which is no longer sponsored.

Optional claimableBalanceId

claimableBalanceId: string

The id of the claimable balance which is no longer sponsored.

Readonly client

client: Client

createdAt

createdAt: Date

The operation's creation date.

createdTimestamp

createdTimestamp: number

The operation's creation timestamp.

Optional dataAccountId

dataAccountId: string

The id of the account whose data entry is no longer sponsored.

Optional dataName

dataName: string

The name of the data entry which is no longer sponsored.

id

id: string

The id of the operation.

Optional offerId

offerId: string

The id of the offer which is no longer sponsored.

pagingToken

pagingToken: string

A cursor value for use in pagination.

Optional signerAccountId

signerAccountId: string

The account id of the signer which is no longer sponsored.

Optional signerType

signerType: string

The type of the signer which is no longer sponsored.

sourceAccountId

sourceAccountId: string

The account that originates the operation.

transactionHash

transactionHash: string

A unique id for the transaction the operation belongs to.

Optional trustlineAccountId

trustlineAccountId: string

The id of the account whose trustline is no longer sponsored.

Optional trustlineAsset

trustlineAsset: string

The asset id of the trustline which is no longer sponsored.

type

type: revokeSponsorship

The numeric type of the operation.

typeName

typeName: revokeSponsorship

The name of the operation type.

Methods

$patch

$patch(data: RevokeSponsorshipOperationRecord): void

Overrides Operation.$patch
- Defined in src/structures/ressources/stellar/operations/RevokeSponsorshipOperation.ts:68
Parameters
- data: RevokeSponsorshipOperationRecord
Returns void

getAccount

getAccount(forceUpdate?: boolean): Promise<undefined | Account>

- Defined in src/structures/ressources/stellar/operations/RevokeSponsorshipOperation.ts:88
Get the account which is no longer sponsored if there is one.

Parameters
- forceUpdate: boolean = false
  
  If set to true, it will not check in the cache and directly make a request to retrieve the account instead.
Returns Promise<undefined | Account>

The no longer sponsored account if there is one.

getClaimableBalance

getClaimableBalance(forceUpdate?: boolean): Promise<undefined | ClaimableBalance>

- Defined in src/structures/ressources/stellar/operations/RevokeSponsorshipOperation.ts:102
Get the claimable balance which is no longer sponsored if there is one.

Parameters
- forceUpdate: boolean = false
  
  If set to true, it will not check in the cache and directly make a request to retrieve the claimable balance instead.
Returns Promise<undefined | ClaimableBalance>

The no longer sponsored claimable balance if there is one.

getDataAccount

getDataAccount(forceUpdate?: boolean): Promise<undefined | Account>

- Defined in src/structures/ressources/stellar/operations/RevokeSponsorshipOperation.ts:116
Get the account whose data entry is no longer sponsored if there is one.

Parameters
- forceUpdate: boolean = false
  
  If set to true, it will not check in the cache and directly make a request to retrieve the data account instead.
Returns Promise<undefined | Account>

The no longer sponsored data entry account if there is one.

getDataAccountEntry

getDataAccountEntry(forceUpdate?: boolean): Promise<undefined | Data>

- Defined in src/structures/ressources/stellar/operations/RevokeSponsorshipOperation.ts:130
Get the data entry of the account which is no longer sponsored if there is one.

Parameters
- forceUpdate: boolean = false
  
  If set to true, it will not check in the cache and directly make a request to retrieve the data account entry instead.
Returns Promise<undefined | Data>

The no longer sponsored account data entry if there is one.

getEffects

getEffects(): Promise<EffectManager<Effect<EffectTypeNames, EffectType>>>

Inherited from Operation.getEffects
- Defined in src/structures/ressources/stellar/operations/Operation.ts:85
Get the effects of the operation.

Returns Promise<EffectManager<Effect<EffectTypeNames, EffectType>>>

A manager for the operation effects.

getOffer

getOffer(forceUpdate?: boolean): Promise<undefined | Offer>

- Defined in src/structures/ressources/stellar/operations/RevokeSponsorshipOperation.ts:146
Get the offer which is no longer sponsored if there is one.

Parameters
- forceUpdate: boolean = false
  
  If set to true, it will not check in the cache and directly make a request to retrieve the offer instead.
Returns Promise<undefined | Offer>

The no longer sponsored offer if there is one.

getSignerAccount

getSignerAccount(forceUpdate?: boolean): Promise<undefined | Account>

- Defined in src/structures/ressources/stellar/operations/RevokeSponsorshipOperation.ts:188
Get the account of the signer which is no longer sponsored if there is one.

Parameters
- forceUpdate: boolean = false
  
  If set to true, it will not check in the cache and directly make a request to retrieve the signer account instead.
Returns Promise<undefined | Account>

The no longer sponsored signer account if there is one.

getSourceAccount

getSourceAccount(forceUpdate?: boolean): Promise<Account>

Inherited from Operation.getSourceAccount
- Defined in src/structures/ressources/stellar/operations/Operation.ts:115
Get the source account of the operation.

Parameters
- forceUpdate: boolean = false
  
  If set to true, it will not check in the cache and directly make a request to retrieve the source account instead.
Returns Promise<Account>

The source account of the operation.

getTransaction

getTransaction(forceUpdate?: boolean): Promise<Transaction>

Inherited from Operation.getTransaction
- Defined in src/structures/ressources/stellar/operations/Operation.ts:105
Get the transaction the operation belongs to.

Parameters
- forceUpdate: boolean = false
  
  If set to true, it will not check in the cache and directly make a request to retrieve the transaction instead.
Returns Promise<Transaction>

The transaction of the operation.

getTrustlineAccount

getTrustlineAccount(forceUpdate?: boolean): Promise<undefined | Account>

- Defined in src/structures/ressources/stellar/operations/RevokeSponsorshipOperation.ts:160
Get the account whose trustline is no longer sponsored if there is one.

Parameters
- forceUpdate: boolean = false
  
  If set to true, it will not check in the cache and directly make a request to retrieve the trustline account instead.
Returns Promise<undefined | Account>

The no longer sponsored trustline account if there is one.

getTrustlineAsset

getTrustlineAsset(forceUpdate?: boolean): Promise<undefined | Asset>

- Defined in src/structures/ressources/stellar/operations/RevokeSponsorshipOperation.ts:174
Get the asset of the trustline which is no longer sponsored if there is one.

Parameters
- forceUpdate: boolean = false
  
  If set to true, it will not check in the cache and directly make a request to retrieve the trustline asset instead.
Returns Promise<undefined | Asset>

The no longer sponsored trustline asset if there is one.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

data: RevokeSponsorshipOperationRecord

Returns RevokeSponsorshipOperation

Properties

Optional accountId

Optional claimableBalanceId

Readonly client

createdAt

createdTimestamp

Optional dataAccountId

Optional dataName

id

Optional offerId

pagingToken

Optional signerAccountId

Optional signerType

sourceAccountId

transactionHash

Optional trustlineAccountId

Optional trustlineAsset

type

typeName

Methods

$patch

Parameters

data: RevokeSponsorshipOperationRecord

Returns void

getAccount

Parameters

forceUpdate: boolean = false

Returns Promise<undefined | Account>

getClaimableBalance

Parameters

forceUpdate: boolean = false

Returns Promise<undefined | ClaimableBalance>

getDataAccount

Parameters

forceUpdate: boolean = false

Returns Promise<undefined | Account>

getDataAccountEntry

Parameters

forceUpdate: boolean = false

Returns Promise<undefined | Data>

getEffects

Returns Promise<EffectManager<Effect<EffectTypeNames, EffectType>>>

getOffer

Parameters

forceUpdate: boolean = false

Returns Promise<undefined | Offer>

getSignerAccount

Parameters

forceUpdate: boolean = false

Returns Promise<undefined | Account>

getSourceAccount

Parameters

forceUpdate: boolean = false

Returns Promise<Account>

getTransaction

Parameters

forceUpdate: boolean = false

Returns Promise<Transaction>

getTrustlineAccount

Parameters

forceUpdate: boolean = false

Returns Promise<undefined | Account>

getTrustlineAsset

Parameters

forceUpdate: boolean = false

Returns Promise<undefined | Asset>