Interface ChangeKeyChange

Change triggered by the following update actions:

- [Change Key](ctp:api:type:ChannelChangeKeyAction) on Channels.
- [Change State key](ctp:api:type:StateChangeKeyAction) on States.
- [Change Key](ctp:api:type:TypeChangeKeyAction) on Types.
interface ChangeKeyChange {
    change: string;
    nextValue: string;
    previousValue: string;
    type: "ChangeKeyChange";
}

Hierarchy (View Summary)

Properties

change nextValue previousValue type

Properties

Readonlychange

change: string

Type of change on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

[Records](ctp:history:type:Record) can be filtered by this value using the `changes` query parameter.

ReadonlynextValue

nextValue: string

Value after the change.

ReadonlypreviousValue

previousValue: string

Value before the change.

Readonlytype

type: "ChangeKeyChange"

Unique discriminator value to reliably deserialize the data type.

Settings

Member Visibility

On This Page

Properties