TerminateChildCUWOOperation

TerminateChildCUWOOperation is an operation of the "parent/child CUWOs" API and allows a parent CUWO to terminate one of its child CUWOs.

The message is defined as follows:

/**
 * Operation of the "parent/child CUWOs" API that terminates
 * a CUWO spawned via a "spawn ... CUWO" opepration.
 */
class TerminateChildCUWOOperation extends AbstractMessage {
    readonly "@type" : string = "n4.cuwo.messages.parentchild.TerminateChildCUWOOperation";

    /**
     * The ID of the operation message.
     */
    public id : string;

    /**
     * The handle of the CUWO to terminate.
     */
    public cuwoHandle : string;

Here's an example NFON:

{
  "@type": "n4.cuwo.messages.parentchild.TerminateChildCUWOOperation",
  "id": "0e5e526c-35a2-11ec-8d3d-0242ac130003",
  "cuwoHandle": "pgPdiUF11JL7xaBWbHeV"
}

Success result

On success, the OperationFinished message will contain a TerminateChildCUWOSuccess result. This result holds the result data of the terminated CUWO when available.

The structure is defined as follows:

/**
 * Data structure returned by the "terminate child CUWO" operation of the
 * "parent/child CUWOs" API on success.
 */
class TerminateChildCUWOSuccess {
    readonly "@type" : string = "n4.cuwo.messages.parentchild.results.TerminateCUWOSuccess";

    /**
     * Result data that the terminated CUWO provided.
     */
    public resultData? : string;
}

Failure result

On failure, the OperationFinished message will contain a TerminateChildCUWOFailure result holding an error code and a debug message.

The structure is defined as follows:

/**
 * Data structure returned by the "terminate child CUWO" operation of the
 * "parent/child CUWOs" API on failure.
 * 
 * Holds the failure code and an optional debug message.
 */
class TerminateChildCUWOFailure {
    readonly "@type" : string = "n4.cuwo.messages.parentchild.results.TerminateChildCUWOFailure";

    /**
     * A code indicating the reason for the failure.
     */
    public failureCode : FailureCode;

    /**
     * A debug message providing more information about the failure.
     */
    public debugMessage? : string;
}