Class Campaigns

Hierarchy

Campaigns

Index

Constructors

constructor

new Campaigns(options?: Partial<ApiOptions>): Campaigns
Parameters
- Optional options: Partial<ApiOptions>
Returns Campaigns
- Defined in packages/campaigns/src/lib/campaigns.ts:22

Properties

`Private` `Readonly` api

api: CampaignsApi

`Private` `Readonly` options

options: ApiOptions

Methods

createAdvertiser

createAdvertiser(advertiser: {
    description: string;
    externalLink: string;
    icon: string;
    name: string;
    twitter: undefined | string;
}, did: DID): Promise<TileDocument<{
    description: string;
    external_link: string;
    icon: string;
    name: string;
    twitter: undefined | string;
}>>
Parameters
- advertiser: {
      description: string;
      externalLink: string;
      icon: string;
      name: string;
      twitter: undefined | string;
  }
  - description: string
  - externalLink: string
  - icon: string
  - name: string
  - twitter: undefined | string
- did: DID
Returns Promise<TileDocument<{
    description: string;
    external_link: string;
    icon: string;
    name: string;
    twitter: undefined | string;
}>>
- Defined in packages/campaigns/src/lib/campaigns.ts:37

createCampaign

createCampaign(campaign: {
    advertiser: string;
    chain: Chains;
    details: string;
    disableVerification: undefined | boolean;
    events: ({ description?: string | undefined; nativeLimit?: number | undefined; perCommit?: number | undefined; contractAddress?: string | undefined; contractEvent?: string | undefined; strategy: CampaignStrategies; rate: number; })[];
    id: undefined | string;
    owner: undefined | string;
    reward: { address?: string | undefined; name: string; type: RewardTypes; ticker: string; };
}, privateKey: string, options?: {
    bundlrUrl?: string;
    currency?: string;
}): Promise<any>
Parameters
- campaign: {
      advertiser: string;
      chain: Chains;
      details: string;
      disableVerification: undefined | boolean;
      events: ({ description?: string | undefined; nativeLimit?: number | undefined; perCommit?: number | undefined; contractAddress?: string | undefined; contractEvent?: string | undefined; strategy: CampaignStrategies; rate: number; })[];
      id: undefined | string;
      owner: undefined | string;
      reward: { address?: string | undefined; name: string; type: RewardTypes; ticker: string; };
  }
  - advertiser: string
  - chain: Chains
  - details: string
  - disableVerification: undefined | boolean
  - events: ({ description?: string | undefined; nativeLimit?: number | undefined; perCommit?: number | undefined; contractAddress?: string | undefined; contractEvent?: string | undefined; strategy: CampaignStrategies; rate: number; })[]
  - id: undefined | string
  - owner: undefined | string
  - reward: { address?: string | undefined; name: string; type: RewardTypes; ticker: string; }
- privateKey: string
- Optional options: {
  bundlrUrl?: string;
  currency?: string;
  }
  - Optional bundlrUrl?: string
  - Optional currency?: string
Returns Promise<any>
- Defined in packages/campaigns/src/lib/campaigns.ts:67

createCampaignDetails

createCampaignDetails(campaignDetails: {
    description: undefined | string;
    destinationUrl: string;
    externalLink: undefined | string;
    image: undefined | string;
    name: string;
}, did: DID): Promise<TileDocument<{
    description: undefined | string;
    destination_url: string;
    external_link: undefined | string;
    image: undefined | string;
    name: string;
}>>
Parameters
- campaignDetails: {
      description: undefined | string;
      destinationUrl: string;
      externalLink: undefined | string;
      image: undefined | string;
      name: string;
  }
  - description: undefined | string
  - destinationUrl: string
  - externalLink: undefined | string
  - image: undefined | string
  - name: string
- did: DID
Returns Promise<TileDocument<{
    description: undefined | string;
    destination_url: string;
    external_link: undefined | string;
    image: undefined | string;
    name: string;
}>>
- Defined in packages/campaigns/src/lib/campaigns.ts:50

getCampaigns

getCampaigns(refs: CampaignReference[]): Promise<Campaign[]>
Parameters
- refs: CampaignReference[]
Returns Promise<Campaign[]>
- Defined in packages/campaigns/src/lib/campaigns.ts:27

indexCampaign

indexCampaign(transactionId: string): Promise<{
campaign: Campaign;
success: boolean;
}>
Parameters
- transactionId: string
Returns Promise<{
campaign: Campaign;
success: boolean;
}>
- Defined in packages/campaigns/src/lib/campaigns.ts:102

Class Campaigns

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: Partial<ApiOptions>

Returns Campaigns

Properties

Private Readonly api

Private Readonly options

Methods

createAdvertiser

Parameters

advertiser: { description: string; externalLink: string; icon: string; name: string; twitter: undefined | string; }

description: string

externalLink: string

icon: string

name: string

twitter: undefined | string

did: DID

Returns Promise<TileDocument<{ description: string; external_link: string; icon: string; name: string; twitter: undefined | string; }>>

createCampaign

Parameters

advertiser: string

chain: Chains

details: string

disableVerification: undefined | boolean

events: ({ description?: string | undefined; nativeLimit?: number | undefined; perCommit?: number | undefined; contractAddress?: string | undefined; contractEvent?: string | undefined; strategy: CampaignStrategies; rate: number; })[]

id: undefined | string

owner: undefined | string

reward: { address?: string | undefined; name: string; type: RewardTypes; ticker: string; }

privateKey: string

Optional options: { bundlrUrl?: string; currency?: string; }

Optional bundlrUrl?: string

Optional currency?: string

Returns Promise<any>

createCampaignDetails

Parameters

campaignDetails: { description: undefined | string; destinationUrl: string; externalLink: undefined | string; image: undefined | string; name: string; }

description: undefined | string

destinationUrl: string

externalLink: undefined | string

image: undefined | string

name: string

did: DID

Returns Promise<TileDocument<{ description: undefined | string; destination_url: string; external_link: undefined | string; image: undefined | string; name: string; }>>

getCampaigns

Parameters

refs: CampaignReference[]

Returns Promise<Campaign[]>

indexCampaign

Parameters

transactionId: string

Returns Promise<{ campaign: Campaign; success: boolean; }>

Settings

Member Visibility

Theme

`Optional` options: Partial<ApiOptions>

`Private` `Readonly` api

`Private` `Readonly` options

advertiser: {
description: string;
externalLink: string;
icon: string;
name: string;
twitter: undefined | string;
}

Returns Promise<TileDocument<{
description: string;
external_link: string;
icon: string;
name: string;
twitter: undefined | string;
}>>

`Optional` options: {
bundlrUrl?: string;
currency?: string;
}

`Optional` bundlrUrl?: string

`Optional` currency?: string

campaignDetails: {
description: undefined | string;
destinationUrl: string;
externalLink: undefined | string;
image: undefined | string;
name: string;
}

Returns Promise<TileDocument<{
description: undefined | string;
destination_url: string;
external_link: undefined | string;
image: undefined | string;
name: string;
}>>

Returns Promise<{
campaign: Campaign;
success: boolean;
}>