front.shifts.get

type: meya.front.component.shifts.get
class: FrontShiftGetComponent
path: /meya/front/component/shifts/get.py
signature: -

Fields

field

signature

required

type

default

description               

spec

ForwardRef('Spec')

null

Override the original spec for this element

integration

FrontIntegrationRef

A string identifier for the Front integration (e.g. integration.front)

context

dict

{}

Send context data with this component's event

sensitive

bool

true

triggers

list

[]

Activate these dynamic triggers when the component runs

shift_id

str

The Front ID of the shift to retrieve. Shift IDs have the format shf_xxx

Examples

Basic

triggers:
  - keyword: meya.front.component.shifts.get
steps:
  - type: meya.front.component.shifts.get
    integration: integration.front
    shift_id: STRING

Full

triggers:
  - keyword: meya.front.component.shifts.get
steps:
  - type: meya.front.component.shifts.get
    spec: '?'
    integration: integration.front
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    shift_id: STRING