zendesk.help_center.display

type: meya.zendesk.help_center.component.display
class: ZendeskHelpCenterArticlesDisplayComponent
path: /meya/zendesk/help_center/component/display.py
signature: -

Fields

field

signature

required

type

default

description               

spec

ForwardRef('Spec')

null

Override the original spec for this element

context

dict

{}

Send context data with this component's event

sensitive

bool

false

Mark this component's event as sensitive

triggers

list

[]

Activate these dynamic triggers when the component runs

search_response

ZendeskHelpCenterSearchResponse
ZendeskHelpCenterArticle

The response from the Zendesk Help Center search API. This is usually available in flow scope, (@ flow.get('result')), after using the meya.zendesk.help_center.component.search or meya.zendesk.help_center.component.article.get component.

url_button_text

str

"Read article"

The text of the link button which is displayed with each article tile.

snippet_length

int

125

Length of the article snippet displayed on the tile body

button_type

ButtonType

"url"

Tile button type

Examples

Basic

triggers:
  - keyword: meya.zendesk.help_center.component.display
steps:
  - type: meya.zendesk.help_center.component.display
    search_response:
      count: 123
      page: 123
      page_count: 123
      per_page: 123
      results:
        - locale: STRING
          title: STRING
          author_id: 123
          permission_group_id: 123
          id: 123
          vote_sum: 123
          vote_count: 123
          result_type: STRING
          snippet: STRING

Full

triggers:
  - keyword: meya.zendesk.help_center.component.display
steps:
  - type: meya.zendesk.help_center.component.display
    spec: '?'
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    search_response:
      count: 123
      page: 123
      page_count: 123
      per_page: 123
      sort_by: STRING
      sort_order: STRING
      previous_page: STRING
      next_page: STRING
      results:
        - locale: STRING
          title: STRING
          author_id: 123
          permission_group_id: 123
          id: 123
          outdated_locales:
            - STRING
          vote_sum: 123
          vote_count: 123
          name: STRING
          user_segment_id: 123
          body: STRING
          comments_disabled: false
          created_at: STRING
          updated_at: STRING
          draft: false
          edited_at: STRING
          html_url: STRING
          label_names:
            - STRING
          outdated: false
          position: 123
          promoted: false
          section_id: 123
          source_locale: STRING
          url: STRING
          result_type: STRING
          snippet: STRING
    url_button_text: STRING
    snippet_length: 123
    button_type: text|url|static|action|flow_next|component_next