Skip to main content

FunctionEventAgendaItem

Represents a Function included in an event agenda. To be included in an Agenda, a Function must include a date, start time and end time.

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

type FunctionEventAgendaItem implements EventAgendaItem {
  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!
  group: FunctionGroup!
  id: ID!
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  location: Location
  name: String!
  overview: String
  showBoldName: Boolean!
  start: LocalTime!
  textColor: HexColorCode
  tracks: [Track!]!
  type: EventAgendaItemType!
  uniqueCode: String
}

Fields​

FunctionEventAgendaItem.backgroundColor ● HexColorCode scalar​

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

FunctionEventAgendaItem.comment ● String scalar​

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

FunctionEventAgendaItem.createdAt ● DateTime! non-null scalar​

The date and time the record was created.

FunctionEventAgendaItem.createdBy ● String scalar​

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

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

A list of custom field values associated with this function.

CustomFields can be correlated with a CustomFieldDefinition through the name and type fields.

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).
FunctionEventAgendaItem.customFields.input ● CustomFieldSearchFilterInput! non-null input​
FunctionEventAgendaItem.customFields.limit ● PaginationLimit! non-null scalar​
FunctionEventAgendaItem.customFields.offset ● NonNegativeInt! non-null scalar​

FunctionEventAgendaItem.date ● LocalDate! non-null scalar​

The date the function will occur.

FunctionEventAgendaItem.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.

FunctionEventAgendaItem.end ● LocalTime! non-null scalar​

The time the function will end.

FunctionEventAgendaItem.group ● FunctionGroup! non-null object​

The function group this function belongs to.

FunctionEventAgendaItem.id ● ID! non-null scalar​

The unique identifier for a function.

FunctionEventAgendaItem.lastModifiedAt ● DateTime! non-null scalar​

The date and time the record was last modified.

FunctionEventAgendaItem.lastModifiedBy ● String scalar​

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

FunctionEventAgendaItem.location ● Location object​

The location for the function. Optional.

FunctionEventAgendaItem.name ● String! non-null scalar​

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

FunctionEventAgendaItem.overview ● String scalar​

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

FunctionEventAgendaItem.showBoldName ● Boolean! non-null scalar​

A flag indicating whether the name should be bold when rendering the function in the agenda. false by default.

FunctionEventAgendaItem.start ● LocalTime! non-null scalar​

The time the function will start.

FunctionEventAgendaItem.textColor ● HexColorCode scalar​

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

FunctionEventAgendaItem.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.

FunctionEventAgendaItem.type ● EventAgendaItemType! non-null enum​

A value indicating the type of the agenda item. Returns EventAgendaItemType.FUNCTION.

FunctionEventAgendaItem.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.

Interfaces​

EventAgendaItem interface​

An item which occupies a timeslot in the agenda.