Skip to main content

PresentationFlow

A presentation flow.

type PresentationFlow {
  action: Action
  actions: [Action!]
  autoSubmit: Boolean
  communications(
    limit: PositiveInt
    offset: NonNegativeInt
    orderBy: CommunicationOrderBy
    orderDirection: OrderDirection
    where: CommunicationWhere
  ): [Communication!]!
  createdAt: DateTime!
  createdBy: User!
  dataResults: JSONObject
  dataSchema: [DataDefinition!]
  expiresAt: DateTime!
  hasContactNotificationSet: Boolean!
  id: ID!
  identity: Identity
  isCancelled: Boolean
  isSubmitted: Boolean
  notificationStatus: PresentationFlowNotificationStatus
  portalUrl: String!
  postPresentationText: Markdown
  prePresentationText: Markdown
  presentation: Presentation
  presentationRequest: JSONObject!
  requestData: JSONObject
  status: PresentationFlowStatus!
  template: PresentationFlowTemplate
  title: String
  updatedAt: DateTime
  updatedBy: User
}

Fields​

PresentationFlow.action ● Action object​

PresentationFlow.actions ● [Action!] list object​

PresentationFlow.autoSubmit ● Boolean scalar​

PresentationFlow.communications ● [Communication!]! non-null object​

The communications that have been sent for this presentation flow.

PresentationFlow.communications.limit ● PositiveInt scalar​
PresentationFlow.communications.offset ● NonNegativeInt scalar​
PresentationFlow.communications.orderBy ● CommunicationOrderBy enum​
PresentationFlow.communications.orderDirection ● OrderDirection enum​
PresentationFlow.communications.where ● CommunicationWhere input​

PresentationFlow.createdAt ● DateTime! non-null scalar​

PresentationFlow.createdBy ● User! non-null object​

PresentationFlow.dataResults ● JSONObject scalar​

PresentationFlow.dataSchema ● [DataDefinition!] list object​

PresentationFlow.expiresAt ● DateTime! non-null scalar​

PresentationFlow.hasContactNotificationSet ● Boolean! non-null scalar​

Indicates whether this presentation flow has contact notification details set.

PresentationFlow.id ● ID! non-null scalar​

PresentationFlow.identity ● Identity object​

PresentationFlow.isCancelled ● Boolean scalar​

PresentationFlow.isSubmitted ● Boolean scalar​

PresentationFlow.notificationStatus ● PresentationFlowNotificationStatus enum​

The status of the notification for this presentation flow.

PresentationFlow.portalUrl ● String! non-null scalar​

PresentationFlow.postPresentationText ● Markdown scalar​

PresentationFlow.prePresentationText ● Markdown scalar​

PresentationFlow.presentation ● Presentation object​

PresentationFlow.presentationRequest ● JSONObject! non-null scalar​

PresentationFlow.requestData ● JSONObject scalar​

PresentationFlow.status ● PresentationFlowStatus! non-null enum​

PresentationFlow.template ● PresentationFlowTemplate object​

PresentationFlow.title ● String scalar​

PresentationFlow.updatedAt ● DateTime scalar​

PresentationFlow.updatedBy ● User object​

Returned By​

findPresentationFlows query ● presentationFlow query ● presentationFlowEvent subscription ● resendPresentationFlowNotification mutation ● submitPresentationFlowActions mutation ● updatePresentationFlowContact mutation

Member Of​

Identity object ● PresentationFlowResponse object