Class ServiceBase#
Defined in File ServiceBase.cs
Inheritance Relationships#
Derived Types#
public xbe.sdk.QuestDefinitionService(Class QuestDefinitionService)public xbe.sdk.Services.AccessControlListService(Class AccessControlListService)public xbe.sdk.Services.AchievementDefinitionService(Class AchievementDefinitionService)public xbe.sdk.Services.AchievementService(Class AchievementService)public xbe.sdk.Services.ArchetypeDefinitionService(Class ArchetypeDefinitionService)public xbe.sdk.Services.ArchetypeService(Class ArchetypeService)public xbe.sdk.Services.AssetService(Class AssetService)public xbe.sdk.Services.AssetStorageLocationService(Class AssetStorageLocationService)public xbe.sdk.Services.AuthBasicService(Class AuthBasicService)public xbe.sdk.Services.AuthEmailService(Class AuthEmailService)public xbe.sdk.Services.AuthOAuthService(Class AuthOAuthService)public xbe.sdk.Services.AuthPhoneService(Class AuthPhoneService)public xbe.sdk.Services.AuthSteamService(Class AuthSteamService)public xbe.sdk.Services.AuthTokenService(Class AuthTokenService)public xbe.sdk.Services.AuthTotpService(Class AuthTotpService)public xbe.sdk.Services.AuthXsollaService(Class AuthXsollaService)public xbe.sdk.Services.BackupService(Class BackupService)public xbe.sdk.Services.BackupStorageLocationService(Class BackupStorageLocationService)public xbe.sdk.Services.ContactService(Class ContactService)public xbe.sdk.Services.EventService(Class EventService)public xbe.sdk.Services.LaunchProfileService(Class LaunchProfileService)public xbe.sdk.Services.LeaderboardRecordService(Class LeaderboardRecordService)public xbe.sdk.Services.LeaderboardService(Class LeaderboardService)public xbe.sdk.Services.MessageService(Class MessageService)public xbe.sdk.Services.OAuthClientService(Class OAuthClientService)public xbe.sdk.Services.OAuthProviderService(Class OAuthProviderService)public xbe.sdk.Services.OAuthService(Class OAuthService)public xbe.sdk.Services.OrderService(Class OrderService)public xbe.sdk.Services.OrganizationService(Class OrganizationService)public xbe.sdk.Services.PaymentService(Class PaymentService)public xbe.sdk.Services.PersonaResourceService(Class PersonaResourceService)public xbe.sdk.Services.PersonaService(Class PersonaService)public xbe.sdk.Services.PersonaStatDefinitionService(Class PersonaStatDefinitionService)public xbe.sdk.Services.PersonaStatService(Class PersonaStatService)public xbe.sdk.Services.ProductCategoryService(Class ProductCategoryService)public xbe.sdk.Services.ProductFeatureService(Class ProductFeatureService)public xbe.sdk.Services.ProductService(Class ProductService)public xbe.sdk.Services.ProfileService(Class ProfileService)public xbe.sdk.Services.PromoCodeService(Class PromoCodeService)public xbe.sdk.Services.PurchaseService(Class PurchaseService)public xbe.sdk.Services.PurchaseValidationService(Class PurchaseValidationService)public xbe.sdk.Services.QuestService(Class QuestService)public xbe.sdk.Services.ResourceService(Class ResourceService)public xbe.sdk.Services.RestoreService(Class RestoreService)public xbe.sdk.Services.RoleService(Class RoleService)public xbe.sdk.Services.ScalingPolicyService(Class ScalingPolicyService)public xbe.sdk.Services.ScriptService(Class ScriptService)public xbe.sdk.Services.ServerInstanceService(Class ServerInstanceService)public xbe.sdk.Services.SessionService(Class SessionService)public xbe.sdk.Services.ShardService(Class ShardService)public xbe.sdk.Services.SkillService(Class SkillService)public xbe.sdk.Services.SnapshotService(Class SnapshotService)public xbe.sdk.Services.SystemService(Class SystemService)public xbe.sdk.Services.TicketService(Class TicketService)public xbe.sdk.Services.TransactionService(Class TransactionService)public xbe.sdk.Services.UserLinkService(Class UserLinkService)public xbe.sdk.Services.UserSecretService(Class UserSecretService)public xbe.sdk.Services.UserService(Class UserService)public xbe.sdk.SkillDefinitionService(Class SkillDefinitionService)public xbe.sdk.ZoneService(Class ZoneService)
Class Documentation#
- class xbe.sdk.ServiceBase#
Provides a common abstract base class for all Service utility classes.
Subclassed by xbe.sdk.QuestDefinitionService, xbe.sdk.Services.AccessControlListService, xbe.sdk.Services.AchievementDefinitionService, xbe.sdk.Services.AchievementService, xbe.sdk.Services.ArchetypeDefinitionService, xbe.sdk.Services.ArchetypeService, xbe.sdk.Services.AssetService, xbe.sdk.Services.AssetStorageLocationService, xbe.sdk.Services.AuthBasicService, xbe.sdk.Services.AuthEmailService, xbe.sdk.Services.AuthOAuthService, xbe.sdk.Services.AuthPhoneService, xbe.sdk.Services.AuthSteamService, xbe.sdk.Services.AuthTokenService, xbe.sdk.Services.AuthTotpService, xbe.sdk.Services.AuthXsollaService, xbe.sdk.Services.BackupService, xbe.sdk.Services.BackupStorageLocationService, xbe.sdk.Services.ContactService, xbe.sdk.Services.EventService, xbe.sdk.Services.LaunchProfileService, xbe.sdk.Services.LeaderboardRecordService, xbe.sdk.Services.LeaderboardService, xbe.sdk.Services.MailService, xbe.sdk.Services.MessageService, xbe.sdk.Services.OAuthClientService, xbe.sdk.Services.OAuthProviderService, xbe.sdk.Services.OAuthService, xbe.sdk.Services.OrderService, xbe.sdk.Services.OrganizationService, xbe.sdk.Services.PaymentService, xbe.sdk.Services.PersonaResourceService, xbe.sdk.Services.PersonaService, xbe.sdk.Services.PersonaStatDefinitionService, xbe.sdk.Services.PersonaStatService, xbe.sdk.Services.ProductCategoryService, xbe.sdk.Services.ProductFeatureService, xbe.sdk.Services.ProductService, xbe.sdk.Services.ProfileService, xbe.sdk.Services.PromoCodeService, xbe.sdk.Services.PurchaseService, xbe.sdk.Services.PurchaseValidationService, xbe.sdk.Services.QuestService, xbe.sdk.Services.RelationshipService, xbe.sdk.Services.ResourceService, xbe.sdk.Services.RestoreService, xbe.sdk.Services.RoleService, xbe.sdk.Services.ScalingPolicyService, xbe.sdk.Services.ScriptService, xbe.sdk.Services.ServerInstanceService, xbe.sdk.Services.SessionService, xbe.sdk.Services.ShardService, xbe.sdk.Services.SkillService, xbe.sdk.Services.SnapshotService, xbe.sdk.Services.SystemService, xbe.sdk.Services.TicketService, xbe.sdk.Services.TransactionService, xbe.sdk.Services.UserSecretService, xbe.sdk.Services.UserService, xbe.sdk.SkillDefinitionService, xbe.sdk.ZoneService
Public Functions
- ServiceBase ()#
Properties
- string Path { get; set; }#
The compiled url path.
Protected Functions
- Task<List<T>> FindAll<T> (Dictionary<string, string> query = null)#
Returns all entities from the system that the user has access to.
- Tparam T:
Entity Type
- Param Path:
Service URL path
- Param query:
The optional map containing the query parameters that will be appended to the url.
- Return:
Task with result of a List of all Entities
- Task<List<T>> FindAll<T> (string path, Dictionary<string, string> query = null)
Returns all entities from the system that the user has access to.
- Tparam T:
Entity Type
- Param Path:
Service URL path
- Param query:
The optional map containing the query parameters that will be appended to the url.
- Return:
Task with result of a List of all Entities
- Task<T> Create<T> (Object obj, Dictionary<string, string> query = null, Dictionary<string, string> headers = null)#
Creates a new instance of T, storing the object on the remote service and returning the final result.
- Tparam T:
Entity Type
- Param Path:
Service URL path
- Param query:
The optional map containing the query parameters that will be appended to the url.
- Return:
Task with resulting created Entity
- Task<T> Create<T> (string path, Object obj, Dictionary<string, string> query = null, Dictionary<string, string> headers = null)
Creates a new instance of T, storing the object on the remote service and returning the final result.
- Tparam T:
Entity Type
- Param Path:
Service URL path
- Param query:
The optional map containing the query parameters that will be appended to the url.
- Return:
Task with resulting created Entity
- Task<long?> CountInternal (Dictionary<string, string> query = null)#
Retrieves the Entities Count based on the given criteria.
- Return:
Entity Count
- Task<long?> CountInternal (string path, Dictionary<string, string> query = null)
Retrieves the Entities Count based on the given criteria.
- Return:
Entity Count
- Task<long?> CountLegacy<T> (Dictionary<string, string> query = null, Dictionary<string, string> headers = null)#
Retrieves the Entities Count based on the given criteria.
- Return:
Entity Count
- Task<T> FindById<T> (Guid id)#
Retrieves an Entity by ID.
- Tparam T:
Entity Type
- Param id:
Id of the entity retrieved
- Return:
Task with result of Entity related to given ID
- Task<T> FindById<T> (string url)
Retrieves an Entity by ID.
- Tparam T:
Entity Type
- Param id:
Id of the entity retrieved
- Return:
Task with result of Entity related to given ID
- Task<T> Update<T> (Guid id, T obj)#
Updates an Entity by ID.
- Tparam T:
Entity Type
- Param id:
Id of the entity updated
- Param obj:
Entity Updated
- Return:
Task with result Updated Entity related to given ID
- Task<T> Update<T> (string path, T obj)
Updates an Entity by ID.
- Tparam T:
Entity Type
- Param id:
Id of the entity updated
- Param obj:
Entity Updated
- Return:
Task with result Updated Entity related to given ID
- Task<T> Get<T> (string url)#
- Tparam T:
- Param url:
- Return:
- Task<T> Get<T> (string url, string id)
- Tparam T:
- Param url:
- Return:
- Task DeleteInternal (string id)#
Deletes an instance of T with the specified unique identifier.
- Return:
Task
- Task TruncateInternal (Dictionary<string, string> query = null)#
Deletes all Entities from the service.
- Return:
Task
Protected Static Functions
- Dictionary<string, string> CreateAccessTokenQuery (string accessToken)#
Get query for auth/connect if you already have the accessToken (via 3rd-party SDK).
- Param accessToken:
The final, authenticated token to allow S2S requests
- Return:
Returns { access_token }