Class ShardService#
Defined in File ShardService.cs
Nested Relationships#
Nested Types#
Inheritance Relationships#
Base Type#
public xbe.sdk.ServiceBase(Class ServiceBase)
Class Documentation#
- class xbe.sdk.Services.ShardService : xbe.sdk.ServiceBase#
Public Functions
- ShardService ()#
- Task<List<Shard>> FindAll (Dictionary<string, string> query = null)#
Retrieves a list of objects matching the specified search parameters.
- Param query:
A map of property names to values to search for.
- Return:
A task whose result is a list of objects matching the specified search parameters.
- Task<List<Shard>> FindAllByZoneUid (Guid zoneUid, Dictionary<string, string> query = null)#
Retrieves a list of objects belonging to the given zone and matching the specified search parameters.
- Param zoneUid:
The uid of the zone whose shards will be searched.
- Param query:
A map of property names to values to search for.
- Return:
A task whose result is a list of objects matching the specified search parameters.
- Task<List<Shard>> FindPreferredByZoneUid (Guid zoneUid, Dictionary<string, string> query = null)#
Retrieves a list of shards belonging to the given zone and matching the specified search parameters that are most preferred for the authenticated user,.
- Param zoneUid:
The uid of the zone whose shards will be searched.
- Param query:
A map of property names to values to search for.
- Return:
A task whose result is a list of objects matching the specified search parameters.
- async Task<long> CountByZoneUid (Guid zoneUid, Dictionary<string, string> query = null)#
Retrieves the total number of objects belonging to the given zone and matching the specified search parameters.
- Param zoneUid:
The uid of the zone whose shards will be counted.
- Param query:
A map of property names to values to search for.
- Return:
A task whose result is the number of objects matching the specified search parameters.
- Task<Shard> FindById (string id)#
Retrieves an instance of Shard with the specified unique identifier.
- Param id:
The id value which uniquely identifies the object.
- Return:
A task whose result is the object with the specified identifier if found.
- Task<Shard> Join (string id)#
Attempts to have the logged in user join the shard with the specified identifier.
- Param id:
value of the shard to join.
- Return:
A task whose result is the object with the specified identifier if joined.
- Task Leave (string id)#
Attempts to have the logged in user leave the shard with the specified identifier.
- Param id:
The id value which uniquely identifies the object.
- Return:
A task.
- Task<Shard> Update (string id, Shard obj)#
Updates an existing instance of Shard, storing the object on the remote service and returning the final result.
- Param id:
The id value which uniquely identifies the object.
- Param obj:
<The object to update with the remote service./param>
- Return:
A task whose result is the final object as it was persisted with the remote service.
- Task<Shard> UpdateHeartbeat (string id)#
Retrieves an instance of Shard with the specified unique identifier and updates heartbeat.
- Param id:
The id value which uniquely identifies the object.
- Return:
A task whose result is the object with the specified identifier if found.
- Task<long?> Count (Dictionary<string, string> query = null)#
Retrieves the Entities Count based on the given criteria.
- Return:
Entity Count
- Task Delete (string id)#
Deletes an instance of T with the specified unique identifier.
- Return:
Task
- Task Truncate (Dictionary<string, string> query = null)#
Deletes all Entities from the service.
- Return:
Task
- class Zone#