Boosts

Boosts Management

1. Create a Boost

To create a boost, use the createBoost method. This method accepts a credential object (which can be an UnsignedVC or VC) and an optional metadata object.

const credential = your_credential;
const metadata = {
  name: 'Your Boost Name',
  description: 'Your Boost Description',
};

learnCard.invoke.createBoost(credential, metadata);

2. Get a Boost

To get a boost, use the getBoost method. This method accepts a uri parameter.

const uri = 'your_boost_uri';

learnCard.invoke.getBoost(uri);

3. Get Boosts

To retrieve all boosts, use the getBoosts method.

learnCard.invoke.getBoosts();

4. Get Boost Recipients

To get boost recipients, use the getBoostRecipients method. This method accepts a uri parameter and optional limit and skip parameters.

const uri = 'your_boost_uri';
const limit = 10;
const skip = 0;

learnCard.invoke.getBoostRecipients(uri, limit, skip);

5. Update a Boost

To update a boost, use the updateBoost method. This method accepts a uri parameter, an updates object, and a credential object (which can be an UnsignedVC or VC).

const uri = 'your_boost_uri';
const updates = {
  name: 'Updated Boost Name',
  description: 'Updated Boost Description',
};
const credential = updated_credential;

learnCard.invoke.updateBoost(uri, updates, credential);

6. Delete a Boost

To delete a boost, use the deleteBoost method. This method accepts a uri parameter.

const uri = 'your_boost_uri';

learnCard.invoke.deleteBoost(uri);

7. Send a Boost

To send a boost to another profile, use the sendBoost method. This method accepts a profileId, a boostUri parameter, and an optional encrypt parameteropconst profileId = 'janesmith';

const boostUri = 'your_boost_uri';
const encrypt = true;

learnCard.invoke.sendBoost(profileId, boostUri, encrypt);

These are the API calls related to boosts management in the LearnCard Network API. Use these methods to create, update, retrieve, and delete boosts, as well as send boosts to other profiles.

Claim a Boost

const boostUri = 'https://example.com/boost-uri';
const challenge = 'example-challenge';

await networkLearnCard.invoke.claimBoostWithLink(boostUri, challenge);

These examples demonstrate some of the ways you can interact with the LearnCard Network API using the @learncard/network-plugin.

PreviousCredentials NextPresentations

Last updated 3 months ago

Was this helpful?

const uri = 'your_boost_uri'; const updates = { name: 'Updated Boost Name', description: 'Updated Boost Description', }; const credential = updated_credential; learnCard.invoke.updateBoost(uri, updates, credential);

{ "name": "text", "type": "text", "category": "text", "status": "DRAFT", "autoConnectRecipients": true, "meta": { "ANY_ADDITIONAL_PROPERTY": "anything" }, "claimPermissions": { "role": "text", "canEdit": true, "canIssue": true, "canRevoke": true, "canManagePermissions": true, "canIssueChildren": "text", "canCreateChildren": "text", "canEditChildren": "text", "canRevokeChildren": "text", "canManageChildrenPermissions": "text", "canManageChildrenProfiles": false, "canViewAnalytics": true }, "uri": "text", "boost": { "@context": [ "text" ], "id": "text", "type": [ "text" ], "issuer": "text", "credentialSubject": { "id": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "refreshService": { "id": "text", "type": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "credentialSchema": { "id": "text", "type": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "issuanceDate": "text", "expirationDate": "text", "credentialStatus": { "type": "text", "id": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "name": "text", "description": "text", "validFrom": "text", "validUntil": "text", "status": { "type": "text", "id": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "termsOfUse": { "type": "text", "id": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "evidence": { "type": "text", "id": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "ANY_ADDITIONAL_PROPERTY": "anything" } }

POST /api/boost/create HTTP/1.1 Host: .. Authorization: Bearer YOUR_SECRET_TOKEN Content-Type: application/json Accept: */* Content-Length: 1427 { "name": "text", "type": "text", "category": "text", "status": "DRAFT", "autoConnectRecipients": true, "meta": { "ANY_ADDITIONAL_PROPERTY": "anything" }, "credential": { "@context": [ "text" ], "id": "text", "type": [ "text" ], "issuer": "text", "credentialSubject": { "id": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "refreshService": { "id": "text", "type": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "credentialSchema": { "id": "text", "type": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "issuanceDate": "text", "expirationDate": "text", "credentialStatus": { "type": "text", "id": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "name": "text", "description": "text", "validFrom": "text", "validUntil": "text", "status": { "type": "text", "id": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "termsOfUse": { "type": "text", "id": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "evidence": { "type": "text", "id": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "proof": { "type": "text", "created": "text", "challenge": "text", "domain": "text", "nonce": "text", "proofPurpose": "text", "verificationMethod": "text", "jws": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "ANY_ADDITIONAL_PROPERTY": "anything" }, "claimPermissions": { "role": "text", "canEdit": true, "canIssue": true, "canRevoke": true, "canManagePermissions": true, "canIssueChildren": "text", "canCreateChildren": "text", "canEditChildren": "text", "canRevokeChildren": "text", "canManageChildrenPermissions": "text", "canManageChildrenProfiles": false, "canViewAnalytics": true } }

POST /api/boost/send/{profileId} HTTP/1.1 Host: .. Authorization: Bearer YOUR_SECRET_TOKEN Content-Type: application/json Accept: */* Content-Length: 1027 { "uri": "text", "credential": { "@context": [ "text" ], "id": "text", "type": [ "text" ], "issuer": "text", "credentialSubject": { "id": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "refreshService": { "id": "text", "type": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "credentialSchema": { "id": "text", "type": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "issuanceDate": "text", "expirationDate": "text", "credentialStatus": { "type": "text", "id": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "name": "text", "description": "text", "validFrom": "text", "validUntil": "text", "status": { "type": "text", "id": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "termsOfUse": { "type": "text", "id": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "evidence": { "type": "text", "id": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "proof": { "type": "text", "created": "text", "challenge": "text", "domain": "text", "nonce": "text", "proofPurpose": "text", "verificationMethod": "text", "jws": "text", "ANY_ADDITIONAL_PROPERTY": "anything" }, "ANY_ADDITIONAL_PROPERTY": "anything" }, "options": { "skipNotification": false } }

Boosts

1. Create a Boost

2. Get a Boost

3. Get Boosts

4. Get Boost Recipients

5. Update a Boost

6. Delete a Boost

7. Send a Boost

Claim a Boost

1. Create a Boost

2. Get a Boost

3. Get Boosts

4. Get Boost Recipients

5. Update a Boost

6. Delete a Boost

7. Send a Boost

Claim a Boost

Get boost

Creates a boost

Send a Boost

Send a Credential