Beamable SDK
Public Member Functions | Properties | Events | List of all members
Core.Platform.SDK.Analytics.Batch.IBatchContainer< T > Interface Template Reference

Batch Container Interface Batch containers encapsulate the data of a batch More...

Inheritance diagram for Core.Platform.SDK.Analytics.Batch.IBatchContainer< T >:
Inheritance graph
[legend]

Public Member Functions

void Add (T item)
 Add the specified item to the batch. More...
 
void Expire ()
 Expire this batch. More...
 

Properties

bool IsExpired [get]
 Gets a value indicating whether this batch is expired. More...
 
long ExpiresTimestamp [get]
 Gets the expires (unix) timestamp. More...
 
int Capacity [get]
 Gets the batch's max capacity before expiration. More...
 
int Count [get]
 Gets the count of elements in the batch. More...
 

Events

Action< List< T > > OnExpired
 Occurs when the batch expires. More...
 

Detailed Description

Batch Container Interface Batch containers encapsulate the data of a batch

Member Function Documentation

◆ Add()

Add the specified item to the batch.

Parameters
itemItem.

Implemented in Core.Platform.SDK.Analytics.Batch.BatchContainer< T >.

◆ Expire()

Expire this batch.

Implemented in Core.Platform.SDK.Analytics.Batch.BatchContainer< T >.

Property Documentation

◆ Capacity

Gets the batch's max capacity before expiration.

The capacity.

◆ Count

Gets the count of elements in the batch.

The count.

◆ ExpiresTimestamp

long Core.Platform.SDK.Analytics.Batch.IBatchContainer< T >.ExpiresTimestamp
get

Gets the expires (unix) timestamp.

The expires timestamp.

◆ IsExpired

Gets a value indicating whether this batch is expired.

true if this instance is expired; otherwise, false.

Event Documentation

◆ OnExpired

Action<List<T> > Core.Platform.SDK.Analytics.Batch.IBatchContainer< T >.OnExpired

Occurs when the batch expires.


The documentation for this interface was generated from the following file: