Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Profile

Profile is an API module for accessing public profile information

Hierarchy

  • API
    • Profile

Index

Constructors

Methods

Constructors

constructor

Methods

avatar

  • avatar(): Promise<string>
  • Get the local node's public profile avatar image hash

    Returns Promise<string>

    Node's public profile avatar image hash

get

  • get(): Promise<Peer>
  • Retrieve the local node's public profile peer information

    Returns Promise<Peer>

    The local node's peer information

name

  • name(): Promise<string>
  • Get the local node's public profile display name

    Returns Promise<string>

    Node's public profile display name

setAvatar

  • setAvatar(image: any): Promise<boolean>
  • Set the local node's public profile avatar image

    Parameters

    • image: any

      Image to use as new avatar. Can be any input type accepted by Files.add.

    Returns Promise<boolean>

    Whether the update was successful

setName

  • setName(name: string): Promise<boolean>
  • Set the local node's public profile display name

    Parameters

    • name: string

      Username string

    Returns Promise<boolean>

    Whether the update was successful