useractions

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 UserAction 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 UserActions microservice client.

type Session

type Session interface {
	ListUserActions() ([]cacao_common_http.UserAction, error)
	GetUserAction(userActionID cacao_common.ID) (cacao_common_http.UserAction, error)

	CreateUserAction(creationRequest cacao_common_http.UserAction) (cacao_common.ID, error)
	ValidateUserActionCreationRequest(creationRequest cacao_common_http.UserAction) error
	UpdateUserAction(userActionID cacao_common.ID, updateRequest cacao_common_http.UserAction) (cacao_common.ID, error)
	ValidateUserActionUpdateRequest(userActionID cacao_common.ID, updateRequest cacao_common_http.UserAction) error
	UpdateUserActionFields(userActionID cacao_common.ID, updateRequest cacao_common_http.UserAction, updateFields []string) (cacao_common.ID, error)
	ValidateUserActionUpdateFieldsRequest(userActionID cacao_common.ID, updateRequest cacao_common_http.UserAction, updateFields []string) error
	DeleteUserAction(userActionID cacao_common.ID) (cacao_common.ID, error)
	ValidateUserActionDeletionRequest(userActionID cacao_common.ID) error
}

Session is an interface for interacting with the UserAction 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.