Struct GetArchivesRequest

Namespace

Vonage.Video.Archives.GetArchives

Assembly

Vonage.dll

Represents a request to retrieve archives.

[Builder(new string[] { })]
public readonly struct GetArchivesRequest : IVonageRequest, IHasApplicationId

Implements

IVonageRequest

IHasApplicationId

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

ApplicationId

The Vonage Application UUID.

[Mandatory(0)]
public Guid ApplicationId { get; }

Property Value

Guid

Count

Sets the maximum number of archives to return. The default is 50 and the maximum is 1000.

[OptionalWithDefault("int", "50")]
public int Count { get; }

Property Value

int

Examples

.WithCount(100)

Offset

Sets the index offset of the first archive to return. 0 (the default) is the most recently started archive.

[OptionalWithDefault("int", "0")]
public int Offset { get; }

Property Value

int

Examples

.WithOffset(10)

SessionId

Sets a session ID filter to list archives for a specific session. Useful when listing multiple archives for an automatically archived session.

public Maybe<string> SessionId { get; }

Property Value

Maybe<string>

Examples

.WithSessionId("flR1ZSBPY3QgMjkgMTI6MTM6MjMgUERUIDIwMTN")

Methods

Build()

public static IBuilderForApplicationId Build()

Returns

IBuilderForApplicationId

BuildRequestMessage()

Converts the request to a HttpRequest.

public HttpRequestMessage BuildRequestMessage()

Returns

HttpRequestMessage

The Http request.