Class BasicUserAccountSubscriber

Basic implementation of UserAccountSubscriber. It will only take in UserAccount data during initialization and will not fetch or subscribe to updates.

Hierarchy

BasicUserAccountSubscriber
- OneShotUserAccountSubscriber

Implements

UserAccountSubscriber

Index

Constructors

Properties

callbackId? errorCallbackId? eventEmitter isSubscribed user userAccountPublicKey

Methods

addToAccountLoader assertIsSubscribed doesAccountExist fetch getUserAccountAndSlot subscribe unsubscribe updateData

Constructors

constructor

new BasicUserAccountSubscriber(userAccountPublicKey: PublicKey, data?: UserAccount, slot?: number): BasicUserAccountSubscriber
Parameters
- userAccountPublicKey: PublicKey
- Optional data: UserAccount
- Optional slot: number
Returns BasicUserAccountSubscriber
- Defined in sdk/src/accounts/basicUserAccountSubscriber.ts:21

Properties

`Optional` callbackId

callbackId?: string

`Optional` errorCallbackId

errorCallbackId?: string

eventEmitter

eventEmitter: StrictEventEmitter<EventEmitter<DefaultEventMap>, UserAccountEvents, UserAccountEvents, "addEventListener" | "removeEventListener", "on" | "addListener" | "removeListener" | "once" | "emit">

isSubscribed

isSubscribed: boolean

user

user: DataAndSlot<UserAccount>

userAccountPublicKey

userAccountPublicKey: PublicKey

Methods

addToAccountLoader

addToAccountLoader(): Promise<void>
Returns Promise<void>
- Defined in sdk/src/accounts/basicUserAccountSubscriber.ts:36

assertIsSubscribed

assertIsSubscribed(): void
Returns void
- Defined in sdk/src/accounts/basicUserAccountSubscriber.ts:46

doesAccountExist

doesAccountExist(): boolean
Returns boolean
- Defined in sdk/src/accounts/basicUserAccountSubscriber.ts:40

fetch

fetch(): Promise<void>
Returns Promise<void>
Implementation of UserAccountSubscriber.fetch
- Defined in sdk/src/accounts/basicUserAccountSubscriber.ts:38

getUserAccountAndSlot

getUserAccountAndSlot(): DataAndSlot<UserAccount>
Returns DataAndSlot<UserAccount>
Implementation of UserAccountSubscriber.getUserAccountAndSlot
- Defined in sdk/src/accounts/basicUserAccountSubscriber.ts:48

subscribe

subscribe(_userAccount?: UserAccount): Promise<boolean>
Parameters
- Optional _userAccount: UserAccount
Returns Promise<boolean>
Implementation of UserAccountSubscriber.subscribe
- Defined in sdk/src/accounts/basicUserAccountSubscriber.ts:32

unsubscribe

unsubscribe(): Promise<void>
Returns Promise<void>
Implementation of UserAccountSubscriber.unsubscribe
- Defined in sdk/src/accounts/basicUserAccountSubscriber.ts:44

updateData

updateData(userAccount: UserAccount, slot: number): void
Parameters
- userAccount: UserAccount
- slot: number
Returns void
Implementation of UserAccountSubscriber.updateData
- Defined in sdk/src/accounts/basicUserAccountSubscriber.ts:52

Generated using TypeDoc