Skip to main content

Function

Functions allow the organization and management of any group activities, meals, etc. at an event which are not part of the Agenda or Sessions set-up.

type Function {
  attendances(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [FunctionAttendance!]!
  backgroundColor: HexColorCode
  comment: String
  createdAt: DateTime!
  createdBy: String
  customFields(
    input: CustomFieldSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CustomField!]!
  date: LocalDate
  details: String
  end: LocalTime
  feeTypes(
    input: FunctionFeeTypeSearchFilterInput! = [object Object]
  ): [FunctionFeeType!]!
  group: FunctionGroup!
  guestType: FunctionGuestType!
  id: ID!
  inventoryLimit: PositiveInt
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  location: Location
  name: String!
  overview: String
  registrations(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [FunctionRegistration!]!
  showBoldTitle: Boolean!
  start: LocalTime
  textColor: HexColorCode
  tracks: [Track!]!
  uniqueCode: String
}

Fields​

Function.attendances ● [FunctionAttendance!]! non-null object​

A list of attendances for this function.

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).
Function.attendances.limit ● PaginationLimit! non-null scalar​
Function.attendances.offset ● NonNegativeInt! non-null scalar​

Function.backgroundColor ● HexColorCode scalar​

The hex color code to use for the background when rendering the function in the agenda. Optional.

Function.comment ● String scalar​

A UTF-8 string comment for the function. Optional.

Function.createdAt ● DateTime! non-null scalar​

The date and time the record was created.

Function.createdBy ● String scalar​

UTF-8 string value that represents the username of the user who created the record. Optional.

Function.customFields ● [CustomField!]! non-null object​

A list of custom field values associated with this function.

CustomFields and CustomFieldDefinitions can be matched through the definitionId and id fields, respectively.

See CustomFieldSearchFilterInput for details on how the optional input argument can be used to filter custom fields.

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).
Function.customFields.input ● CustomFieldSearchFilterInput! non-null input​
Function.customFields.limit ● PaginationLimit! non-null scalar​
Function.customFields.offset ● NonNegativeInt! non-null scalar​

Function.date ● LocalDate scalar​

The date the function will occur. Optional.

Function.details ● String scalar​

A UTF-8 string that provides a description of the function. It is not displayed publicly and is intended to be used by event organizers. Optional.

Function.end ● LocalTime scalar​

The time the function will end. Optional.

Function.feeTypes ● [FunctionFeeType!]! non-null object​

A list of fee types associated with this function.

See FunctionFeeTypeSearchFilterInput for details on how the optional input argument can be used to filter functions.

Function.feeTypes.input ● FunctionFeeTypeSearchFilterInput! non-null input​

Function.group ● FunctionGroup! non-null object​

The function group this function belongs to.

Function.guestType ● FunctionGuestType! non-null enum​

The guest type for for the function.

Function.id ● ID! non-null scalar​

The unique identifier for a function.

Function.inventoryLimit ● PositiveInt scalar​

The inventory limit for this Function. Optional.

Function.lastModifiedAt ● DateTime! non-null scalar​

The date and time the record was last modified.

Function.lastModifiedBy ● String scalar​

UTF-8 string value that represents the username of the user who last modified the record. Optional.

Function.location ● Location object​

The location for the function. Optional.

Function.name ● String! non-null scalar​

A UTF-8 string representing the name of a function.

Function.overview ● String scalar​

A UTF-8 string that provides a brief overview of the function that is displayed in the agenda. Optional.

Function.registrations ● [FunctionRegistration!]! non-null object​

A list of registrations for this function.

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).
Function.registrations.limit ● PaginationLimit! non-null scalar​
Function.registrations.offset ● NonNegativeInt! non-null scalar​

Function.showBoldTitle ● Boolean! non-null scalar​

A Boolean value indicating whether the title should be bold when rendering the function in the agenda. false by default.

Function.start ● LocalTime scalar​

The time the function will start. Optional.

Function.textColor ● HexColorCode scalar​

The hex color code to use when rendering the function's text in the agenda. Optional.

Function.tracks ● [Track!]! non-null object​

The tracks associated with the function.

If a function is allocated to a single track, the single track will be returned. If a function spans multiple tracks, all tracks that it spans will be returned.

Function.uniqueCode ● String scalar​

A customer supplied, UTF-8 string value that represents a unique code for the function. Optional.

The value must be unique across all functions for an event.

Member Of​

FunctionRegistration object ● FunctionSetup object