Skip to main content

History

@gca_object_type

Represents previous revisions of objects.

1
@gca_object_type(

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

3
  embedded: false

4
  id: "36698d31-bc27-3d83-841e-7be1d84dfabd"

5
  abstract: false

6
)
1
type History implements Record, Recordable, RevisionInterface {

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
  name: String

12
  updateDate: Date

13
  updateUser: RecordRef

14
  objectType: ObjectType

15
  objectId: UUID

16
  objectOriginals: MapOfJson

17
  lockIgnored: Boolean!

18
  impersonatingUser: RecordRef

19
  draftId: UUID

20
  isDraftWorkflowItem: Boolean!

21
  historyWorkflowStatus: String

22
  objectIdUpdateDate: String

23
  RevisionInterfaceMod: RevisionInterfaceMod!

24
}

Directives​

gca_object_type​

1
@gca_object_type(

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

3
 embedded: false

4
 id: "36698d31-bc27-3d83-841e-7be1d84dfabd"

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.

name ● String scalar common @gca_getter @gca_object_field​

Returns this history's name.

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: true

3
  internalName: "name"

4
  embedded: false

5
)

updateDate ● Date scalar common @gca_getter @gca_object_field​

Returns the date when the object was updated.

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: true

3
  internalName: "updateDate"

4
  embedded: false

5
)

updateUser ● RecordRef object common @gca_getter @gca_object_field​

Returns the user that updated the object.

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: true

3
  internalName: "updateUser"

4
  embedded: false

5
)

objectType ● ObjectType object common @gca_object_field​

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 object's ID.

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: true

3
  internalName: "objectId"

4
  embedded: false

5
)

objectOriginals ● MapOfJson object common @gca_getter @gca_object_field​

Returns an unmodifiable map of all the original values.

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: false

3
  internalName: "objectOriginals"

4
  embedded: false

5
)

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

Applied directive:

1
@gca_object_field(

2
  indexed: false

3
  internalName: "lockIgnored"

4
  embedded: false

5
)

impersonatingUser ● RecordRef object common @gca_getter @gca_object_field​

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: false

3
  internalName: "impersonatingUser"

4
  embedded: false

5
)

draftId ● UUID scalar common @gca_getter @gca_object_field​

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: true

3
  internalName: "draftId"

4
  embedded: false

5
)

isDraftWorkflowItem ● Boolean! non-null scalar common @gca_getter @gca_object_field​

true if the revision is related to Drafts.

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: true

3
  internalName: "isDraftWorkflowItem"

4
  embedded: false

5
)

historyWorkflowStatus ● String scalar common @gca_getter @gca_object_field​

Applied directive:

1
@gca_getter

Applied directive:

1
@gca_object_field(

2
  indexed: false

3
  internalName: "historyWorkflowStatus"

4
  embedded: false

5
)

objectIdUpdateDate ● String scalar common @gca_object_method​

Applied directive:

1
@gca_object_method(

2
  embedded: false

3
  internalName: "getObjectIdUpdateDate"

4
  indexed: true

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.

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
)

Member Of​