Skip to main content

GmPropertyDef

A typed property (field) defined on a container type.

type GmPropertyDef {
  appId: BigInt!
  containerTypeName: String!
  key: String!
  valueType: String!
  defaultValueJson: String
  visibility: String!
  writable: String!
  description: String
}

Fields​

GmPropertyDef.appId ● BigInt! non-null scalar​

The app (tenant) that owns the type.

GmPropertyDef.containerTypeName ● String! non-null scalar​

The container type this property belongs to.

GmPropertyDef.key ● String! non-null scalar​

Property key (unique within the type).

GmPropertyDef.valueType ● String! non-null scalar​

Value type: int | float | string | bool | array | object | container_ref.

GmPropertyDef.defaultValueJson ● String scalar​

JSON-encoded default value.

GmPropertyDef.visibility ● String! non-null scalar​

Read visibility: public | owner | hidden.

GmPropertyDef.writable ● String! non-null scalar​

Who may write the property: function | owner | admin.

GmPropertyDef.description ● String scalar​

Optional description of the property.

Returned By​

gameModelPropertyDefs query ● gameModelUpsertPropertyDef mutation

Member Of​

GmTypeSchema object