v8  4.5.103(node4.8.4)
V8 is Google's open source JavaScript engine
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< ObjectNewInstance (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< ObjectTemplateNew (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

int InternalFieldCount ( )

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

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.

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

Creates an ObjectTemplate.

V8_WARN_UNUSED_RESULT MaybeLocal<Object> NewInstance ( Local< Context context)
void SetAccessCheckCallbacks ( NamedSecurityCallback  named_handler,
IndexedSecurityCallback  indexed_handler,
Local< Value data = LocalValue >() 
)

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.

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

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
nameThe name of the property for which an accessor is added.
getterThe callback to invoke when getting the property.
setterThe callback to invoke when setting the property.
dataA piece of data that will be passed to the getter and setter callbacks whenever they are invoked.
settingsAccess 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.
attributeThe attributes of the property for which an accessor is added.
signatureThe 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.
void SetAccessor ( Local< Name name,
AccessorNameGetterCallback  getter,
AccessorNameSetterCallback  setter = 0,
Local< Value data = LocalValue >(),
AccessControl  settings = DEFAULT,
PropertyAttribute  attribute = None,
Local< AccessorSignature signature = LocalAccessorSignature >() 
)
void SetCallAsFunctionHandler ( FunctionCallback  callback,
Local< Value data = LocalValue >() 
)

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.

void SetHandler ( const NamedPropertyHandlerConfiguration configuration)
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
getterThe callback to invoke when getting a property.
setterThe callback to invoke when setting a property.
queryThe callback to invoke to check if an object has a property.
deleterThe callback to invoke when deleting a property.
enumeratorThe callback to invoke to enumerate all the indexed properties of an object.
dataA piece of data that will be passed to the callbacks whenever they are invoked.

Referenced by ObjectTemplate::SetIndexedPropertyHandler().

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

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

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

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
getterThe callback to invoke when getting a property.
setterThe callback to invoke when setting a property.
queryThe callback to invoke to check if a property is present, and if present, get its attributes.
deleterThe callback to invoke when deleting a property.
enumeratorThe callback to invoke to enumerate all the named properties of an object.
dataA piece of data that will be passed to the callbacks whenever they are invoked.
static V8_DEPRECATE_SOON ( "Use isolate version"  ,
Local< ObjectTemplate >   New() 
)
static
V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< Object >   NewInstance() 
)

Creates a new instance of this template.

Friends And Related Function Documentation

friend class FunctionTemplate
friend

Definition at line 4666 of file v8.h.


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