Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

PLACEHOLDER PAGE FOR GET EMBEDDED OBJECT TO LINK TO

Step-by-step guide

 

...

When you need entity-level metadata, you can get it based on Entity ID, Entity Name, or GE Object.

  1. Get Entity Metadata when you already have a GE Object. This is a synchronous function that returns the entity metadata.

    Code Block
    // Assumes you already have a variable called 'ge' holding a GE Object.
    var entityMd = ge.entityMetaData();
  2. Get Entity Metadata knowing the Entity Name using Aptify.framework.metaData.entities.loadEntity(). This is an asynchronous function that passes the entity metadata into its callback.

    Code Block
    var entityName = "Persons";
     
    Aptify.framework.metaData.entities.loadEntity(entityName, function (entityMd) {
    	// entityMd contains the entity metadata
    });
  3. Get Entity Metadata knowing the Entity ID using Aptify.framework.metaData.entities.loadEntityById(). This is an asynchronous function that passes the entity metadata into its callback.

    Note

    Because Entity IDs are not reliable cross-database, we don't recommend this as a primary approach. However, when you are in a situation in which some other part of the system has provided the Entity ID, this method is handy.

    Code Block
    var entityId = 1006;
     
    Aptify.framework.metaData.entities.loadEntityById(entityId, function (entityMd) {
    	// entityMd contains the entity metadata
    });

 

Filter by label (Content by label)
showLabelsfalse
max5
spacesRDPK55
sortmodified
showSpacefalse
reversetrue
typepage
labelsgeneric-entity metadata aptify-javascript-api nonvisual-javascript-api