Skip to main content

RevisionInterface

@gca_object_type

An interface indicating the type is capable of producing a revision that can be surfaced in the CMS RevisionsWidget.

1
@gca_object_type(

2
  internalName: "com.psddev.cms.db.Revision"

3
  embedded: false

4
  id: "829b0448-680d-391e-ab6f-3478c42f34e7"

5
  abstract: true

6
)
1
interface RevisionInterface implements Record, Recordable {

2
  _id: ID

3
  _label: String

4
  _globals: Globals!

5
  _raw(

6
    path: String

7
  ): Json

8
  _state(

9
    path: String

10
  ): Json @deprecated

11
  RevisionInterfaceMod: RevisionInterfaceMod!

12
}

Directives​

gca_object_type​

1
@gca_object_type(

2
 internalName: "com.psddev.cms.db.Revision"

3
 embedded: false

4
 id: "829b0448-680d-391e-ab6f-3478c42f34e7"

5
 abstract: true

6
)

Fields​

_id ● ID scalar common​

The unique ID of the Record. Corresponds to the Java method Record#getId and State#getId.

_label ● String scalar common​

The display name of the Record instance. Corresponds to the Java methods Record#getLabel and State#getLabel.

_globals ● Globals! non-null object common​

Contains global Modification fields for this Record instance.

_raw ● Json scalar common​

Contains raw State JSON for this Record instance. The same as invoking getState().getSimpleValues();

path ● String scalar common​

Restricts the returned JSON to the specified path within the record’s state.

RevisionInterfaceMod ● RevisionInterfaceMod! non-null object common​

Hide deprecated

_state ● Json deprecated scalar common​

DEPRECATED

Use [_raw] instead. For removal in 5.0!

Contains raw State JSON for this Record instance. The same as invoking getState().getSimpleValues();

path ● String scalar common​

Restricts the returned JSON to the specified path within the record’s state.

Interfaces​

Record interface common​

Recordable interface common​

The super interface for all types backed by data models, e.g. Java classes that implement Recordable. This interface declares a single _id field containing the UUID of the record. A corresponding _type field is intentionally omitted as it can be derived programmatically from the built-in GraphQL __typename field. Each GraphQL type that implements this interface will be annotated with the @gca_object_type directive which contains the backing data model's type ID.

Member Of​

Implemented By​