Class Entities

Hierarchy

Constructors

constructor

Methods

amount create delete deleteEntityData deleteField deleteIndex edit editEntityData editSchemaIndex emptyEntityData getEntityData info list renameField sendEntityData updateField

Constructors

constructor

Methods

amount

  • amount(entityID): Promise<number>

  • Get amount of data stored in the Device.

    Parameters

    • entityID: string

      Entity ID

    Returns Promise<number>

create

  • create(entityObj): Promise<{
        id: string;
    }>

  • Generate a new entity for the account.

    Parameters

    Returns Promise<{
        id: string;
    }>

delete

  • delete(entityID): Promise<string>

  • Deletes an entity from the account

    Parameters

    • entityID: string

      Entity ID

    Returns Promise<string>

deleteEntityData

  • deleteEntityData(entityID, itemsToDelete): Promise<string>

  • Delete data records in a entity using the profile token and entity ID.

    See the example to understand how to use this method properly to have full control on what to delete.

    Parameters

    • entityID: string

      Entity ID.

    • itemsToDelete: {
          ids: string[];
      }

      Items to be deleted.

      • ids: string[]

    Returns Promise<string>

    Success message indicating amount of records deleted (can be 0).

    Example

    await Resources.entities.deleteEntityData("myEntityID", { ids: ["idOfTheRecord1", "idOfTheRecord2"] });

deleteField

  • deleteField(entityID, field): Promise<string>

  • Delete a field from the entity schema

    Parameters

    • entityID: string

      entity ID

    • field: string

      field name to be deleted

    Returns Promise<string>

    Success message

deleteIndex

  • deleteIndex(entityID, index): Promise<string>

  • Delete a index from the entity schema

    Parameters

    • entityID: string

      entity ID

    • index: string

      index name to be deleted

    Returns Promise<string>

    Success message

edit

  • edit(entityID, entityObj): Promise<string>

  • Modify any property of the entity

    Parameters

    • entityID: string

      Entity ID

    • entityObj: Partial<EntityCreateInfo>

      Entity object with fields to replace

    Returns Promise<string>

editEntityData

  • editEntityData(entityID, updatedData): Promise<string>

  • Edit data records in a entity using the profile token and entity ID.

    The updatedData can be a single data record or an array of records to be updated, each of the records must have the id of the record and the fields to be updated.

    Parameters

    • entityID: string

      Entity ID.

    • updatedData: {
          id: string;
      } & Partial<EntityData> | ({
          id: string;
      } & Partial<EntityData>)[]

      A single or an array of updated data records.

    Returns Promise<string>

    Success message indicating amount of records updated (can be 0).

    Example

    await Resources.devices.editEntityData("myEntityID", { id: "idOfTheRecord", field1: "new value", field2: "new unit" });

editSchemaIndex

  • editSchemaIndex(entityID, data): Promise<string>

  • Add a field to the entity schema

    Parameters

    • entityID: string

      entity ID

    • data: {
          index?: Record<string, {
              action?: "create";
              fields?: string[];
          } | {
              action?: "delete";
          }>;
          schema?: EntitySchema;
      }

      schema or index to be added

      • Optional index?: Record<string, {
            action?: "create";
            fields?: string[];
        } | {
            action?: "delete";
        }>
      • Optional schema?: EntitySchema

    Returns Promise<string>

    Success message

emptyEntityData

  • emptyEntityData(entityId): Promise<string>

  • Empty all data in a entity.

    Parameters

    • entityId: string

    Returns Promise<string>

    Success message

getEntityData

  • getEntityData(entityID, queryParams?, options?): Promise<EntityData[]>

  • Get all the data from a entity.

    Parameters

    • entityID: string

      Entity ID

    • Optional queryParams: EntityDataQuery

      Query parameters to filter the results.

    • Optional options: {
          paramsSerializer?: any;
      }
      • Optional paramsSerializer?: any

    Returns Promise<EntityData[]>

    Array with the data values stored in the entity.

    Example

    const lastTenValues = await Resources.entities.getEntityData("myEntityID", { amount: 10 });

info

list

  • list(queryObj?, options?): Promise<EntityListItem[]>

  • Retrieves a list with all entities from the account

    Parameters

    • Optional queryObj: EntityQuery

      Search query params

    • Optional options: {
          paramsSerializer?: any;
      }
      • Optional paramsSerializer?: any

    Returns Promise<EntityListItem[]>

    Default

    queryObj: {
      page: 1,
      fields: ["id", "name"],
      filter: {},
      amount: 20,
      orderBy: "name,asc",
    }

renameField

  • renameField(entityID, field, newName): Promise<string>

  • Rename a field from the entity schema

    Parameters

    • entityID: string

      entity ID

    • field: string

      field name to be renamed

    • newName: string

      new field name

    Returns Promise<string>

sendEntityData

  • sendEntityData(entityID, data): Promise<string>

  • Send data records to a entity using the profile token and entity ID.

    The data can be a single data record or an array of records to be sent.

    Parameters

    Returns Promise<string>

    Success message indicating amount of records sent (can be 0).

updateField

  • updateField(entityID, field, data): Promise<string>

  • Update a field from the entity schema

    Parameters

    • entityID: string

      entity ID

    • field: string

      field name to be updated

    • data: Partial<EntitySchema>

      data to be updated

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

constructoramountcreatedeletedeleteEntityDatadeleteFielddeleteIndexediteditEntityDataeditSchemaIndexemptyEntityDatagetEntityDatainfolistrenameFieldsendEntityDataupdateField