Interface AppEventSubscription

interface AppEventSubscription {
    functions?: {
        filter?: Link<"Function">;
        handler?: Link<"Function">;
        transformation?: Link<"Function">;
    };
    sys: AppEventSubscriptionSys;
    targetUrl?: string;
    topics: string[];
    delete(): Promise<void>;
    toPlainObject(): AppEventSubscriptionProps;
}

Hierarchy (view full)

Properties

functions? sys targetUrl? topics

Methods

delete toPlainObject

Properties

Optionalfunctions

functions?: {
    filter?: Link<"Function">;
    handler?: Link<"Function">;
    transformation?: Link<"Function">;
}

Optional filter, transformation, or handler function

sys

sys: AppEventSubscriptionSys

System metadata

OptionaltargetUrl

targetUrl?: string

Subscription url that will receive events

topics

topics: string[]

List of topics to subscribe to

Methods

delete

  • delete(): Promise<void>

  • Deletes this object on the server.

    Returns Promise<void>

    Promise for the deletion. It contains no data, but the Promise error case should be handled.

    Example: ```javascript const contentful = require('contentful-management') const client = contentful.createClient({ accessToken: '<content_management_api_key>' }) client.getOrganization('<organization_id>') .then((organization) => organization.getAppEventSubscription(<app-definition-id>)) .then((eventSubscription) => eventSubscription.delete()) .then(() => console.log('eventSubscription deleted')) .catch(console.error) ```

toPlainObject

Settings

Member Visibility

On This Page

Properties
Methods