deleteObject

deleteObject<T>(object, purge?): void

Permanently deletes a Session, Endpoint, or Data instance from the service. Once it has been deleted it cannot be retrieved.

Type parameters

• T extends Session | Endpoint | Data

Parameters

• object: T

The Session, Endpoint, or Data object to permanently delete.

• purge?: boolean

(Optional, default = false) Normal deletion leaves behind a very small marker that prevents deleted endpoint and data instances from being re-created accidentally. Passing true to this argument prevents this marker from being written. For endpoint deletions specifically, careful consideration should be made when setting this to true because it could result in accidental re-creation because endpoints are created-on-first-use.

Returns

void

---

Generated using typedoc-plugin-markdown and TypeDoc