model

Documentation

Index

• Constants
• type Ack
• type AckV2
• type AckV2Body
• type Code
• type Envelope
• type Event
• type Forward
• type ProblemReport
• type ProblemReportV2
• type ProblemReportV2Body

Constants

const (
	AckStatusOK      = "OK"
	AckStatusFAIL    = "FAIL"
	AckStatusPENDING = "PENDING"
)

acknowledgement status constants. Refer https://github.com/hyperledger/aries-rfcs/blob/main/features/0015-acks/README.md#ack-status.

Types

type Ack

type Ack struct {
	Type        string            `json:"@type,omitempty"`
	ID          string            `json:"@id,omitempty"`
	Status      string            `json:"status,omitempty"`
	Thread      *decorator.Thread `json:"~thread,omitempty"`
	WebRedirect interface{}       `json:"~web-redirect,omitempty"`
}

Ack acknowledgement struct.

type AckV2

type AckV2 struct {
	ID          string      `json:"id,omitempty"`
	Type        string      `json:"type,omitempty"`
	WebRedirect interface{} `json:"web_redirect,omitempty"`
	Body        AckV2Body   `json:"body,omitempty"`
}

AckV2 acknowledgement struct.

type AckV2Body

type AckV2Body struct {
	Status string `json:"status,omitempty"`
}

AckV2Body represents body for AckV2.

type Code

type Code struct {
	Code string `json:"code"`
}

Code represents a problem report code.

type Envelope

type Envelope struct {
	Protected  string `json:"protected,omitempty"`
	IV         string `json:"iv,omitempty"`
	CipherText string `json:"ciphertext,omitempty"`
	Tag        string `json:"tag,omitempty"`
}

Envelope for the DIDComm transport messages.

type Event

type Event interface {
	// connection ID
	ConnectionID() string

	// invitation ID
	InvitationID() string
}

Event properties related api. This can be used to cast Generic event properties to DID Exchange specific props.

type Forward

type Forward struct {
	Type string `json:"@type,omitempty"`
	ID   string `json:"@id,omitempty"`
	To   string `json:"to,omitempty"`
	Msg  []byte `json:"msg,omitempty"`
}

Forward route forward message. nolint:lll // url in the next line is long https://github.com/hyperledger/aries-rfcs/blob/main/concepts/0094-cross-domain-messaging/README.md#corerouting10forward

type ProblemReport

type ProblemReport struct {
	Type        string      `json:"@type"`
	ID          string      `json:"@id"`
	Description Code        `json:"description"`
	WebRedirect interface{} `json:"~web-redirect,omitempty"`
}

ProblemReport problem report definition TODO: need to provide full ProblemReport structure https://github.com/hyperledger/aries-framework-go/issues/912

type ProblemReportV2

type ProblemReportV2 struct {
	Type string              `json:"type,omitempty"`
	ID   string              `json:"id,omitempty"`
	Body ProblemReportV2Body `json:"body,omitempty"`
}

ProblemReportV2 problem report definition.

type ProblemReportV2Body

type ProblemReportV2Body struct {
	Code        string      `json:"code,omitempty"`
	Comment     string      `json:"comment,omitempty"`
	Args        []string    `json:"args,omitempty"`
	EscalateTo  string      `json:"escalate_to,omitempty"`
	WebRedirect interface{} `json:"~web-redirect,omitempty"`
}

ProblemReportV2Body represents body for ProblemReportV2.