SDK Reference

const didExchangeRecord = await agent.didExchange(
    didExchangeId: String,
    outOfBandId: String,
    routingParam: Routing | undefined // Not available in React Native
)

const trustPingMessage = await agent.didExchange.sendPing(
    exchangeId: String,
    responseRequested: Boolean,
    returnRouting: Boolean
)

const didExchangeStateChangedEvent: DidExchangeStateChangedEvent? = await agent.didExchange.returnWhenIsConnected(
    didExchangeId: String,
    timeOutMs: Number | Long
)

const records: Array<DidExchangeRecord> = await agent.didExchange.getAll()

const records: Array<DidExchangeRecord> = await agent.didExchange.findAllByQuery(
    query: Query // Record<String, String> in React Native. Malformed Query will throw
)

const record = await agent.didExchange.getById(
    didExchangeId: String
)

const record: DidExchangeRecord? = await agent.didExchange.findById(
    didExchangeId: String
)

await agent.didExchange.deleteById(
    didExchangeId: String
)

const records: Array<DidExchangeRecord> = await agent.didExchange.getAllByOutOfBandId(
   outOfBandId: String
)

const record: DidExchangeRecord? = await agent.didExchange.findByDid(
    did: String
)

const record: DidExchangeRecord? = await agent.didExchange.findByInvitationDid(
    did: String
)

const record = await agent.outOfBand.createInvitation(
    label: String | undefined,
    alias: String | undefined,
    goalCode: String | undefined,
    goal: String | undefined,
    handShake: Boolean | undefined,
    messages: Array<BaseMessage> | undefined,
    multiUseInvitation: Boolean | undefined,
    autoAcceptConnection: Boolean | undefined,
    routingParam: Routing | undefined, // Not available in React Native
    appendedAttachment: Array<Attachment> | undefined
)

const message = agent.outOfBand.parseInvitation(
    invitationUrl: String
)

const invitationResponse = await agent.outOfBand.receiveInvitation(
    invitation: OutOfBandInvitationMessage,
    label: String | undefined,
    alias: String | undefined,
    autoAcceptConnection: Boolean | undefined,
    reuseConnection: Boolean | undefined,
    routingParam: Routing | undefined, // Not available in React Native
    acceptInvitationTimeOutMs = Number | Long | undefined
)

const invitationResponse = await agent.outOfBand.receiveImplicitInvitation(
    label: String | undefined,
    alias: String | undefined,
    autoAcceptConnection: Boolean | undefined,
    reuseConnection: Boolean | undefined,
    routingParam: Routing | undefined, // Not available in React Native
    acceptInvitationTimeOutMs: Number | Long | null,
    did: String,
    handShakeProtocol: Array<String> | null
)

const invitationResponse = await agent.outOfBand.acceptInvitation(
    outOfBand: String,
    autoAcceptConnection: Boolean,
    reuseConnection: Boolean,
    label: String,
    alias: String | null,
    routingParam: Routing | null,
    timeOutMs: Number | undefined
)

const record: OutOfBandRecord? = await agent.outOfBand.findByReceivedInvitationId(
    receivedInvitationId: String
)

const record: OutOfBandRecord? = await agent.outOfBand.findByCreatedInvitationId(
    createdInvitationId: String
)

const records: Array<OutOfBandRecord> = await agent.outOfBand.getAll()

const records: Array<OutOfBandRecord> = await agent.outOfBand.getAllByQuery(
    query: Query // Record<String, String> in React Native. Malformed Query will throw
)

const record = await agent.outOfBand.getById(
    outOfBandId: String
)

const record: OutOfBandRecord? = await agent.outOfBand.findById(
    outOfBandId: String
)

await agent.outOfBand.deleteById(
    outOfBandId: String
)

const records: Array<CredentialRecord> = await agent.credentials.findAllCredentialsBySchemaId(
    schemaId: String
)

const record = await agent.credential.proposeCredential(
    didExchangeId: String,
    formatServices: FormatServices,
    autoAcceptCredential: Boolean | undefined,
    comment: String | null | undefined
)

