Class OpenWebviewUrlSuggestion

Namespace

Vonage.Messages.Rcs.Suggestions

Assembly

Vonage.dll

A open URL in webview suggestion.

public record OpenWebviewUrlSuggestion : SuggestionBase, IEquatable<SuggestionBase>, IEquatable<OpenWebviewUrlSuggestion>

Inheritance

object

SuggestionBase

OpenWebviewUrlSuggestion

Implements

IEquatable<SuggestionBase>

IEquatable<OpenWebviewUrlSuggestion>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OpenWebviewUrlSuggestion(string, string, Uri, string)

A open URL in webview suggestion.

public OpenWebviewUrlSuggestion(string Text, string PostbackData, Uri Url, string Description)

Parameters

Text string

The text to display on the suggestion chip.

PostbackData string

The data that will be sent back in the button.payload property of a button message via the inbound message webhook when the user taps the suggestion chip.

Url Uri

The URL to open when the suggestion is tapped.

Description string

A short description of the URL for accessibility purposes.

Properties

Description

A short description of the URL for accessibility purposes.

public string Description { get; init; }

Property Value

string

PostbackData

The data that will be sent back in the button.payload property of a button message via the inbound message webhook when the user taps the suggestion chip.

public override string PostbackData { get; init; }

Property Value

string

Text

The text to display on the suggestion chip.

public override string Text { get; init; }

Property Value

string

Type

The type for the suggestion object.

[JsonIgnore]
public override string Type { get; }

Property Value

string

Url

The URL to open when the suggestion is tapped.

public Uri Url { get; init; }

Property Value

Uri

ViewMode

The mode for displaying the URL in the webview window.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonConverter(typeof(EnumDescriptionJsonConverter<OpenWebviewUrlSuggestion.ViewModeValue>))]
public OpenWebviewUrlSuggestion.ViewModeValue? ViewMode { get; }

Property Value

OpenWebviewUrlSuggestion.ViewModeValue?

Methods

GetErrors()

Returns any validation errors for this suggestion.

public override IEnumerable<string> GetErrors()

Returns

IEnumerable<string>

WithViewMode(ViewModeValue)

Returns a suggestion with view mode.

public OpenWebviewUrlSuggestion WithViewMode(OpenWebviewUrlSuggestion.ViewModeValue value)

Parameters

value OpenWebviewUrlSuggestion.ViewModeValue

The mode for displaying the URL in the webview window.

Returns

OpenWebviewUrlSuggestion

The suggestion.