Interface AttributeEditor

Editor for attributes.

Hierarchy

AttributeEditor

Index

Methods

apply removeAttribute removeJsonAttribute setAttribute setJsonAttribute

Methods

apply

apply(success?: (() => void), error?: ((err: string) => void)): void
Applies the attribute operations.
Parameters
- Optional success: (() => void)
  
  Success callback.
  - - (): void
    - Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:994

removeAttribute

removeAttribute(name: string): AttributeEditor
Removes an attribute.

Returns
The attribute editor instance.
Parameters
- name: string
  
  The name of the attribute to remove.
Returns AttributeEditor
- Defined in index.d.ts:979

removeJsonAttribute

removeJsonAttribute(name: string, instanceId: string): AttributeEditor
Removes a JSON attribute.

Returns
The attribute editor instance.
Parameters
- name: string
  
  The name of the attribute to remove.
- instanceId: string
  
  The instance ID.
Returns AttributeEditor
- Defined in index.d.ts:987

setAttribute

setAttribute(name: string, value: string | number | boolean | Date): AttributeEditor
Adds an attribute.

Returns
The attribute editor instance.
Parameters
- name: string
  
  The attribute name.
- value: string | number | boolean | Date
  
  The attribute value.
Returns AttributeEditor
- Defined in index.d.ts:952

setJsonAttribute

setJsonAttribute(name: string, instanceId: string, json: Record<string, any>, expiration?: Date): AttributeEditor
Adds a JSON attribute.

Returns
The attribute editor instance.
Parameters
- name: string
  
  The attribute name.
- instanceId: string
  
  The instance ID.
- json: Record<string, any>
  
  The json value. Must not contain exp as top level key.
- Optional expiration: Date
Returns AttributeEditor
- Defined in index.d.ts:967

Generated using TypeDoc