legacyinvites

Documentation

Overview

Package legacyinvites supplies the follow-back sub protocol for new users. Translates to npm:ssb-invite.

Index

• type CreateArguments
• type Service
  • func New(logger kitlog.Logger, r repo.Interface, self refs.FeedRef, nw ssb.Network, ...) (*Service, error)
  • func (s *Service) Authorize(to refs.FeedRef) error
  • func (s *Service) Create(uses uint, note string) (*invite.Token, error)
  • func (s *Service) GuestHandler() muxrpc.Handler
  • func (s *Service) MasterPlugin() ssb.Plugin

Types

type CreateArguments

type CreateArguments struct {
	// how many times this invite should be useable
	Uses uint `json:"uses"`

	// a note to organize invites (also posted when used)
	Note string `json:"note,omitempty"`
}

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service holds all the utility functions for invite managment

func New

func New(
	logger kitlog.Logger,
	r repo.Interface,
	self refs.FeedRef,
	nw ssb.Network,
	publish ssb.Publisher,
	rlog margaret.Log,
	rep ssb.Replicator,
	db *badger.DB,
) (*Service, error)

New creates a new invite plugin service

func (*Service) Authorize

func (s *Service) Authorize(to refs.FeedRef) error

Authorize allows a connection of the guest keypair is known to the service and not yet expired

func (*Service) Create

func (s *Service) Create(uses uint, note string) (*invite.Token, error)

Create creates a new invite with a note attached and a number of uses before it expires.

func (*Service) GuestHandler

func (s *Service) GuestHandler() muxrpc.Handler

GuestHandler returns the handler to accept invites

func (*Service) MasterPlugin

func (s *Service) MasterPlugin() ssb.Plugin

MasterPlugin exposes a muxrpc handler with elevated methods, which can be used to create invites