Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 1.34 KB

Campaign.md

File metadata and controls

62 lines (39 loc) · 1.34 KB

Campaign

properties:

property type
id string
title string
description string | null
startDate Date | null
endDate Date | null
isHidden boolean
referenceId string
budget Budget | null
labels Label[] | null

methods:

getRelatedLinks

parameteres: (None)

returns: { self: string; brief: string | null; owner: string | null; parentCampaign: string | null; childCampaigns: [string]; }

getBrief

parameteres: (None)

returns: Promise<CampaignBrief | null>

Gets the campaigns brief if it has one.

getOwner

parameteres: (None)

returns: Promise<User | null>

Gets the campaigns owner. If the campaign has no owner, it will return null promise.

getChildCampaigns

parameteres: (None)

returns: Promise<Campaign[]>

Gets the child campaigns of the campaign.

getParentCampaign

parameteres: (None)

returns: Promise<Campaign | null>

Gets the parent campaign of the campaign.