ObjectTemplate Class Reference

#include <v8.h>

Inheritance diagram for ObjectTemplate:

Collaboration diagram for ObjectTemplate:

Public Member Functions
	V8_DEPRECATE_SOON ("Use maybe version", Local< Object > NewInstance())
V8_WARN_UNUSED_RESULT MaybeLocal< Object >	NewInstance (Local< Context > context)
void	SetAccessor (Local< String > name, AccessorGetterCallback getter, AccessorSetterCallback setter=0, Local< Value > data=Local< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None, Local< AccessorSignature > signature=Local< AccessorSignature >())
void	SetAccessor (Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=0, Local< Value > data=Local< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None, Local< AccessorSignature > signature=Local< AccessorSignature >())
void	SetNamedPropertyHandler (NamedPropertyGetterCallback getter, NamedPropertySetterCallback setter=0, NamedPropertyQueryCallback query=0, NamedPropertyDeleterCallback deleter=0, NamedPropertyEnumeratorCallback enumerator=0, Local< Value > data=Local< Value >())
void	SetHandler (const NamedPropertyHandlerConfiguration &configuration)
void	SetHandler (const IndexedPropertyHandlerConfiguration &configuration)
void	SetIndexedPropertyHandler (IndexedPropertyGetterCallback getter, IndexedPropertySetterCallback setter=0, IndexedPropertyQueryCallback query=0, IndexedPropertyDeleterCallback deleter=0, IndexedPropertyEnumeratorCallback enumerator=0, Local< Value > data=Local< Value >())
void	SetCallAsFunctionHandler (FunctionCallback callback, Local< Value > data=Local< Value >())
void	MarkAsUndetectable ()
void	SetAccessCheckCallbacks (NamedSecurityCallback named_handler, IndexedSecurityCallback indexed_handler, Local< Value > data=Local< Value >())
int	InternalFieldCount ()
void	SetInternalFieldCount (int value)
Public Member Functions inherited from Template
void	Set (Local< Name > name, Local< Data > value, PropertyAttribute attributes=None)
V8_INLINE void	Set (Isolate *isolate, const char *name, Local< Data > value)
void	SetAccessorProperty (Local< Name > name, Local< FunctionTemplate > getter=Local< FunctionTemplate >(), Local< FunctionTemplate > setter=Local< FunctionTemplate >(), PropertyAttribute attribute=None, AccessControl settings=DEFAULT)
void	SetNativeDataProperty (Local< String > name, AccessorGetterCallback getter, AccessorSetterCallback setter=0, Local< Value > data=Local< Value >(), PropertyAttribute attribute=None, Local< AccessorSignature > signature=Local< AccessorSignature >(), AccessControl settings=DEFAULT)
void	SetNativeDataProperty (Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=0, Local< Value > data=Local< Value >(), PropertyAttribute attribute=None, Local< AccessorSignature > signature=Local< AccessorSignature >(), AccessControl settings=DEFAULT)

Static Public Member Functions
static Local< ObjectTemplate >	New (Isolate *isolate, Local< FunctionTemplate > constructor=Local< FunctionTemplate >())
static	V8_DEPRECATE_SOON ("Use isolate version", Local< ObjectTemplate > New())

Friends
class	FunctionTemplate

Detailed Description

An ObjectTemplate is used to create objects at runtime.

Properties added to an ObjectTemplate are added to each object created from the ObjectTemplate.

Definition at line 4510 of file v8.h.

Member Function Documentation

InternalFieldCount()

int InternalFieldCount

(

)

Gets the number of internal fields for objects generated from this template.

MarkAsUndetectable()

void MarkAsUndetectable

(

)

Mark object instances of the template as undetectable.

In many ways, undetectable objects behave as though they are not there. They behave like 'undefined' in conditionals and when printed. However, properties can be accessed and called as on normal objects.

New()

static Local<ObjectTemplate> New ( Isolate *  isolate, Local< FunctionTemplate >  constructor = Local< FunctionTemplate >()  )

static

Creates an ObjectTemplate.

NewInstance()

V8_WARN_UNUSED_RESULT MaybeLocal<Object> NewInstance

(

Local< Context >

context

)

SetAccessCheckCallbacks()

void SetAccessCheckCallbacks	(	NamedSecurityCallback	named_handler,
		IndexedSecurityCallback	indexed_handler,
		Local< Value >	data = Local< Value >()
	)

Sets access check callbacks on the object template and enables access checks.

When accessing properties on instances of this object template, the access check callback will be called to determine whether or not to allow cross-context access to the properties.

SetAccessor() [1/2]

void SetAccessor	(	Local< Name >	name,
		AccessorNameGetterCallback	getter,
		AccessorNameSetterCallback	setter = 0,
		Local< Value >	data = Local< Value >(),
		AccessControl	settings = DEFAULT,
		PropertyAttribute	attribute = None,
		Local< AccessorSignature >	signature = Local< AccessorSignature >()
	)

