github.com/hyperledger/aries-framework-go@v0.3.2/pkg/client/didexchange/models.go (about)

     1  /*
     2  Copyright SecureKey Technologies Inc. All Rights Reserved.
     3  
     4  SPDX-License-Identifier: Apache-2.0
     5  */
     6  
     7  package didexchange
     8  
     9  import (
    10  	"github.com/hyperledger/aries-framework-go/pkg/didcomm/protocol/didexchange"
    11  	"github.com/hyperledger/aries-framework-go/pkg/store/connection"
    12  )
    13  
    14  // QueryConnectionsParams model
    15  //
    16  // Parameters for querying connections.
    17  //
    18  type QueryConnectionsParams struct {
    19  
    20  	// Alias of connection invitation
    21  	Alias string `json:"alias,omitempty"`
    22  
    23  	// Initiator is Connection invitation initiator
    24  	Initiator string `json:"initiator,omitempty"`
    25  
    26  	// Invitation key
    27  	InvitationKey string `json:"invitation_key,omitempty"`
    28  
    29  	// Invitation ID
    30  	InvitationID string `json:"invitation_id,omitempty"`
    31  
    32  	// Parent threadID
    33  	ParentThreadID string `json:"parent_thread_id,omitempty"`
    34  
    35  	// MyDID is DID of the agent
    36  	MyDID string `json:"my_did,omitempty"`
    37  
    38  	// State of the connection invitation
    39  	State string `json:"state"`
    40  
    41  	// TheirDID is other party's DID
    42  	TheirDID string `json:"their_did,omitempty"`
    43  
    44  	// TheirRole is other party's role
    45  	TheirRole string `json:"their_role,omitempty"`
    46  }
    47  
    48  // Connection model
    49  //
    50  // This is used to represent query connection result.
    51  //
    52  type Connection struct {
    53  	*connection.Record
    54  }
    55  
    56  // Invitation model for DID Exchange invitation.
    57  type Invitation struct {
    58  	*didexchange.Invitation
    59  }
    60  
    61  // DIDInfo model for specifying public DID and associated label.
    62  type DIDInfo struct {
    63  
    64  	// the DID
    65  	DID string
    66  
    67  	// the label associated with DID
    68  	Label string
    69  }