PassMessageToCUWOOperation

PassMessageToCUWOOperation is an operation of the "parent/child CUWOs" API and allows a CUWO to send a message to another CUWO.

The message is defined as follows:

/**
 * Operation of the "parent/child CUWOs" API that sends a message to another CUWO.
 */
class PassMessageToCUWOOperation extends AbstractMessage {
    readonly "@type" : string = "n4.cuwo.messages.parentchild.PassMessageToCUWOOperation";

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

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

    /**
     * The message to send to the CUWO.
     */
    public message : string;
}

Here's an example NFON:

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

Success result

On success, the OperationFinished message will contain a PassMessageToCUWOSuccess result.

The structure is defined as follows:

/**
 * Data structure returned by the "pass message to cuwo" operation of the
 * "parent/child CUWOs" API on success.
 */
class PassMessageToCUWOSuccess {
    readonly "@type" : string = "n4.cuwo.messages.parentchild.results.PassMessageToCUWOSuccess";
}

Failure result

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

The structure is defined as follows:

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

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

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