delete Method

Deletes the specified preference by key, if it exists, within the level provided.

If both iTwinId and iModelId are provided, the key will be deleted from both levels.

If the key does not exist in either level provided, then this function will do nothing.

delete(arg: PreferenceKeyArg & ITwinIdArg & TokenArg): Promise<void>

throws if any error occurs when deleting the preference.

Parameter Type Description
arg PreferenceKeyArg & ITwinIdArg & TokenArg  

Returns - Promise<void>

Defined in

Last Updated: 20 June, 2023