identity

Documentation

Index

• type Callbacks
• type Capabilities
• type Plugin

Types

type Callbacks

type Callbacks interface {
}

Callbacks is the interface provided to the identity plugin, to allow it to request information from firefly, or pass events.

type Capabilities

type Capabilities struct {
}

Capabilities the supported featureset of the identity interface implemented by the plugin, with the specified config

type Plugin

type Plugin interface {
	core.Named

	// InitConfig initializes the set of configuration options that are valid, with defaults. Called on all plugins.
	InitConfig(config config.Section)

	// Init initializes the plugin, with configuration
	Init(ctx context.Context, config config.Section) error

	// SetHandler registers a handler to receive callbacks
	// Plugin will attempt (but is not guaranteed) to deliver events only for the given namespace
	SetHandler(namespace string, handler Callbacks)

	// Blockchain interface must not deliver any events until start is called
	Start() error

	// Capabilities returns capabilities - not called until after Init
	Capabilities() *Capabilities
}

Plugin is the interface implemented by each identity plugin