messaging

Documentation

Index

• Constants
• type Operation
  • func New(ctx provider, registrar command.MessageHandler, notifier command.Notifier) (*Operation, error)
  • func (o *Operation) GetRESTHandlers() []rest.Handler
  • func (o *Operation) RegisterHTTPService(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) RegisterService(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) Reply(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) Send(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) Services(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) UnregisterService(rw http.ResponseWriter, req *http.Request)
• type SendReplyMessageRequest

Constants

const (
	RegisterHTTPOverDIDCommService = httpOverDIDComm + "/register"

	// message service endpoints.
	MsgServiceOperationID = "/message"
	RegisterMsgService    = MsgServiceOperationID + "/register-service"
	UnregisterMsgService  = MsgServiceOperationID + "/unregister-service"
	MsgServiceList        = MsgServiceOperationID + "/services"
	SendNewMsg            = MsgServiceOperationID + "/send"
	SendReplyMsg          = MsgServiceOperationID + "/reply"
)

constants for Messaging operations.

Types

type Operation

type Operation struct {
	// contains filtered or unexported fields
}

Operation contains basic common operations provided by controller REST API.

func New

func New(ctx provider, registrar command.MessageHandler, notifier command.Notifier) (*Operation, error)

New returns new common operations rest client instance.

func (*Operation) GetRESTHandlers

func (o *Operation) GetRESTHandlers() []rest.Handler

GetRESTHandlers get all controller API handler available for this service.

func (*Operation) RegisterHTTPService

func (o *Operation) RegisterHTTPService(rw http.ResponseWriter, req *http.Request)

RegisterHTTPService swagger:route POST /http-over-didcomm/register http-over-didcomm registerHttpMsgSvc

registers new http over didcomm service to message handler registrar

Responses:

default: genericError

func (*Operation) RegisterService

func (o *Operation) RegisterService(rw http.ResponseWriter, req *http.Request)

RegisterService swagger:route POST /message/register-service message registerMsgSvc

registers new message service to message handler registrar

Responses:

default: genericError

func (*Operation) Reply

func (o *Operation) Reply(rw http.ResponseWriter, req *http.Request)

Reply swagger:route POST /message/reply message sendReplyMessage

sends reply to existing message

Responses:

default: genericError
200: sendMessageResponse

func (*Operation) Send

func (o *Operation) Send(rw http.ResponseWriter, req *http.Request)

Send swagger:route POST /message/send message sendNewMessage

sends new message to destination provided

Responses:

default: genericError
200: sendMessageResponse

func (*Operation) Services

func (o *Operation) Services(rw http.ResponseWriter, req *http.Request)

Services swagger:route GET /message/services message http-over-didcomm services

returns list of registered service names

Responses:

default: genericError
200: registeredServicesResponse

func (*Operation) UnregisterService

func (o *Operation) UnregisterService(rw http.ResponseWriter, req *http.Request)

UnregisterService swagger:route POST /message/unregister-service message http-over-didcomm unregisterMsgSvc

unregisters given message service handler registrar

Responses:

default: genericError

type SendReplyMessageRequest

type SendReplyMessageRequest struct {
	// Params for sending message reply
	//
	// in: body
	Params messaging.SendReplyMessageArgs
}

SendReplyMessageRequest model

This is used for operation to send reply to message

swagger:parameters sendReplyMessage