Dev Guide
Dev GuideUser GuideGitHubNuGetDevCommunitySubmit a ticketLog In
GitHubNuGetDevCommunitySubmit a ticket

AppManifest

OCP App SDK / AppManifest

AppManifest

Index

Properties

Properties

channel?

object

{
    delivery?: {
        batch_size?: number;
        concurrent_batches?: number;
        rate_limits?: ChannelRateLimit[];
    };
    metrics?: {
        attributable?: AttributableMetric[];
        delivery?: DeliveryMetric[];
        disengagement?: DisengagementMetric[];
        engagement?: EngagementMetric[];
        reachability?: ReachabilityMetric[];
    };
    options?: {
        prepare?: boolean;
        template_preview?: boolean;
    };
    targeting: CampaignTargeting[] | "dynamic";
    type: ChannelType;
}

Type declaration

MemberType
delivery?object
delivery.batch_size?number
delivery.concurrent_batches?number
delivery.rate_limits?ChannelRateLimit[]
metrics?object
metrics.attributable?AttributableMetric[]
metrics.delivery?DeliveryMetric[]
metrics.disengagement?DisengagementMetric[]
metrics.engagement?EngagementMetric[]
metrics.reachability?ReachabilityMetric[]
options?object
options.prepare?boolean
options.template_preview?boolean
targetingCampaignTargeting[] | "dynamic"
typeChannelType

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

consumers?

object

Index signature

[name: string]: AppConsumer

Type declaration

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

environment?

string[]

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

functions?

object

Index signature

[name: string]: AppFunction

Type declaration

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

jobs?

object

Index signature

[name: string]: AppJob

Type declaration

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

liquid_extensions?

object

Index signature

[name: string]: AppLiquidExtension

Type declaration

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

meta

object

{
    app_id: string;
    availability: string[];
    categories: AppCategory[];
    contact_email: string;
    display_name: string;
    summary: string;
    support_url: string;
    vendor: string;
    version: string;
}

Type declaration

MemberType
app_idstring
availabilitystring[]
categoriesAppCategory[]
contact_emailstring
display_namestring
summarystring
support_urlstring
vendorstring
versionstring

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

outbound_domains?

string[]

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

runtime

AppRuntime

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