interactivesessions

Documentation

Index

• type Client
  • func New(queryConn messaging2.QueryConnection, eventConn messaging2.EventConnection) Client
• type Session

Types

type Client

type Client interface {
	Session(actor, emulator string, isAdmin bool) (Session, error)
}

Client is an interface for interacting with the Interactive Session microservice. Implementations of this interface should encapsulate information necessary to interact with the microservice, such as Nats and Stan connection information.

func New

func New(queryConn messaging2.QueryConnection, eventConn messaging2.EventConnection) Client

New creates a new Interactive Sessions microservice client.

type Session

type Session interface {
	ListInteractiveSessions() ([]cacao_common_http.InteractiveSession, error)

	GetInteractiveSession(interactiveSessionID cacao_common.ID) (cacao_common_http.InteractiveSession, error)
	GetInteractiveSessionByInstanceID(instanceID string) (cacao_common_http.InteractiveSession, error)
	GetInteractiveSessionByInstanceAddress(instanceAddress string) (cacao_common_http.InteractiveSession, error)

	CheckPrerequisitesForInteractiveSession(protocol cacao_common_service.InteractiveSessionProtocol, instanceAddress string, instanceAdminUsername string) (cacao_common_http.InteractiveSessionPrerequisiteCheck, error)

	CreateInteractiveSession(creationRequest cacao_common_http.InteractiveSession) (cacao_common.ID, error)
	ValidateInteractiveSessionCreationRequest(creationRequest cacao_common_http.InteractiveSession) error
	DeactivateInteractiveSession(interactiveSessionID cacao_common.ID) (cacao_common.ID, error)
	ValidateInteractiveSessionDeactivationRequest(interactiveSessionID cacao_common.ID) error
}

Session is an interface for interacting with the Interactive Session microservice on behalf of a user. The purpose of having a session is to consolidate parameters that are common in all or most requests, but are not known at configuration time.