const record = await agent.credentials.acceptOffer(
    credentialExchangeId: String,
    autoAcceptCredential: Boolean | undefined,
    comment: String | null | undefined
)

const record = agent.credentials.acceptCredential(
    credentialExchangeId: String
)

const record: CredentialExchangeRecord? = await agent.credentials.findByRecordId(
    credentialExchangeId: String
)

const records: Array<CredentialExchangeRecord> = await agent.credentials.findAllByState(
    state: CredentialState
)

const records: Array<CredentialExchangeRecord> = await agent.credentials.findAllByStateAndDidExchangeId(
    state: CredentialState,
    didExchangeId: String
)

const records: Array<CredentialExchangeRecord> = await agent.credentials.getAll()

const record = await agent.credentials.findByThreadIdAndDidExchangeId(
    threadId: String,
    didExchangeId: String | null
)

const record = await agent.credentials.getByThreadIdAndDidExchangeId(
    threadId: String,
    didExchangeId: String | null
)

const record = await agent.proofs.autoAcceptProof(
    proofId: String,
    exchangeId: String
)

const record = await agent.proofs.acceptProof(
    proofData: PresentationData
)

const creds = await agent.proofs.getCredentialsForProofRequest(
    proofId: String,
    exchangeId: String,
    nonRevoked: Boolean | undefined
)

const creds = await agent.proofs.autoSelectCredentialsForProofRequest(
    proofId: String,
    exchangeId: String,
    nonRevoked: Boolean | undefined
)

const records: Array<ProofRecord> = await agent.proofs.getProofRequestsForConnection(
    didExchangeId: String
)

await agent.routing.initialize()

await agent.routing.initiateMessagePickup(
    mediator: MediationRecord | null | undefined // Record id is used in React Native
)

const record: MediationRecord? = await agent.routing.findDefaultMediator()

const record: MediationRecord? = await agent.routing.discoverMediation()

const record = await agent.routing.setDefaultMediator(
    mediation: MediationRecord | String // Provide the record or the record id. React native only uses Id
)

const record = await agent.routing.requestMediation(
    didExchange: DidExchangeRecord | String // Provide the record or the record id. React native only uses Id
)

const record = await agent.routing.getByExchangeId(
    exchangeId: String
)

const record: MediationRecord? = await agent.routing.findByExchangeId(
    exchangeId: String
)

const records: Array<MediationRecord> = await agent.routing.getMediators()

const record: DidExchangeRecord? = await agent.routing.findDefaultMediatorExchange()

const record: MediationRecord? = await agent.routing.provision(
    didExchangeRecord: DidExchangeRecord,
    timeOutMs: Number | Long | undefined
)

const routing = await agent.routing.getRouting(
    mediatorId: String,
    useDefaultMediator: Boolean | undefined
)

const sentMessageRecord = await agent.basicMessages.send(
    didExchangeId: String, // ID of target
    content: String, // Message content to be sent
    locale: String = "en", // L10nDecorator version (defaults to "en")
    comment: String? // Comment on message
)

const basicMessage = await agent.basicMessages.findById(
    basicMessageRecordId: String // Record ID to be retrieved
)

const basicMessages = await agent.basicMessages.getAll()

const basicMessages = await agent.basicMessages.findByComment(
    comment: String // Comment to search for
)

const basicMessages = await agent.basicMessages.findByDidExchangeId(
    didExchangeId: String // Exchange ID to look for
)

const basicMessages = await agent.basicMessages.findByRole(
    role: BasicMessageRole // Role to look for
)

const remove = agent.events.registerDidExchangeHandler((event) => {
    console.log("Got a didExchange event")
})

remove() // cancels the event callback

// May not be defined if there were issues with agent initialization
val didExchange: DidExchangeEvents? = agent.events.getDidExchangeEvents()

agent.events.scope.launch {
    didExchange.events.onEach{
        println("Got a didExchange event")
    }.collect() // Make sure to call collect or events will not be processed
}

let removeListener = agent.events.onDidExchangeStateChanged { event in
   // Handle DidExchangeStateChangedEvent here
}
// Remove listener when no longer needed
removeListener(nil)