Class Partnerships

Hierarchy

Partnerships

Index

Constructors

Methods

addPartnership createPartnership getPartnerships loadRelatedPartnerships unloadAllPartnerships

Constructors

constructor

new Partnerships(auth: Authenticate, options?: ApiOptions): Partnerships
Parameters
- auth: Authenticate
- Optional options: ApiOptions
Returns Partnerships
- Defined in packages/partnerships/src/lib/partnerships.ts:20

Properties

`Private` api

api: PartnershipsApi

`Private` auth

auth: Authenticate

`Private` partnerships

partnerships: Partnership[] = []

Methods

addPartnership

addPartnership(campaignReference: CampaignReference): Promise<Partnership[]>
Add Campaign to Partnerships and load new index for the given authenticated DID that is relative to the chain of the Campaign
1. Creates a new partnership stream
2. Adds partnership stream to the DID Data Store
Returns
[return description]
Parameters
- campaignReference: CampaignReference
  
  new partnership to add
Returns Promise<Partnership[]>
- Defined in packages/partnerships/src/lib/partnerships.ts:76

`Private` createPartnership

createPartnership(walletAuth: WalletAuth, campaignReference: CampaignReference): Promise<{
campaign: CampaignReference;
id: string;
}>
Parameters
- walletAuth: WalletAuth
- campaignReference: CampaignReference
Returns Promise<{
campaign: CampaignReference;
id: string;
}>
- Defined in packages/partnerships/src/lib/partnerships.ts:29

getPartnerships

getPartnerships(): Partnership[]
Returns Partnership[]
- Defined in packages/partnerships/src/lib/partnerships.ts:25

loadRelatedPartnerships

loadRelatedPartnerships(): Promise<Partnership[]>
Load all partnerships owned and indexed by related DIDs

Returns Promise<Partnership[]>
- Defined in packages/partnerships/src/lib/partnerships.ts:124

unloadAllPartnerships

unloadAllPartnerships(): void
Returns void
- Defined in packages/partnerships/src/lib/partnerships.ts:117

Generated using TypeDoc