docs: improving Agent.acceptInvitation description

Signed-off-by: Curtish <ch@curtish.me>
hyperledger · Nov 14, 2024 · a8c97ad · a8c97ad
1 parent 01105a0
commit a8c97ad
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/src/edge-agent/didcomm/Agent.ts b/src/edge-agent/didcomm/Agent.ts
@@ -321,7 +321,12 @@ export default class DIDCommAgent {
   }
 
   /**
-   * Handle an invitation to create a connection
+   * Handle an invitation based on it's type
+   * 
+   * - `PrismOnboardingInvitation`: creates a new connection
+   * - `OutOfBandInvitation`: 
+   *     - no Attachment: creates a new connection
+   *     - with Attachment: stores / emits the attached message
    * 
    * @async
    * @param {InvitationType} invitation - an OOB or PrismOnboarding invitation