invite

Documentation

Index

• Variables
• type Repository

Variables

var ErrTokenNotFound = errors.New("token not found")

ErrTokenNotFound is the error returned when the token does not exist.

var ErrUserAlreadyAccepted = errors.New("user already added to accepted users")

ErrUserAlreadyAccepted is the error returned when the user was already added to the accepted users list.

Types

type Repository

type Repository interface {
	// AddToken stores the token in the repository.
	AddToken(ctx context.Context, token *invitepb.InviteToken) error

	// GetToken gets the token from the repository.
	GetToken(ctx context.Context, token string) (*invitepb.InviteToken, error)

	// ListTokens gets the valid tokens from the repository (i.e. not expired).
	ListTokens(ctx context.Context, initiator *userpb.UserId) ([]*invitepb.InviteToken, error)

	// AddRemoteUser stores the remote user.
	AddRemoteUser(ctx context.Context, initiator *userpb.UserId, remoteUser *userpb.User) error

	// GetRemoteUser retrieves details about a remote user who has accepted an invite to share.
	GetRemoteUser(ctx context.Context, initiator *userpb.UserId, remoteUserID *userpb.UserId) (*userpb.User, error)

	// FindRemoteUsers finds remote users who have accepted invites based on their attributes.
	FindRemoteUsers(ctx context.Context, initiator *userpb.UserId, query string) ([]*userpb.User, error)

	// DeleteRemoteUser removes from the remote user from the initiator's list.
	DeleteRemoteUser(ctx context.Context, initiator *userpb.UserId, remoteUser *userpb.UserId) error
}

Repository is the interfaces used to store the tokens and the invited users.