Class NarrowcastProgressResponse

Namespace

Line.OpenApi.Messaging.Generated.Api.Models

Assembly

Line.OpenApi.Messaging.dll

public class NarrowcastProgressResponse : IAdditionalDataHolder, IParsable

Inheritance

object

NarrowcastProgressResponse

Implements

IAdditionalDataHolder

IParsable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

NarrowcastProgressResponse()

Instantiates a new NarrowcastProgressResponse and sets the default values.

public NarrowcastProgressResponse()

Properties

AcceptedTime

Narrowcast message request accepted time in milliseconds.Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z)Timezone: UTC

public DateTimeOffset? AcceptedTime { get; set; }

Property Value

DateTimeOffset?

AdditionalData

Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

public IDictionary<string, object> AdditionalData { get; set; }

Property Value

IDictionary<string, object>

CompletedTime

Processing of narrowcast message request completion time in milliseconds. Returned when the phase property is succeeded or failed.Format: ISO 8601 (e.g. 2020-12-03T10:15:30.121Z)Timezone: UTC

public DateTimeOffset? CompletedTime { get; set; }

Property Value

DateTimeOffset?

ErrorCode

Error summary. This is only included with a phase property value of failed.One of:1: An internal error occurred.2: An error occurred because there weren't enough recipients.3: A conflict error of requests occurs because a request that has already been accepted is retried.4: An audience of less than 50 recipients is included as a condition of sending.5: Message delivery has been canceled to prevent messages from being delivered only to a subset of the target audience.

public long? ErrorCode { get; set; }

Property Value

long?

FailedDescription

The reason the message failed to be sent. This is only included with a phase property value of failed.

public string? FailedDescription { get; set; }

Property Value

string

FailureCount

The number of users who failed to send the message.

public long? FailureCount { get; set; }

Property Value

long?

Phase

The current status. One of:waiting: Messages are not yet ready to be sent. They are currently being filtered or processed in some way.sending: Messages are currently being sent.succeeded: Messages were sent successfully. This may not mean the messages were successfully received.failed: Messages failed to be sent. Use the failedDescription property to find the cause of the failure.

public NarrowcastProgressResponse_phase? Phase { get; set; }

Property Value

NarrowcastProgressResponse_phase?

SuccessCount

The number of users who successfully received the message.

public long? SuccessCount { get; set; }

Property Value

long?

TargetCount

The number of intended recipients of the message.

public long? TargetCount { get; set; }

Property Value

long?

Methods

CreateFromDiscriminatorValue(IParseNode)

Creates a new instance of the appropriate class based on discriminator value

public static NarrowcastProgressResponse CreateFromDiscriminatorValue(IParseNode parseNode)

Parameters

parseNode IParseNode

The parse node to use to read the discriminator value and create the object

Returns

NarrowcastProgressResponse

A NarrowcastProgressResponse

GetFieldDeserializers()

The deserialization information for the current model

public virtual IDictionary<string, Action<IParseNode>> GetFieldDeserializers()

Returns

IDictionary<string, Action<IParseNode>>

A IDictionary<string, Action<IParseNode>>

Serialize(ISerializationWriter)

Serializes information the current object

public virtual void Serialize(ISerializationWriter writer)

Parameters

writer ISerializationWriter

Serialization writer to use to serialize this model