Typescript SDK Type Docs
    Preparing search index...

    Interface AddStateRolesChange

    This Change is no longer triggered by the Add State roles update action. It has been deprecated and replaced by the SetStateRolesChange.

    interface AddStateRolesChange {
        change: string;
        nextValue: StateRoleEnum[];
        previousValue: StateRoleEnum[];
        type: "AddStateRolesChange";
    }

    Hierarchy (View Summary)

    Index

    Properties

    change nextValue previousValue type

    Properties

    change: string

    Change type 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.
    nextValue: StateRoleEnum[]

    Value after the change.

    previousValue: StateRoleEnum[]

    Value before the change.

    type: "AddStateRolesChange"

    Unique discriminator value to reliably deserialize the data type.

    Settings

    Member Visibility

    On This Page

    Properties