Typescript SDK Type Docs
    Preparing search index...

    Interface SetPermissionsChange

    Change triggered by the Set Permissions, Add Permission, and Remove Permission update actions.

    interface SetPermissionsChange {
        addedItems: Permission[];
        change: string;
        nextValue: Permission[];
        previousValue: Permission[];
        removedItems: Permission[];
        type: "SetPermissionsChange";
    }

    Hierarchy (View Summary)

    Index

    Properties

    addedItems change nextValue previousValue removedItems type

    Properties

    addedItems: Permission[]

    Elements added to the array.

    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: Permission[]

    Value after the change.

    previousValue: Permission[]

    Value before the change.

    removedItems: Permission[]

    Elements removed from the array.

    type: "SetPermissionsChange"

    Unique discriminator value to reliably deserialize the data type.

    Settings

    Member Visibility

    On This Page

    Properties