Documentation ¶
Index ¶
- Variables
- type Content
- func (*Content) Descriptor() ([]byte, []int)deprecated
- func (x *Content) GetByteCount() int64
- func (x *Content) GetLink() string
- func (x *Content) GetSha256() string
- func (*Content) ProtoMessage()
- func (x *Content) ProtoReflect() protoreflect.Message
- func (x *Content) Reset()
- func (x *Content) String() string
- type ImgAttach
- func (*ImgAttach) Descriptor() ([]byte, []int)deprecated
- func (x *ImgAttach) GetContent() *Content
- func (x *ImgAttach) GetDescription() string
- func (x *ImgAttach) GetFilename() string
- func (x *ImgAttach) GetMimeType() string
- func (*ImgAttach) ProtoMessage()
- func (x *ImgAttach) ProtoReflect() protoreflect.Message
- func (x *ImgAttach) Reset()
- func (x *ImgAttach) String() string
- type PleaseIntroduceTo
- func (*PleaseIntroduceTo) Descriptor() ([]byte, []int)deprecated
- func (x *PleaseIntroduceTo) GetDescription() string
- func (x *PleaseIntroduceTo) GetDescriptionL10N() map[string]string
- func (x *PleaseIntroduceTo) GetImgAttach() *ImgAttach
- func (x *PleaseIntroduceTo) GetName() string
- func (x *PleaseIntroduceTo) GetProposed() bool
- func (x *PleaseIntroduceTo) GetWhere() string
- func (*PleaseIntroduceTo) ProtoMessage()
- func (x *PleaseIntroduceTo) ProtoReflect() protoreflect.Message
- func (x *PleaseIntroduceTo) Reset()
- func (x *PleaseIntroduceTo) String() string
- type Proposal
- func (*Proposal) Descriptor() ([]byte, []int)deprecated
- func (x *Proposal) GetGoal() string
- func (x *Proposal) GetGoalCode() string
- func (x *Proposal) GetId() string
- func (x *Proposal) GetNwise() bool
- func (x *Proposal) GetThread() *types.Thread
- func (x *Proposal) GetTiming() *types1.Timing
- func (x *Proposal) GetTo() *To
- func (x *Proposal) GetType() string
- func (*Proposal) ProtoMessage()
- func (x *Proposal) ProtoReflect() protoreflect.Message
- func (x *Proposal) Reset()
- func (x *Proposal) String() string
- type Recipient
- func (*Recipient) Descriptor() ([]byte, []int)deprecated
- func (x *Recipient) GetGoal() string
- func (x *Recipient) GetGoalCode() string
- func (x *Recipient) GetMyDid() string
- func (x *Recipient) GetTheirDid() string
- func (x *Recipient) GetTo() *To
- func (*Recipient) ProtoMessage()
- func (x *Recipient) ProtoReflect() protoreflect.Message
- func (x *Recipient) Reset()
- func (x *Recipient) String() string
- type Request
- func (*Request) Descriptor() ([]byte, []int)deprecated
- func (x *Request) GetId() string
- func (x *Request) GetNwise() bool
- func (x *Request) GetPleaseIntroduceTo() *PleaseIntroduceTo
- func (x *Request) GetTiming() *types1.Timing
- func (x *Request) GetType() string
- func (*Request) ProtoMessage()
- func (x *Request) ProtoReflect() protoreflect.Message
- func (x *Request) Reset()
- func (x *Request) String() string
- type Response
- func (*Response) Descriptor() ([]byte, []int)deprecated
- func (x *Response) GetApprove() bool
- func (x *Response) GetAttach() []*types.Attachment
- func (x *Response) GetId() string
- func (x *Response) GetOobMessage() map[string]*anypb.Any
- func (x *Response) GetThread() *types.Thread
- func (x *Response) GetType() string
- func (*Response) ProtoMessage()
- func (x *Response) ProtoReflect() protoreflect.Message
- func (x *Response) Reset()
- func (x *Response) String() string
- type To
- func (*To) Descriptor() ([]byte, []int)deprecated
- func (x *To) GetDescription() string
- func (x *To) GetDescriptionL10N() map[string]string
- func (x *To) GetImgAttach() *ImgAttach
- func (x *To) GetName() string
- func (x *To) GetProposed() bool
- func (x *To) GetWhere() string
- func (*To) ProtoMessage()
- func (x *To) ProtoReflect() protoreflect.Message
- func (x *To) Reset()
- func (x *To) String() string
Constants ¶
This section is empty.
Variables ¶
var File_api_did_introduce_types_introduce_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Content ¶
type Content struct { Link string `protobuf:"bytes,1,opt,name=link,proto3" json:"link,omitempty"` ByteCount int64 `protobuf:"varint,2,opt,name=byte_count,json=byteCount,proto3" json:"byte_count,omitempty"` Sha256 string `protobuf:"bytes,3,opt,name=sha256,proto3" json:"sha256,omitempty"` // contains filtered or unexported fields }
Content keeps image data. swagger:model
func (*Content) Descriptor
deprecated
func (*Content) GetByteCount ¶
func (*Content) ProtoMessage ¶
func (*Content) ProtoMessage()
func (*Content) ProtoReflect ¶
func (x *Content) ProtoReflect() protoreflect.Message
type ImgAttach ¶
type ImgAttach struct { Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"` MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"` //mime-type Filename string `protobuf:"bytes,3,opt,name=filename,proto3" json:"filename,omitempty"` Content *Content `protobuf:"bytes,4,opt,name=content,proto3" json:"content,omitempty"` // contains filtered or unexported fields }
ImgAttach represent information about the image.
func (*ImgAttach) Descriptor
deprecated
func (*ImgAttach) GetContent ¶
func (*ImgAttach) GetDescription ¶
func (*ImgAttach) GetFilename ¶
func (*ImgAttach) GetMimeType ¶
func (*ImgAttach) ProtoMessage ¶
func (*ImgAttach) ProtoMessage()
func (*ImgAttach) ProtoReflect ¶
func (x *ImgAttach) ProtoReflect() protoreflect.Message
type PleaseIntroduceTo ¶
type PleaseIntroduceTo struct { // nolint: staticcheck Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` DescriptionL10N map[string]string `` // description~l10n /* 194-byte string literal not displayed */ Where string `protobuf:"bytes,4,opt,name=where,proto3" json:"where,omitempty"` ImgAttach *ImgAttach `protobuf:"bytes,5,opt,name=img_attach,json=imgAttach,proto3" json:"img_attach,omitempty"` // img~attach Proposed bool `protobuf:"varint,6,opt,name=proposed,proto3" json:"proposed,omitempty"` // Discovered Discovered `json:"discovered,omitempty"` // contains filtered or unexported fields }
PleaseIntroduceTo includes all field from To structure also it has Discovered the field which should be provided by help-me-discover protocol. swagger:model
func (*PleaseIntroduceTo) Descriptor
deprecated
func (*PleaseIntroduceTo) Descriptor() ([]byte, []int)
Deprecated: Use PleaseIntroduceTo.ProtoReflect.Descriptor instead.
func (*PleaseIntroduceTo) GetDescription ¶
func (x *PleaseIntroduceTo) GetDescription() string
func (*PleaseIntroduceTo) GetDescriptionL10N ¶
func (x *PleaseIntroduceTo) GetDescriptionL10N() map[string]string
func (*PleaseIntroduceTo) GetImgAttach ¶
func (x *PleaseIntroduceTo) GetImgAttach() *ImgAttach
func (*PleaseIntroduceTo) GetName ¶
func (x *PleaseIntroduceTo) GetName() string
func (*PleaseIntroduceTo) GetProposed ¶
func (x *PleaseIntroduceTo) GetProposed() bool
func (*PleaseIntroduceTo) GetWhere ¶
func (x *PleaseIntroduceTo) GetWhere() string
func (*PleaseIntroduceTo) ProtoMessage ¶
func (*PleaseIntroduceTo) ProtoMessage()
func (*PleaseIntroduceTo) ProtoReflect ¶
func (x *PleaseIntroduceTo) ProtoReflect() protoreflect.Message
func (*PleaseIntroduceTo) Reset ¶
func (x *PleaseIntroduceTo) Reset()
func (*PleaseIntroduceTo) String ¶
func (x *PleaseIntroduceTo) String() string
type Proposal ¶
type Proposal struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // @id Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"` // @type To *To `protobuf:"bytes,3,opt,name=to,proto3" json:"to,omitempty"` Nwise bool `protobuf:"varint,4,opt,name=nwise,proto3" json:"nwise,omitempty"` Thread *types.Thread `protobuf:"bytes,5,opt,name=thread,proto3" json:"thread,omitempty"` // ~thread Timing *types1.Timing `protobuf:"bytes,6,opt,name=timing,proto3" json:"timing,omitempty"` //~timing Goal string `protobuf:"bytes,7,opt,name=goal,proto3" json:"goal,omitempty"` GoalCode string `protobuf:"bytes,8,opt,name=goal_code,json=goalCode,proto3" json:"goal_code,omitempty"` // contains filtered or unexported fields }
Proposal defines proposal request. swagger:model
func (*Proposal) Descriptor
deprecated
func (*Proposal) GetGoalCode ¶
func (*Proposal) ProtoMessage ¶
func (*Proposal) ProtoMessage()
func (*Proposal) ProtoReflect ¶
func (x *Proposal) ProtoReflect() protoreflect.Message
type Recipient ¶
type Recipient struct { To *To `protobuf:"bytes,1,opt,name=to,proto3" json:"to,omitempty"` Goal string `protobuf:"bytes,2,opt,name=goal,proto3" json:"goal,omitempty"` GoalCode string `protobuf:"bytes,3,opt,name=goal_code,json=goalCode,proto3" json:"goal_code,omitempty"` MyDid string `protobuf:"bytes,4,opt,name=my_did,json=myDid,proto3" json:"my_did,omitempty"` TheirDid string `protobuf:"bytes,5,opt,name=their_did,json=theirDid,proto3" json:"their_did,omitempty"` // contains filtered or unexported fields }
Recipient keeps information needed for the service 'To' field is needed for the proposal message 'MyDID' and 'TheirDID' fields are needed for sending messages e.g report-problem, proposal, ack etc. swagger:model
func (*Recipient) Descriptor
deprecated
func (*Recipient) GetGoalCode ¶
func (*Recipient) GetTheirDid ¶
func (*Recipient) ProtoMessage ¶
func (*Recipient) ProtoMessage()
func (*Recipient) ProtoReflect ¶
func (x *Recipient) ProtoReflect() protoreflect.Message
type Request ¶
type Request struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // @id Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"` // @type PleaseIntroduceTo *PleaseIntroduceTo `protobuf:"bytes,3,opt,name=please_introduce_to,json=pleaseIntroduceTo,proto3" json:"please_introduce_to,omitempty"` Nwise bool `protobuf:"varint,4,opt,name=nwise,proto3" json:"nwise,omitempty"` Timing *types1.Timing `protobuf:"bytes,5,opt,name=timing,proto3" json:"timing,omitempty"` // ~timing // contains filtered or unexported fields }
Request is not part of any state machine, it can be sent at any time, and when it is received, the recipient can choose whether or not to honor it in their own way TODO: need to clarify about decorator ~please_ack and problem_report
should Request contain those fields? What type it should be for each field?
swagger:model
func (*Request) Descriptor
deprecated
func (*Request) GetPleaseIntroduceTo ¶
func (x *Request) GetPleaseIntroduceTo() *PleaseIntroduceTo
func (*Request) ProtoMessage ¶
func (*Request) ProtoMessage()
func (*Request) ProtoReflect ¶
func (x *Request) ProtoReflect() protoreflect.Message
type Response ¶
type Response struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // @id Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"` // @type Thread *types.Thread `protobuf:"bytes,3,opt,name=thread,proto3" json:"thread,omitempty"` // ~thread Approve bool `protobuf:"varint,4,opt,name=approve,proto3" json:"approve,omitempty"` OobMessage map[string]*anypb.Any `` //oob-message /* 179-byte string literal not displayed */ Attach []*types.Attachment `protobuf:"bytes,6,rep,name=attach,proto3" json:"attach,omitempty"` //~attach // contains filtered or unexported fields }
Response message that introducee usually sends in response to an introduction proposal. swagger:model
func (*Response) Descriptor
deprecated
func (*Response) GetApprove ¶
func (*Response) GetAttach ¶
func (x *Response) GetAttach() []*types.Attachment
func (*Response) ProtoMessage ¶
func (*Response) ProtoMessage()
func (*Response) ProtoReflect ¶
func (x *Response) ProtoReflect() protoreflect.Message
type To ¶
type To struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` DescriptionL10N map[string]string `` // description~l10n /* 194-byte string literal not displayed */ Where string `protobuf:"bytes,4,opt,name=where,proto3" json:"where,omitempty"` ImgAttach *ImgAttach `protobuf:"bytes,5,opt,name=img_attach,json=imgAttach,proto3" json:"img_attach,omitempty"` // img~attach Proposed bool `protobuf:"varint,6,opt,name=proposed,proto3" json:"proposed,omitempty"` // contains filtered or unexported fields }
To introducee descriptor keeps information about the introduction e.g introducer wants to introduce Bot to introducee { "name": "Bob" }. swagger:model
func (*To) Descriptor
deprecated
func (*To) GetDescription ¶
func (*To) GetDescriptionL10N ¶
func (*To) GetImgAttach ¶
func (*To) GetProposed ¶
func (*To) ProtoMessage ¶
func (*To) ProtoMessage()
func (*To) ProtoReflect ¶
func (x *To) ProtoReflect() protoreflect.Message