Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "invites"

Index

Functions

accept

  • accept(inviteId: string): Promise<string>
  • Accept invite by thread id.

    Textile.invites.accept(threadId);

    Parameters

    • inviteId: string

    Returns Promise<string>

acceptExternal

  • acceptExternal(id_: string, key: string): Promise<string>
  • Accept an external invite.

    Textile.invites.acceptExternal(id, key);

    Parameters

    • id_: string
    • key: string

    Returns Promise<string>

add

  • add(threadId: string, address: string): Promise<void>
  • Add a new Thread invite by invitee address.

    Textile.invites.add(threadId, address);

    Parameters

    • threadId: string
    • address: string

    Returns Promise<void>

addExternal

  • addExternal(threadId: string): Promise<IExternalInvite>
  • Add an external Thread invite, returning a sharable object.

    Textile.invites.addExternal(threadId);

    Parameters

    • threadId: string

    Returns Promise<IExternalInvite>

ignore

  • ignore(inviteId: string): Promise<void>
  • Ignore invite by thread id.

    Textile.invites.ignore(threadId);

    Parameters

    • inviteId: string

    Returns Promise<void>

list

  • list(): Promise<IInviteViewList>
  • List all pending thread invites.

    Textile.invites.list();

    Returns Promise<IInviteViewList>