AppManifest

45 min

OCP App SDKOCP App SDK

OCP App SDKOCP App SDK / AppManifest

Interface: AppManifest

Defined in: src/app/types/AppManifest.ts:159

Properties

channel?

optional channel: object

Defined in: src/app/types/AppManifest.ts:191

delivery?

optional delivery: object

delivery.batch_size?

optional batch_size: number

delivery.concurrent_batches?

optional concurrent_batches: number

delivery.rate_limits?

optional rate_limits: `ChannelRateLimit`ChannelRateLimit[]

metrics?

optional metrics: object

metrics.attributable?

optional attributable: `AttributableMetric`AttributableMetric[]

metrics.delivery?

optional delivery: `DeliveryMetric`DeliveryMetric[]

metrics.disengagement?

optional disengagement: `DisengagementMetric`DisengagementMetric[]

metrics.engagement?

optional engagement: `EngagementMetric`EngagementMetric[]

metrics.reachability?

optional reachability: `ReachabilityMetric`ReachabilityMetric[]

options?

optional options: object

options.prepare?

optional prepare: boolean

options.template_preview?

optional template_preview: boolean

targeting

targeting: `CampaignTargeting`CampaignTargeting[] | "dynamic"

type

type: `ChannelType`ChannelType

consumers?

optional consumers: object

Defined in: src/app/types/AppManifest.ts:179

Index Signature

[name: string]: `AppConsumer`AppConsumer

destinations?

optional destinations: object

Defined in: src/app/types/AppManifest.ts:185

Index Signature

[name: string]: `AppDestination`AppDestination

environment?

optional environment: string[]

Defined in: src/app/types/AppManifest.ts:172

functions?

optional functions: object

Defined in: src/app/types/AppManifest.ts:173

Index Signature

[name: string]: `AppFunction`AppFunction

jobs?

optional jobs: object

Defined in: src/app/types/AppManifest.ts:176

Index Signature

[name: string]: `AppJob`AppJob

liquid_extensions?

optional liquid_extensions: object

Defined in: src/app/types/AppManifest.ts:182

Index Signature

[name: string]: `AppLiquidExtension`AppLiquidExtension

app_id

app_id: string

availability

availability: string[]

contact_email

contact_email: string

display_name

display_name: string

summary

summary: string

support_url

support_url: string

vendor

vendor: string

version

version: string

outbound_domains?

optional outbound_domains: string[]

Defined in: src/app/types/AppManifest.ts:211

runtime

runtime: `AppRuntime`AppRuntime

Defined in: src/app/types/AppManifest.ts:171

sources?

optional sources: object

Defined in: src/app/types/AppManifest.ts:188

Index Signature

[name: string]: `AppSource`AppSource

AppManifest

Interface: AppManifest

Properties

channel?

delivery?

delivery.batch_size?

delivery.concurrent_batches?

delivery.rate_limits?

metrics?

metrics.attributable?

metrics.delivery?

metrics.disengagement?

metrics.engagement?

metrics.reachability?

options?

options.prepare?

options.template_preview?

targeting

type

consumers?

Index Signature

destinations?

Index Signature

environment?

functions?

Index Signature

jobs?

Index Signature

liquid_extensions?

Index Signature

meta

app_id

availability

categories

contact_email

display_name

summary

support_url

vendor

version

outbound_domains?

runtime

sources?

Index Signature