Skip to main content

AppFunctionView

One function an installed app runs inside ARC (a hook such as delivery.options.filter), and whether it is on.

type AppFunctionView {
activationId: ID!
appVersionId: ID
disabledReason: String
enabled: Boolean!
hook: String!
updatedAt: DateTime!
version: String
}

Fields​

AppFunctionView.activationId ● ID! non-null scalar​

The function's activation id.

AppFunctionView.appVersionId ● ID scalar​

The app version that shipped the function; empty if it can no longer be read.

AppFunctionView.disabledReason ● String scalar​

Why it is off: admin, uninstalled, not_in_version or scope_not_granted. Empty while on.

AppFunctionView.enabled ● Boolean! non-null scalar​

Whether the function runs.

AppFunctionView.hook ● String! non-null scalar​

The hook the function runs on, e.g. delivery.options.filter.

AppFunctionView.updatedAt ● DateTime! non-null scalar​

When the function was last switched or upgraded.

AppFunctionView.version ● String scalar​

That version's number, e.g. 1.2.0.

Returned By​

appInstallationFunctions query ● setAppFunctionEnabled mutation