ReturnEventData

public class ReturnEventData : CommunicationEventData

Undocumented

Public attributes.

  • The result value to be returned (any JSON data type). The value is nil, if operation execution yielded an error.

    Declaration

    Swift

    public var result: ReturnResult?

  • Defines additional information about the execution environment (any JSON value) such as the execution time of the operation or the ID of the operated control unit (optional).

    Declaration

    Swift

    public var executionInfo: ExecutionInfo?

  • The error object to be returned in case the operation call yielded an error (optional). The value is nil if the operation executed successfully.

    The error object consists of two properties: code, message.

    The error code given is an integer that indicates the error type that occurred, either a predefined error or an application defined one. Predefined error codes are defined by the RemoteCallErrorCode enum. Predefined error codes are within the range -32768 to -32000. Application defined error codes must be defined outside this range.

    The error message provides a short description of the error. Predefined error messages exist for all predefined error codes (see enum RemoteCallErrorMessage).

    Declaration

    Swift

    public var error: ReturnError?

Codable methods.

  • Undocumented

    Declaration

    Swift

    override public func encode(to encoder: Encoder) throws