Interface ContentRestrictionUpdate

interface ContentRestrictionUpdate {
    content?: null | Content;
    operation:
        | "copy"
        | "move"
        | "use"
        | "update"
        | "delete"
        | "read"
        | "create"
        | "restore"
        | "administer"
        | "export"
        | "purge"
        | "purge_version";
    restrictions: {
        group?: ({
            id?: string;
            type: "group";
        } & {
            [key: string]: unknown;
        })[];
        user?: (null | UserV1)[] | UserArray;
    } & {
        [key: string]: unknown;
    };
}

Hierarchy

  • Record<string, unknown>
    • ContentRestrictionUpdate

Properties

content? operation restrictions

Properties

Optionalcontent

content?: null | Content

Base object for all content types.

operation

operation:
    | "copy"
    | "move"
    | "use"
    | "update"
    | "delete"
    | "read"
    | "create"
    | "restore"
    | "administer"
    | "export"
    | "purge"
    | "purge_version"

The restriction operation applied to content.

restrictions

restrictions: {
    group?: ({
        id?: string;
        type: "group";
    } & {
        [key: string]: unknown;
    })[];
    user?: (null | UserV1)[] | UserArray;
} & {
    [key: string]: unknown;
}

The users/groups that the restrictions will be applied to. At least one of user or group must be specified for this object.

Type declaration

  • Optionalgroup?: ({
        id?: string;
        type: "group";
    } & {
        [key: string]: unknown;
    })[]

    The groups that the restrictions will be applied to. This array must have at least one item, otherwise it should be omitted.

  • Optionaluser?: (null | UserV1)[] | UserArray

Settings

Member Visibility

On This Page

Properties