Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IProfInfoUpdatePropOpts

Required options to update any property from the ProfileInfo class.

Hierarchy

Index

Properties

Optional forceUpdate

forceUpdate: boolean

Force the update to the profile specified even if the property comes from somewhere else

example

Token Value could be in the base profile (not in the service profile specified) and the programmer has the intention of storing the token in the service profile

default

false When the property is not specified, the updateProperty method follows current procedure of updating the property in the known jsonLoc (e.g. base profile). Otherwise, the updateProperty method updates the specified profile name-type combination.

profileName

profileName: string

Name of the active profile

profileType

profileType: string | null

Type of the active profile. Specify null to update a typeless profile.

property

property: string

Property to update

Optional setSecure

setSecure: boolean

Specifies if the property should be stored securely or not

value

value: IProfArgValue | undefined

Value to use when updating the given property

Generated using TypeDoc