clients

Documentation

Index

• Variables
• func Activate(ctx context.Context, be *backend.Backend, clientKey string) (*db.ClientInfo, error)
• func Deactivate(ctx context.Context, be *backend.Backend, clientID db.ID) (*db.ClientInfo, error)
• func FindClientAndDocument(ctx context.Context, be *backend.Backend, clientID db.ID, docKey *key.Key, ...) (*db.ClientInfo, *db.DocInfo, error)

Variables

var (
	// ErrInvalidClientKey is returned when the given Key is not valid ClientKey.
	ErrInvalidClientKey = errors.New("invalid client key")

	// ErrInvalidClientID is returned when the given Key is not valid ClientID.
	ErrInvalidClientID = errors.New("invalid client id")
)

Functions

func Activate

func Activate(
	ctx context.Context,
	be *backend.Backend,
	clientKey string,
) (*db.ClientInfo, error)

Activate activates the given client.

func Deactivate

func Deactivate(
	ctx context.Context,
	be *backend.Backend,
	clientID db.ID,
) (*db.ClientInfo, error)

Deactivate deactivates the given client.

func FindClientAndDocument

func FindClientAndDocument(
	ctx context.Context,
	be *backend.Backend,
	clientID db.ID,
	docKey *key.Key,
	createDocIfNotExist bool,
) (*db.ClientInfo, *db.DocInfo, error)

FindClientAndDocument finds the client and the document.