All pages
Powered by GitBook
1 of 3

Loading...

Loading...

Loading...

FirstSaliencyStrategy

Class in Yarn.Saliency

Inherits from System.Object

Summary

A content saliency strategy that always returns the first non-failing item in the list of available options.

Remarks

This saliency strategy is used when a Dialogue has no provided saliency strategy, but is required to make a decision.

Methods

Name
Description

ContentWasSelected(ContentSaliencyOption)

Called by Yarn Spinner to indicate that a piece of salient content has been selected, and this system should update any state related to how it selects content.

QueryBestContent(IEnumerable)

Chooses an item from content that is the most appropriate (or salient ) for the user's current context.

ContentWasSelected(ContentSaliencyOption)

Method in FirstSaliencyStrategy

Summary

Called by Yarn Spinner to indicate that a piece of salient content has been selected, and this system should update any state related to how it selects content.

Remarks

If a content saliency strategy does not need to keep track of any state, then this method can be empty.

Parameters

Name
Description

Yarn.Saliency.ContentSaliencyOption content

The content that has been selected.

QueryBestContent(IEnumerable<ContentSaliencyOption>)

Method in FirstSaliencyStrategy

Summary

Chooses an item from content that is the most appropriate (or salient ) for the user's current context.

Remarks

Implementations of this method should not modify any state

  • that is, they should be 'read-only' operations. If a strategy needs to record information about when a piece of content has been selected, it should do it in the ContentWasSelected(ContentSaliencyOption) method.

Parameters

Name
Description

System.Collections.Generic.IEnumerable<Yarn.Saliency.ContentSaliencyOption> content

A collection of content items. This collection may be empty.

Returns

An item from content that is the most appropriate for display, or null if no content should be displayed.

public class FirstSaliencyStrategy : IContentSaliencyStrategy
public void ContentWasSelected(ContentSaliencyOption content)
public ContentSaliencyOption? QueryBestContent(IEnumerable<ContentSaliencyOption> content)