Class ShipmentCollection

Class representing a collection of EasyPost Shipments.

Inheritance

System.Object

EphemeralEasyPostObject

EasyPostObject

PaginatedCollection<Shipment>

ShipmentCollection

Implements

IEasyPostObject

Inherited Members

PaginatedCollection<Shipment>.HasMore

PaginatedCollection<Shipment>.GetNextPage<TCollection, TParameters>(Func<TParameters, Task<TCollection>>, Nullable<List<Shipment>>, Nullable<Int32>)

EasyPostObject.CreatedAt

EasyPostObject.Id

EasyPostObject.UpdatedAt

EasyPostObject.Prefix

EasyPostObject.AsDictionary()

EasyPostObject.ToString()

EasyPostObject.Equals(Nullable<Object>)

EasyPostObject.GetHashCode()

EphemeralEasyPostObject.Mode

EphemeralEasyPostObject.AsJson()

Namespace: EasyPost.Models.API

Assembly: EasyPost.dll

Syntax

public class ShipmentCollection : PaginatedCollection<Shipment>, IEasyPostObject

Properties

Shipments

The Shipments in the collection.

Declaration

public List<Shipment>? Shipments { get; set; }

Property Value

Type	Description
System.Nullable<List<Shipment>>

Methods

BuildNextPageParameters<TParameters>(IEnumerable<Shipment>, Nullable<Int32>)

Construct the parameter set for retrieving the next page of this paginated collection.

Declaration

public override TParameters BuildNextPageParameters<TParameters>(IEnumerable<Shipment> entries, int? pageSize = null)
    where TParameters : BaseParameters<Shipment>

Parameters

Type	Name	Description
IEnumerable<Shipment>	entries	The entries on the current page of this paginated collection.
System.Nullable<System.Int32>	pageSize	The request size of the next page.

Returns

Type	Description
TParameters	A TParameters-type parameters set.

Type Parameters

Name	Description
TParameters	The type of parameters to construct.

Overrides

EasyPost.Models.Shared.PaginatedCollection<EasyPost.Models.API.Shipment>.BuildNextPageParameters<TParameters>(IEnumerable<EasyPost.Models.API.Shipment>, System.Nullable<System.Int32>)

Implements

IEasyPostObject