outofband

Documentation

Index

• Constants
• type Operation
  • func New(ctx client.Provider, notifier command.Notifier) (*Operation, error)
  • func (c *Operation) AcceptInvitation(rw http.ResponseWriter, req *http.Request)
  • func (c *Operation) ActionContinue(rw http.ResponseWriter, req *http.Request)
  • func (c *Operation) ActionStop(rw http.ResponseWriter, req *http.Request)
  • func (c *Operation) Actions(rw http.ResponseWriter, _ *http.Request)
  • func (c *Operation) CreateInvitation(rw http.ResponseWriter, req *http.Request)
  • func (c *Operation) GetRESTHandlers() []rest.Handler

Constants

const (
	OperationID      = "/outofband"
	CreateInvitation = OperationID + "/create-invitation"
	AcceptRequest    = OperationID + "/accept-request"
	AcceptInvitation = OperationID + "/accept-invitation"
	Actions          = OperationID + "/actions"
	ActionContinue   = OperationID + "/{piid}/action-continue"
	ActionStop       = OperationID + "/{piid}/action-stop"
)

constants for the OutOfBand protocol operations.

Types

type Operation

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

Operation is controller REST service controller for outofband.

func New

func New(ctx client.Provider, notifier command.Notifier) (*Operation, error)

New returns new outofband rest client protocol instance.

func (*Operation) AcceptInvitation

func (c *Operation) AcceptInvitation(rw http.ResponseWriter, req *http.Request)

AcceptInvitation swagger:route POST /outofband/accept-invitation outofband outofbandAcceptInvitation

Accepts an invitation.

Responses:

default: genericError
    200: outofbandAcceptInvitationResponse

func (*Operation) ActionContinue

func (c *Operation) ActionContinue(rw http.ResponseWriter, req *http.Request)

ActionContinue swagger:route POST /outofband/{piid}/action-continue outofband outofbandActionContinue

Allows continuing with the protocol after an action event was triggered.

Responses:

default: genericError
    200: outofbandActionContinueResponse

func (*Operation) ActionStop

func (c *Operation) ActionStop(rw http.ResponseWriter, req *http.Request)

ActionStop swagger:route POST /outofband/{piid}/action-stop outofband outofbandActionStop

Stops the protocol after an action event was triggered.

Responses:

default: genericError
    200: outofbandActionStopResponse

func (*Operation) Actions

func (c *Operation) Actions(rw http.ResponseWriter, _ *http.Request)

Actions swagger:route GET /outofband/actions outofband outofbandActions

Returns pending actions that have not yet to be executed or cancelled.

Responses:

default: genericError
    200: outofbandActionsResponse

func (*Operation) CreateInvitation

func (c *Operation) CreateInvitation(rw http.ResponseWriter, req *http.Request)

CreateInvitation swagger:route POST /outofband/create-invitation outofband outofbandCreateInvitation

Creates an invitation.

Responses:

default: genericError
    200: outofbandCreateInvitationResponse

func (*Operation) GetRESTHandlers

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

GetRESTHandlers get all controller API handler available for this protocol service.