Struct GetEventsRequest

Namespace

Vonage.Conversations.GetEvents

Assembly

Vonage.dll

public readonly struct GetEventsRequest : IVonageRequest

Implements

IVonageRequest

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

ConversationId

The conversation Id.

public string ConversationId { get; }

Property Value

string

Cursor

The cursor to start returning results from. You are not expected to provide this manually, but to follow the url provided in _links.next.href or _links.prev.href in the response which contains a cursor value.

public Maybe<string> Cursor { get; }

Property Value

Maybe<string>

EndId

The ID to end returning events at

public Maybe<string> EndId { get; }

Property Value

Maybe<string>

EventType

The type of event to search for. Does not currently support custom events

public Maybe<string> EventType { get; }

Property Value

Maybe<string>

ExcludeDeletedEvents

Exclude deleted events from the response

public bool ExcludeDeletedEvents { get; }

Property Value

bool

Order

Defines the data ordering.

public FetchOrder Order { get; }

Property Value

FetchOrder

PageSize

Number of results per page.

public int PageSize { get; }

Property Value

int

StartId

The ID to start returning events at

public Maybe<string> StartId { get; }

Property Value

Maybe<string>

Methods

Build()

Initializes a builder.

public static IBuilderForConversationId Build()

Returns

IBuilderForConversationId

The builder.

BuildRequestMessage()

Converts the request to a HttpRequest.

public HttpRequestMessage BuildRequestMessage()

Returns

HttpRequestMessage

The Http request.