The callback invoked when setting a property’s value.
SDKs
- iOS 7.0+
- macOS 10.5+
- Mac Catalyst 13.0+
- tvOS 9.0+
Framework
- Java
Script Core
Declaration
typealias JSObjectSetPropertyCallback = (JSContext Ref?, JSObject Ref?, JSString Ref?, JSValue Ref?, Unsafe Mutable Pointer<JSValue Ref?>?) -> Bool
Parameters
ctx
The execution context to use.
object
The JSObject on which to set the property's value.
propertyName
A JSString containing the name of the property to set.
value
A JSValue to use as the property's value.
exception
A pointer to a JSValueRef in which to return an exception, if any.
Return Value
true
if the property was set, otherwise false
.
Discussion
If you named your function Set
, you would declare it like this:
bool SetProperty(JSContextRef ctx, JSObjectRef object, JSStringRef propertyName, JSValueRef value, JSValueRef* exception);
If this function returns false, the set request forwards to object's statically declared properties, then its parent class chain (which includes the default object class).