<OFJSONRepresentation> Protocol Reference

A protocol implemented by classes that support encoding to a JSON representation. More...

#include <ObjFW/ObjFW.h>

Inheritance diagram for <OFJSONRepresentation>:

Instance Methods
(OFString *)	- JSONRepresentationWithOptions:
	Returns the JSON representation of the object as a string.

Properties
OFString *	JSONRepresentation
	The JSON representation of the object as a string.

Detailed Description

A protocol implemented by classes that support encoding to a JSON representation.

Warning

Although this method can be called directly on classes other than OFArray and OFDictionary, this will generate invalid JSON, as JSON requires all data to be encapsulated in an array or a dictionary!

Method Documentation

JSONRepresentationWithOptions:

- (OFString *) JSONRepresentationWithOptions:

(OFJSONRepresentationOptions)

options

Returns the JSON representation of the object as a string.

Parameters

options

The options to use when creating a JSON representation

Returns

The JSON representation of the object as a string

---

The documentation for this protocol was generated from the following file:

• src/OFJSONRepresentation.h