[GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class EnqueueCreateEmbedAction : BusinessRuleAction

Properties

ConversionString

Optional conversion to apply to the output.

Declaration

[JsonProperty("conversionString", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string ConversionString { get; set; }

Property Value

string

EmbedDescription

Optional description of the embed.

Declaration

[JsonProperty("embedDescription", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string EmbedDescription { get; set; }

Property Value

string

EmbedName

Name of the embed. If empty, it will be automatically initialized with the 'Embed_{RuleId}'.

Declaration

[JsonProperty("embedName", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string EmbedName { get; set; }

Property Value

string

ExpirationDate

Optional date when embed expires and cannot be accessed anymore: It must be in ISO format, with or without milliseconds 'yyyy-MM-ddTHH:mm:ss(.fffffff)K'.

Declaration

[JsonProperty("expirationDate", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string ExpirationDate { get; set; }

Property Value

string

LockDeliveryOptions

Indicates if the conversion is locked and therefore cannot be changed by the caller of the embed URI.

Declaration

[JsonProperty("lockDeliveryOptions", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool LockDeliveryOptions { get; set; }

Property Value

bool

OutputFormatId

Output format of the content to be embedded.

Declaration

[JsonProperty("outputFormatId", Required = Required.Always)]
[Required]
public string OutputFormatId { get; set; }

Property Value

string

StoreIn

Optional variable name to store in the url of the embed that will be created.

Declaration

[JsonProperty("storeIn", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string StoreIn { get; set; }

Property Value

string

Methods

FromJson(string)

Declaration

public static EnqueueCreateEmbedAction FromJson(string data)

Parameters

string data

Returns

EnqueueCreateEmbedAction

ToJson()

Declaration

public string ToJson()

Returns

string