@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Class ActionNotAllowedError

    Error thrown when an update_media_buy request is rejected because the action it maps to isn't currently allowed on the buy (AdCP 3.1, RFC #4480).

    Typed details payload follows error-details/action-not-allowed.json: attempted_action, reason, optional currently_available_actions[].

    Recovery branches on reason:

    • wrong_status: transition the buy (or wait) to an allowed status.
    • not_supported_on_product: terminal for this buy; pick a different product for future buys that need the action.
    • not_supported_on_buy: terminal; renegotiate buy terms.
    • mode_mismatch: recovery is set to a typed hint indicating the required flow (createProposal, waitForApproval, reissueAsDirect) instead of a plain retry.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    details?: unknown
    code: "ACTION_NOT_ALLOWED" = 'ACTION_NOT_ALLOWED'
    attemptedAction: string
    currentlyAvailableActions: readonly ActionNotAllowedAvailableAction[]
    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    cause?: unknown
    name: string
    message: string
    stack?: string

    Methods

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack; // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
      b();
      }

      function b() {
      c();
      }

      function c() {
      // Create an error without stack trace to avoid calculating the stack trace twice.
      const { stackTraceLimit } = Error;
      Error.stackTraceLimit = 0;
      const error = new Error();
      Error.stackTraceLimit = stackTraceLimit;

      // Capture the stack trace above function b
      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
      throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void