Set the payload to nil to avoid any payload. The last chance to cancel sending the message, or change the URL, HTTP action, payload, or MIME type for the send. This is a more detailed description of the RESTMessage_MTC class.

The surrogate will raise all the events that the message would as if you had used AddHandler to map the message's events. In those cases, you can create a RESTMessageSurrogate_MTC (see below) instead and send the message through it. For example, if you need to save multiple records in a row. There are times when it is not appropriate to have a single instance of a particular message. The ResponseReceived event will let you know when the server has responded and, if you choose, let you deal with the payload directly. The class will automatically create an instance and fill in the properties for you. You can create a User class with properties FirstName As Text, LastName As Text, and Age As Integer, then create a property in the message ReturnUser As User. For example, suppose you expect JSON from the server that looks like this: RESTMessage_MTC will attempt to deserialize a JSON object into a class. For example, if you expect an image to be returned as Base64-encoded, you can use that event to decode it, store the resulting image in a ReturnImage property, then return True to prevent RESTMessage_MTC from processing the value further. You can also use the IncomingPayloadValueToProperty event to 'massage' a value or store it elsewhere. You can adjust the prefix through the Options (see below). If you expect information back from the server in the form of JSON, you can create properties with the prefix of 'Return', e.g., ReturnSuccess, ReturnFirstName, etc., and the return payload will be parsed into those properties. In the CancelSend event you can cancel the send or change the URL, payload, or MIME type. You can also use the ExcludeFromOutgoingPayload event to exclude a property or modify the key or value that will be included. If the REST server communicates with JSON, you can create properties in the message that correspond to the object keys. Each message must implement the GetURLPattern event (see below) and should implement the GetRESTType event.

You might create one message that will login, another that will get a list of information, another to save some data. Basic UseĪt its most basic, you need to create a 'message' for each type of interaction with your RESTful server by subclassing RESTMessage_MTC. Xojo won't like it and will probably show all sorts of odd errors. Important: Do not drag the REST Resources folder directly from the folder into your project. Open the enclosed harness project and copy-and-paste the REST Resources folder into your own project. This framework attempts to make the job a bit easier by allowing you to create 'messages' by subclassing the main class and implementing various events. As such, creating classes that work with a variety can be tricky and time-consuming, and tend to make you to work directly with JSON or other raw data. There is no standard for RESTful servers.

Xojo classes examples