Skip to main content

Revision

@gca_object_type

Unpublished object or unsaved changes to an existing object.

1
@gca_object_type(

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

3
  embedded: false

4
  id: "c0b701ca-9271-39f9-821b-f281f89b7789"

5
  abstract: false

6
)
1
type Revision implements Record, Recordable, RevisionInterface, PathsField, Content {

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
  _urls: URLs!

12
  status: RecordRef

13
  schedule: RecordRef

14
  name: String

15
  owner: RecordRef

16
  objectType: ObjectType

17
  objectId: UUID

18
  objectChanges: MapOfJson @deprecated

19
  newContent: Boolean!

20
  differences: MapOfMapOfJson

21
  overlayId: UUID

22
  overlayReplace: Boolean!

23
  replace: Boolean!

24
  searchableState: String

25
  RevisionInterfaceMod: RevisionInterfaceMod!

26
}

Directives​

gca_object_type​

1
@gca_object_type(

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

3
 embedded: false

4
 id: "c0b701ca-9271-39f9-821b-f281f89b7789"

5
 abstract: false

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.

_urls ● URLs! non-null object common​

status ● RecordRef object common @gca_getter @gca_object_field​

Returns the status.

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: true

3
  internalName: "status"

4
  embedded: false

5
)

schedule ● RecordRef object common @gca_getter @gca_object_field​

Returns the schedule.

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: true

3
  internalName: "schedule"

4
  embedded: false

5
)

name ● String scalar common @gca_getter @gca_object_field​

Returns the name.

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: true

3
  internalName: "name"

4
  embedded: false

5
)

owner ● RecordRef object common @gca_getter @gca_object_field​

Returns the owner.

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: true

3
  internalName: "owner"

4
  embedded: false

5
)

objectType ● ObjectType object common @gca_getter @gca_object_field​

Returns the originating object's type.

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: true

3
  internalName: "objectType"

4
  embedded: false

5
)

objectId ● UUID scalar common @gca_getter @gca_object_field​

Returns the originating object's ID.

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: true

3
  internalName: "objectId"

4
  embedded: false

5
)

newContent ● Boolean! non-null scalar common @gca_object_field​

Applied directive:

1
@gca_object_field(

2
  indexed: true

3
  internalName: "newContent"

4
  embedded: false

5
)

differences ● MapOfMapOfJson object common @gca_getter @gca_object_field​

Never null.

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: false

3
  internalName: "differences"

4
  embedded: false

5
)

overlayId ● UUID scalar common @gca_getter @gca_object_field​

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: true

3
  internalName: "overlayId"

4
  embedded: false

5
)

overlayReplace ● Boolean! non-null scalar common @gca_object_field​

Applied directive:

1
@gca_object_field(

2
  indexed: false

3
  internalName: "overlayReplace"

4
  embedded: false

5
)

replace ● Boolean! non-null scalar common @gca_object_field​

Applied directive:

1
@gca_object_field(

2
  indexed: false

3
  internalName: "replace"

4
  embedded: false

5
)

searchableState ● String scalar common @gca_object_method​

Not intended for external use!

Applied directive:

1
@gca_object_method(

2
  embedded: false

3
  internalName: "getSearchableState"

4
  indexed: false

5
)

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.

objectChanges ● MapOfJson deprecated object common @gca_getter @gca_object_field​

DEPRECATED

Deprecated

Returns the map of all the values to be changed on the originating object.

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: false

3
  internalName: "objectChanges"

4
  embedded: false

5
)

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.

RevisionInterface interface common @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
)

PathsField interface common​

Content interface common @gca_object_type​

Represents a generic content.

1
@gca_object_type(

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

3
  embedded: false

4
  id: "ef5b6d18-7ddc-3eac-b655-cbbd126756d5"

5
  abstract: true

6
)

Member Of​