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

     1  /*
     2  Copyright SecureKey Technologies Inc. All Rights Reserved.
     3  
     4  SPDX-License-Identifier: Apache-2.0
     5  */
     6  
     7  // Package outofbandv2 provides support for the Out-of-Band protocols following the DIDComm V2 spec:
     8  // https://identity.foundation/didcomm-messaging/spec/#out-of-band-messages.
     9  //
    10  // Create your client:
    11  //
    12  // ctx := getFrameworkContext()
    13  // client, err := outofbandv2.New(ctx)
    14  // if err != nil {
    15  //     panic(err)
    16  // }
    17  //
    18  // You can create requests and invitations with client.CreateInvitation() and client.AcceptInvitation()
    19  // respectively.
    20  //
    21  // Unlike other clients in the framework, this client does not trigger events since an OOB V2 messages
    22  // include a target goal message in the attachment that will be triggered automatically upon the execution
    23  // of the client.AcceptInvitation() function.
    24  //
    25  // Note: the ouf-of-band protocol results in the execution of other protocols. You need to subscribe
    26  // to the event and state streams of those protocols as well.
    27  package outofbandv2