1 sharedlibrarycoreinterfaces IMetaService

RaidMax edited this page 2023-05-20 22:09:21 -05:00

Table of Contents

• IMetaService Public interface
• Diagram
• Members
• Methods
• Public methods
• Details
• Methods
• AddPersistentMeta [1/2]
• Arguments
• Summary
• Returns
• SetPersistentMeta
• Arguments
• Summary
• Returns
• IncrementPersistentMeta
• Arguments
• Summary
• Returns
• DecrementPersistentMeta
• Arguments
• Summary
• Returns
• AddPersistentMeta [2/2]
• Arguments
• Summary
• Returns
• RemovePersistentMeta [1/2]
• Arguments
• Summary
• Returns
• RemovePersistentMeta [2/2]
• Arguments
• Summary
• Returns
• GetPersistentMeta [1/2]
• Arguments
• Summary
• Returns
• GetPersistentMeta [2/2]
• Arguments
• Summary
• Returns
• AddRuntimeMeta
• Arguments
• GetRuntimeMeta [1/2]
• Arguments
• Summary
• Returns
• GetRuntimeMeta [2/2]
• Arguments

IMetaService Public interface

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph SharedLibraryCore.Interfaces
  SharedLibraryCore.Interfaces.IMetaService[[IMetaService]]
  class SharedLibraryCore.Interfaces.IMetaService interfaceStyle;
  end

Members

Methods

Public methods

Returns	Name
Task	AddPersistentMeta(...) adds or updates meta key and value to the database
void	AddRuntimeMeta(MetaType metaKey, Func<T, Task<IEnumerable<V>>> metaAction)
Task	DecrementPersistentMeta(string metaKey, int decrementAmount, int clientId) decrements meta value and persists to the database if the meta value does not already exist it will be set to the decrement amount
Task<EFMeta>	GetPersistentMeta(...) retrieves meta data for given client and key
Task<IEnumerable<IClientMeta>>	GetRuntimeMeta(...) retrieves all the runtime meta information for given client idea
Task	IncrementPersistentMeta(string metaKey, int incrementAmount, int clientId) increments meta value and persists to the database if the meta value does not already exist it will be set to the increment amount
Task	RemovePersistentMeta(...) removes meta key with given value
Task	SetPersistentMeta(string metaKey, string metaValue, int clientId) adds or updates meta key and value to the database

Details

Methods

AddPersistentMeta [1/2]

Source code

public Task AddPersistentMeta(string metaKey, string metaValue, EFClient client, EFMeta linkedMeta)

Arguments

Type	Name	Description
string	metaKey	key of meta data
string	metaValue	value of the meta data
EFClient	client	client to save the meta for
EFMeta	linkedMeta

Summary

adds or updates meta key and value to the database

Returns

SetPersistentMeta

Source code

public Task SetPersistentMeta(string metaKey, string metaValue, int clientId)

Arguments

Type	Name	Description
string	metaKey	key of meta data
string	metaValue	value of the meta data
int	clientId	id of the client to save the meta for

Summary

adds or updates meta key and value to the database

Returns

IncrementPersistentMeta

Source code

public Task IncrementPersistentMeta(string metaKey, int incrementAmount, int clientId)

Arguments

Type	Name	Description
string	metaKey	key of meta data
int	incrementAmount	value to increment by
int	clientId	id of the client to save the meta for

Summary

increments meta value and persists to the database if the meta value does not already exist it will be set to the increment amount

Returns

DecrementPersistentMeta

Source code

public Task DecrementPersistentMeta(string metaKey, int decrementAmount, int clientId)

Arguments

Type	Name	Description
string	metaKey	key of meta data
int	decrementAmount	value to increment by
int	clientId	id of the client to save the meta for

Summary

decrements meta value and persists to the database if the meta value does not already exist it will be set to the decrement amount

Returns

AddPersistentMeta [2/2]

Source code

public Task AddPersistentMeta(string metaKey, string metaValue)

Arguments

Type	Name	Description
string	metaKey	key of meta data
string	metaValue	value of the meta data

Summary

adds or updates meta key and value to the database

Returns

RemovePersistentMeta [1/2]

Source code

public Task RemovePersistentMeta(string metaKey, EFClient client)

Arguments

Type	Name	Description
string	metaKey	key of meta data
EFClient	client	client to delete the meta for

Summary

removes meta key with given value

Returns

RemovePersistentMeta [2/2]

Source code

public Task RemovePersistentMeta(string metaKey, string metaValue)

Arguments

Type	Name	Description
string	metaKey	key of the meta data
string	metaValue	value of the meta data

Summary

removes meta key with given value

Returns

GetPersistentMeta [1/2]

Source code

public Task<EFMeta> GetPersistentMeta(string metaKey, EFClient client)

Arguments

Type	Name	Description
string	metaKey	key to retrieve value for
EFClient	client	client to retrieve meta for

Summary

retrieves meta data for given client and key

Returns

GetPersistentMeta [2/2]

Source code

public Task<IEnumerable<EFMeta>> GetPersistentMeta(string metaKey)

Arguments

Type	Name	Description
string	metaKey	key to retrieve values for

Summary

retrieves collection of meta for given key

Returns

AddRuntimeMeta

Source code

public void AddRuntimeMeta<T, V>(MetaType metaKey, Func<T, Task<IEnumerable<V>>> metaAction)
where T : PaginationRequest
where V : IClientMeta

Arguments

Type	Name	Description
MetaType	metaKey
Func<T, Task<IEnumerable<V>>>	metaAction

GetRuntimeMeta [1/2]

Source code

public Task<IEnumerable<IClientMeta>> GetRuntimeMeta(ClientPaginationRequest request)

Arguments

Type	Name	Description
ClientPaginationRequest	request	request information

Summary

retrieves all the runtime meta information for given client idea

Returns

GetRuntimeMeta [2/2]

Source code

public Task<IEnumerable<T>> GetRuntimeMeta<T>(ClientPaginationRequest request, MetaType metaType)
where T : IClientMeta

Arguments

Type	Name	Description
ClientPaginationRequest	request
MetaType	metaType

Generated with ModularDoc

• Overview
• Getting Started
• FAQ
• Knowledge Base
• Features
  • Commands
  • Webfront
  • Game Interface
  • Permission Sets
  • Plugins
  • API
  • Searching
• Plugin Development
  • Examples
• Configuration
• Game Log Server