Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Invites

Invites is an API module for managing thread invites

extends

API

Hierarchy

  • API
    • Invites

Index

Constructors

Methods

Constructors

constructor

Methods

accept

  • accept(invite: string, key?: undefined | string): Promise<Block>

  • Accept an invite to a thread

    Parameters

    • invite: string

      Invite ID

    • Optional key: undefined | string

      Key for an external invite

    Returns Promise<Block>

add

  • add(thread: string, address: string): Promise<boolean>

  • Adds a peer-to-peer invite to a thread

    Parameters

    • thread: string

      Thread ID (can also use ‘default’)

    • address: string

      Account Address (omit to create an external invite)

    Returns Promise<boolean>

    Whether the operation was successfull

addExternal

  • Adds a external invite to a thread

    Parameters

    • thread: string

      Thread ID (can also use ‘default’)

    Returns Promise<ExternalInvite>

    An external invite object

ignore

  • ignore(id: string): Promise<boolean>

  • Ignore a direct invite to a thread

    Parameters

    • id: string

      ID of the invite

    Returns Promise<boolean>

    Whether the operation was successfull

list