Class IdentityProfile

Represents the IdentityProfile class providing methods to interact with user profiles.

Hierarchy

  • IdentityProfile

Constructors

constructor

Accessors

address data profileIdentity user

Methods

add entity get identity project remove set

Constructors

constructor

  • Constructs a new instance of the IdentityProfile class.

    Parameters

    Returns IdentityProfile

Accessors

address

  • get address(): PublicKey

  • Gets the profile's account address.

    Returns PublicKey

    The profile's account address.

data

  • get data(): Map<string, string | string[] | IdentityProfileEntity<any>>

  • Gets the profile data.

    Returns Map<string, string | string[] | IdentityProfileEntity<any>>

    The profile data.

profileIdentity

  • get profileIdentity(): ProfileIdentity

  • Gets the profile identity.

    Returns ProfileIdentity

    The profile identity.

user

  • get user(): PublicKey

  • Gets the user's account address associated with the profile.

    Returns PublicKey

    The user's account address associated with the profile.

Methods

add

  • Adds data to the profile.

    Parameters

    • label: string

      The label for the data.

    • value: string | string[]

      The value of the data.

    • Optional confirmOptions: ConfirmOptions

      The confirmation options for the transaction.

    Returns Promise<ConfirmedContext>

    A promise that resolves with the transaction context.

entity

  • Gets the entity data associated with the specified label.

    Type Parameters

    Parameters

    • label: string

      The label for which to get the entity data.

    Returns IdentityProfileEntity<E>

    The entity data associated with the label.

get

  • Gets the data associated with the specified label.

    Type Parameters

    Parameters

    • label: string

      The label for which to get the data.

    Returns E

    The data associated with the label.

identity

  • Gets the IdentityClient instance associated with the profile.

    Returns IdentityClient

    The IdentityClient instance.

project

  • Gets the project associated with the profile.

    Returns HoneycombProject

    The project associated with the profile.

remove

  • Removes data from the profile.

    Parameters

    • label: string

      The label for the data to be removed.

    • Optional confirmOptions: ConfirmOptions

      The confirmation options for the transaction.

    Returns Promise<ConfirmedContext>

    A promise that resolves with the transaction context.

set

  • Sets data for the profile.

    Parameters

    • label: string

      The label for the data.

    • value: string | string[]

      The new value of the data.

    • Optional confirmOptions: ConfirmOptions

      The confirmation options for the transaction.

    Returns Promise<ConfirmedContext>

    A promise that resolves with the transaction context.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc