Class IdentityUser

Represents the IdentityUser class providing methods to interact with user data.

Hierarchy

IdentityUser

Index

Constructors

Accessors

address bio data name pfp primaryWallet secondaryWallets username

Methods

addWallet removeWallet update

Constructors

constructor

new IdentityUser(_identity, _user): IdentityUser
Constructs a new instance of the IdentityUser class.
Parameters
- _identity: IdentityClient
  
  The IdentityClient instance.
- _user: User
  
  The underlying User data.
Returns IdentityUser
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:241

Accessors

address

get address(): PublicKey
Gets the user's account address.

Returns PublicKey
The user's account address.
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:246

bio

get bio(): string
Gets the user's bio.

Returns string
The user's bio.
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:266

data

get data(): User
Gets the raw User data.

Returns User
The raw User data.
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:251

name

get name(): string
Gets the user's name.

Returns string
The user's name.
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:261

pfp

get pfp(): string
Gets the user's profile picture URL (pfp).

Returns string
The user's profile picture URL (pfp).
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:271

primaryWallet

get primaryWallet(): PublicKey
Gets the user's primary wallet.

Returns PublicKey
The user's primary wallet.
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:276

secondaryWallets

get secondaryWallets(): PublicKey[]
Gets the user's secondary wallets.

Returns PublicKey[]
The user's secondary wallets.
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:281

username

get username(): string
Gets the user's username.

Returns string
The user's username.
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:256

Methods

addWallet

addWallet(wallet, confirmOptions?): Promise<ConfirmedContext>
Adds a new wallet to the user's secondary wallets.
Parameters
- wallet: KeypairLike
  
  The wallet to be added.
- Optional confirmOptions: ConfirmOptions
  
  The confirmation options for the transaction.
Returns Promise<ConfirmedContext>
A promise that resolves with the transaction context.
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:288

removeWallet

removeWallet(wallet, confirmOptions?): Promise<ConfirmedContext>
Removes a wallet from the user's secondary wallets.
Parameters
- wallet: PublicKey
  
  The wallet to be removed.
- Optional confirmOptions: ConfirmOptions
  
  The confirmation options for the transaction.
Returns Promise<ConfirmedContext>
A promise that resolves with the transaction context.
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:295

update

update(args, confirmOptions?): Promise<ConfirmedContext>
Updates the user's information.
Parameters
- args: UpdateUserArgs
  
  The arguments for updating the user's information.
- Optional confirmOptions: ConfirmOptions
  
  The confirmation options for the transaction.
Returns Promise<ConfirmedContext>
A promise that resolves with the transaction context.
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:302

Generated using TypeDoc