Element details

type: meya.salesforce.knowledge.component.display
class: SalesforceKnowledgeArticleDisplay
path: /meya/salesforce/knowledge/component/display.py
signature: -

Fields

field	description	required	signature	default	type
spec	Override the original spec for this element.	○	○	null	Spec
context	Send context data with this component's event.	○	○	{}	dict
sensitive	Mark this component's event as sensitive. This will encrypt the event if the Sensitive Data integration has been enabled.	○	○	false	bool
triggers	Activate these dynamic triggers when the component runs. Check the component triggers guide for more info.	○	○	[]	list
search_response	The response from the Salesforce Knowledge search API. This is usually available in flow scope, (@ flow.get('result')), after using the `meya.salesforce.knowledge.component.search.component`.	◉	○		list
locale		○	○	"en-US"	str
url_button_text	The text of the link button which is displayed with each article tile.	○	○	"Read article"	str
snippet_length	Length of the article snippet displayed in the tile body.	○	○	125	int
button_type	Tile button type	○	○	"url"	ButtonType
integration		◉	○		SalesforceKnowledgeIntegrationRef

Usage reference

Basic

triggers:
  - keyword: meya.salesforce.knowledge.component.display
steps:
  - type: meya.salesforce.knowledge.component.display
    search_response:
      - id: STRING
        title: STRING
        url: STRING
        down_vote_count: 123
        view_count: 123
        view_score: 1.0
        article_number: STRING
        last_published_date: STRING
    integration: integration.salesforce_knowledge

Full

triggers:
  - keyword: meya.salesforce.knowledge.component.display
steps:
  - type: meya.salesforce.knowledge.component.display
    spec:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    search_response:
      - id: STRING
        title: STRING
        url: STRING
        down_vote_count: 123
        view_count: 123
        view_score: 1.0
        article_number: STRING
        category_groups:
          - foo: bar
        last_published_date: STRING
        summary: STRING
        body: STRING
        url_name: STRING
        up_vote_count: 123
    locale: STRING
    url_button_text: STRING
    snippet_length: 123
    button_type: text|url|static|menu|divider|action|flow_next|component_next
    integration: integration.salesforce_knowledge