Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AppAction

Hierarchy

Index

Properties

Methods

Properties

category

category: AppActionCategory

Category identifying the shape of the action. Choose "Custom" for custom schema

name

name: string

Human readable name for the action

Optional parameters

parameters?: AppActionParameterDefinition[]

An optional schema for which body parameters need to be provided when calling the action

sys

sys: AppActionSys

System metadata

url

url: string

Url that will be called when the action is invoked

Methods

delete

  • delete(): Promise<void>

  • Deletes this object on the server.

    example
    const contentful = require('contentful-management')

    const client = contentful.createClient({
      accessToken: '<content_management_api_key>'
    })

    client.getOrganization('<org_id>')
    .then((org) => org.getAppDefinition('<app_def_id>'))
    .then((appDefinition) => appDefinition.getAppAction('<app-action-id>'))
    .then((appAction) => appAction.delete())
    .catch(console.error)

    Returns Promise<void>

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

toPlainObject