SetAccessor() [2/2]

void SetAccessor	(	Local< String >	name,
		AccessorGetterCallback	getter,
		AccessorSetterCallback	setter = 0,
		Local< Value >	data = Local< Value >(),
		AccessControl	settings = DEFAULT,
		PropertyAttribute	attribute = None,
		Local< AccessorSignature >	signature = Local< AccessorSignature >()
	)

Sets an accessor on the object template.

Whenever the property with the given name is accessed on objects created from this ObjectTemplate the getter and setter callbacks are called instead of getting and setting the property directly on the JavaScript object.

Parameters

name	The name of the property for which an accessor is added.
getter	The callback to invoke when getting the property.
setter	The callback to invoke when setting the property.
data	A piece of data that will be passed to the getter and setter callbacks whenever they are invoked.
settings	Access control settings for the accessor. This is a bit field consisting of one of more of DEFAULT = 0, ALL_CAN_READ = 1, or ALL_CAN_WRITE = 2. The default is to not allow cross-context access. ALL_CAN_READ means that all cross-context reads are allowed. ALL_CAN_WRITE means that all cross-context writes are allowed. The combination ALL_CAN_READ | ALL_CAN_WRITE can be used to allow all cross-context access.
attribute	The attributes of the property for which an accessor is added.
signature	The signature describes valid receivers for the accessor and is used to perform implicit instance checks against them. If the receiver is incompatible (i.e. is not an instance of the constructor as defined by FunctionTemplate::HasInstance()), an implicit TypeError is thrown and no callback is invoked.

SetCallAsFunctionHandler()

void SetCallAsFunctionHandler	(	FunctionCallback	callback,
		Local< Value >	data = Local< Value >()
	)

Sets the callback to be used when calling instances created from this template as a function. If no callback is set, instances behave like normal JavaScript objects that cannot be called as a function.

SetHandler() [1/2]

void SetHandler

(

const IndexedPropertyHandlerConfiguration &

configuration

)

Sets an indexed property handler on the object template.

Whenever an indexed property is accessed on objects created from this object template, the provided callback is invoked instead of accessing the property directly on the JavaScript object.

Parameters

getter	The callback to invoke when getting a property.
setter	The callback to invoke when setting a property.
query	The callback to invoke to check if an object has a property.
deleter	The callback to invoke when deleting a property.
enumerator	The callback to invoke to enumerate all the indexed properties of an object.
data	A piece of data that will be passed to the callbacks whenever they are invoked.

Referenced by ObjectTemplate::SetIndexedPropertyHandler().

SetHandler() [2/2]

void SetHandler

(

const NamedPropertyHandlerConfiguration &

configuration

)

SetIndexedPropertyHandler()

void SetIndexedPropertyHandler ( IndexedPropertyGetterCallback  getter, IndexedPropertySetterCallback  setter = 0, IndexedPropertyQueryCallback  query = 0, IndexedPropertyDeleterCallback  deleter = 0, IndexedPropertyEnumeratorCallback  enumerator = 0, Local< Value >  data = Local<Value>()  )

inline

Definition at line 4609 of file v8.h.

References IndexedPropertyHandlerConfiguration::IndexedPropertyHandlerConfiguration(), and ObjectTemplate::SetHandler().

SetInternalFieldCount()

void SetInternalFieldCount

(

int

value

)

Sets the number of internal fields for objects generated from this template.

SetNamedPropertyHandler()

void SetNamedPropertyHandler	(	NamedPropertyGetterCallback	getter,
		NamedPropertySetterCallback	setter = 0,
		NamedPropertyQueryCallback	query = 0,
		NamedPropertyDeleterCallback	deleter = 0,
		NamedPropertyEnumeratorCallback	enumerator = 0,
		Local< Value >	data = Local< Value >()
	)

Sets a named property handler on the object template.

Whenever a property whose name is a string is accessed on objects created from this object template, the provided callback is invoked instead of accessing the property directly on the JavaScript object.

Note that new code should use the second version that can intercept symbol-named properties as well as string-named properties.

Parameters

getter	The callback to invoke when getting a property.
setter	The callback to invoke when setting a property.
query	The callback to invoke to check if a property is present, and if present, get its attributes.
deleter	The callback to invoke when deleting a property.
enumerator	The callback to invoke to enumerate all the named properties of an object.
data	A piece of data that will be passed to the callbacks whenever they are invoked.

V8_DEPRECATE_SOON() [1/2]

static V8_DEPRECATE_SOON ( "Use isolate version"  , Local< ObjectTemplate >   New()  )

static

V8_DEPRECATE_SOON() [2/2]

V8_DEPRECATE_SOON	(	"Use maybe version"	,
		Local< Object >	NewInstance()
	)

Creates a new instance of this template.

Friends And Related Function Documentation

FunctionTemplate

friend class FunctionTemplate

friend

Definition at line 4666 of file v8.h.

---

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

• include/v8.h