Interface ISyncQueue
Interface for the synchronization queue.
Namespace: Kinvey
Assembly: Kinvey.dll
Syntax
public interface ISyncQueue
Properties
| Improve this Doc View SourceCollection
Collection name.
Declaration
string Collection { get; }
Property Value
Type | Description |
---|---|
System.String | Collection name. |
Methods
| Improve this Doc View SourceCount(Boolean)
Gets count of pending write action items.
Declaration
int Count(bool allCollections)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | allCollections |
|
Returns
Type | Description |
---|---|
System.Int32 | The count of pending write action items. |
Enqueue(PendingWriteAction)
Enqueues a pending write action item.
Declaration
int Enqueue(PendingWriteAction pending)
Parameters
Type | Name | Description |
---|---|---|
PendingWriteAction | pending | Pending write action item. |
Returns
Type | Description |
---|---|
System.Int32 | The count of enqueued pending write action items. |
GetAll()
Gets all pending write action items for specific collection.
Declaration
List<PendingWriteAction> GetAll()
Returns
Type | Description |
---|---|
List<PendingWriteAction> | The list of pending write action items. |
GetByID(String)
Gets pending write action item.
Declaration
PendingWriteAction GetByID(string entityId)
Parameters
Type | Name | Description |
---|---|---|
System.String | entityId | The identifier of entity. |
Returns
Type | Description |
---|---|
PendingWriteAction | The pending write action item. |
GetFirstN(Int32, Int32)
Gets pending write action items according to limit and offset.
Declaration
List<PendingWriteAction> GetFirstN(int limit, int offset)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | limit | Limit. |
System.Int32 | offset | Offset. |
Returns
Type | Description |
---|---|
List<PendingWriteAction> | The list of pending write action items. |
GetFirstN(Int32, Int32, String)
Gets pending write action items according to limit, offset and action.
Declaration
List<PendingWriteAction> GetFirstN(int limit, int offset, string action)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | limit | Limit. |
System.Int32 | offset | Offset. |
System.String | action | Action. |
Returns
Type | Description |
---|---|
List<PendingWriteAction> | The list of pending write action items. |
Peek()
Fetches the first pending write action item.
Declaration
PendingWriteAction Peek()
Returns
Type | Description |
---|---|
PendingWriteAction | Received pending write action item from a source. |
Pop()
Fetches and deletes the first pending write action item.
Declaration
PendingWriteAction Pop()
Returns
Type | Description |
---|---|
PendingWriteAction | Received pending write action item from a source. |
Remove(IEnumerable<PendingWriteAction>)
Removes pending write action items.
Declaration
int Remove(IEnumerable<PendingWriteAction> pendings)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<PendingWriteAction> | pendings | Pending write action items. |
Returns
Type | Description |
---|---|
System.Int32 | The count of removed pending write action items. |
Remove(PendingWriteAction)
Removes pending write action item.
Declaration
int Remove(PendingWriteAction pending)
Parameters
Type | Name | Description |
---|---|---|
PendingWriteAction | pending | Pending write action item. |
Returns
Type | Description |
---|---|
System.Int32 | The count of removed pending write action items. |
RemoveAll()
Removes all pending write action items.
Declaration
int RemoveAll()
Returns
Type | Description |
---|---|
System.Int32 | The count of removed pending write action items. |