Skip to main content

InterfaceDefinition

InterfaceDefinition on a ComponentVersion Specifies if it is visible/invisible self-defined. Specifies if it is visible/invisible derived (and by which Relations) READ is granted if READ is granted on componentVersion

type InterfaceDefinition implements BaseNode, MutableTemplatedNode, Node, TemplatedNode {
  componentVersion: ComponentVersion!
  hasPermission(
    permission: AllPermissionEntry
  ): Boolean!
  id: ID!
  interfaceSpecificationVersion: InterfaceSpecificationVersion!
  invisibleDerivedBy(
    after: String
    before: String
    filter: RelationFilterInput
    first: Int
    last: Int
    orderBy: [RelationOrder!]
    skip: Int
  ): RelationConnection!
  invisibleSelfDefined: Boolean!
  template: InterfaceDefinitionTemplate!
  templatedField(
    name: String!
  ): JSON
  templatedFields(
    names: [String!]
    prefixMatching: Boolean
  ): [JSONField!]!
  visibleDerivedBy(
    after: String
    before: String
    filter: RelationFilterInput
    first: Int
    last: Int
    orderBy: [RelationOrder!]
    skip: Int
  ): RelationConnection!
  visibleInterface: Interface
  visibleSelfDefined: Boolean!
}

Fields​

InterfaceDefinition.componentVersion ● ComponentVersion! non-null object​

The ComponentVersion using the InterfaceSpecificationVersion

InterfaceDefinition.hasPermission ● Boolean! non-null scalar​

Checks if the current user has a specific permission on this Node

InterfaceDefinition.hasPermission.permission ● AllPermissionEntry enum​

The permission to check for

InterfaceDefinition.id ● ID! non-null scalar​

The unique id of this node

InterfaceDefinition.interfaceSpecificationVersion ● InterfaceSpecificationVersion! non-null object​

The InterfaceSpecificationVersion present on the ComponentVersion

InterfaceDefinition.invisibleDerivedBy ● RelationConnection! non-null object​

Relations because of which interfaceSpecificationVersion is invisible derived on componentVersion

InterfaceDefinition.invisibleDerivedBy.after ● String scalar​

Get only items after the cursor

InterfaceDefinition.invisibleDerivedBy.before ● String scalar​

Get only items before the cursor

InterfaceDefinition.invisibleDerivedBy.filter ● RelationFilterInput input​

Filter for specific items in the connection

InterfaceDefinition.invisibleDerivedBy.first ● Int scalar​

Get the first n items. Must not be used if before is specified

InterfaceDefinition.invisibleDerivedBy.last ● Int scalar​

Get the last n items. Must not be used if after is specified

InterfaceDefinition.invisibleDerivedBy.orderBy ● [RelationOrder!] list input​

Order in which the items are sorted

InterfaceDefinition.invisibleDerivedBy.skip ● Int scalar​

Skips n items. First or last MUST be specified, is otherwise ignored

InterfaceDefinition.invisibleSelfDefined ● Boolean! non-null scalar​

If true, interfaceSpecificationVersionis self-defined invisible on the componentVersion

InterfaceDefinition.template ● InterfaceDefinitionTemplate! non-null object​

The Template of this InterfaceDefinition.

InterfaceDefinition.templatedField ● JSON scalar​

Value of a field defined by the template. Error if such a field is not defined.

InterfaceDefinition.templatedField.name ● String! non-null scalar​

Name of the extension field

InterfaceDefinition.templatedFields ● [JSONField!]! non-null object​

All templatedFields If names is provided, only those matching the name. If prefixMatching is true, matching is done by prefix, otherwise by full name.

InterfaceDefinition.templatedFields.names ● [String!] list scalar​

Names of the templated fields. If not provided, all templatedFields.

InterfaceDefinition.templatedFields.prefixMatching ● Boolean scalar​

If true, name matching is performed as prefix matching, otherwise as absolute match. Defaults to absolute matching

InterfaceDefinition.visibleDerivedBy ● RelationConnection! non-null object​

Relations because of which interfaceSpecificationVersion is visible derived on componentVersion

InterfaceDefinition.visibleDerivedBy.after ● String scalar​

Get only items after the cursor

InterfaceDefinition.visibleDerivedBy.before ● String scalar​

Get only items before the cursor

InterfaceDefinition.visibleDerivedBy.filter ● RelationFilterInput input​

Filter for specific items in the connection

InterfaceDefinition.visibleDerivedBy.first ● Int scalar​

Get the first n items. Must not be used if before is specified

InterfaceDefinition.visibleDerivedBy.last ● Int scalar​

Get the last n items. Must not be used if after is specified

InterfaceDefinition.visibleDerivedBy.orderBy ● [RelationOrder!] list input​

Order in which the items are sorted

InterfaceDefinition.visibleDerivedBy.skip ● Int scalar​

Skips n items. First or last MUST be specified, is otherwise ignored

InterfaceDefinition.visibleInterface ● Interface object​

If visible, the created Interface

InterfaceDefinition.visibleSelfDefined ● Boolean! non-null scalar​

If true, interfaceSpecificationVersionis self-defined visible on the componentVersion

Interfaces​

BaseNode interface​

Shared extensions to the node type.

MutableTemplatedNode interface​

Interface for all types which support templates describing user writeable fields.

Node interface​

Base class of all nodes

TemplatedNode interface​

Interface for all types which support templates.

Member of​

Interface object ● InterfaceDefinitionConnection object ● InterfaceDefinitionEdge object ● UpdateInterfaceDefinitionPayload object