Defines a storage for BeamHints. It is a query-able in-memory database of BeamHints. Other IBeamHintSystem systems add hints to these and IBeamHintSystem read, filter, clear and arrange data logically in relation to BeamHintHeaders to be read by UI. More...
Public Member Functions | |
| void | AddOrReplaceHint (BeamHintType type, string hintDomain, string uniqueId, object hintContextObj=null) |
| Adds a hint to the storage. More... | |
| void | AddOrReplaceHint (BeamHintHeader header, object hintContextObj=null) |
| Adds a hint to the storage. More... | |
| void | AddOrReplaceHints (IEnumerable< BeamHintHeader > headers, IEnumerable< object > hintContextObjs) |
| Takes in two parallel IEnumerable<T> (same-length arrays) of BeamHintHeader/object pairs and add them to the storage. More... | |
| void | AddOrReplaceHints (IEnumerable< BeamHint > bakedHints) |
| Adds the given BeamHints. More... | |
| void | RemoveHint (BeamHintHeader header) |
| Removes the BeamHint identified by the header . More... | |
| void | RemoveHint (BeamHint hint) |
| Removes the given hint from the storage. More... | |
| void | RemoveHints (IEnumerable< BeamHintHeader > headers) |
| Removes the BeamHints identified by the given headers from the storage. More... | |
| void | RemoveHints (IEnumerable< BeamHint > hints) |
| Removes the given hints from the storage. More... | |
| int | RemoveAllHints (IEnumerable< string > hintDomains, IEnumerable< string > hintIds) |
| Removes all hints that Regex.Match(string) of any of the given hintDomains and hintIds . More... | |
| int | RemoveAllHints (BeamHintType type) |
| Remove all hints of the given type . More... | |
| int | RemoveAllHints (string hintDomainRegex=".*", string idRegex=".*") |
| Removes all hints that Regex.Match(string) of the given hintDomainRegex and idRegex . More... | |
| BeamHint | GetHint (BeamHintHeader header) |
| Given a header , returns a BeamHint containing it's associated BeamHint.ContextObject. More... | |
Detailed Description
Defines a storage for BeamHints. It is a query-able in-memory database of BeamHints. Other IBeamHintSystem systems add hints to these and IBeamHintSystem read, filter, clear and arrange data logically in relation to BeamHintHeaders to be read by UI.
Member Function Documentation
◆ AddOrReplaceHint() [1/2]
| void Beamable.Common.Assistant.IBeamHintStorage.AddOrReplaceHint | ( | BeamHintHeader | header, |
| object | hintContextObj = null |
||
| ) |
Adds a hint to the storage.
- Parameters
-
header A pre-built BeamHintHeader to add. hintContextObj Any arbitrary data that you wish to tie to the hint.
Implemented in Beamable.Common.Assistant.BeamHintGlobalStorage, and Beamable.Common.Assistant.BeamHintStorage.
◆ AddOrReplaceHint() [2/2]
| void Beamable.Common.Assistant.IBeamHintStorage.AddOrReplaceHint | ( | BeamHintType | type, |
| string | hintDomain, | ||
| string | uniqueId, | ||
| object | hintContextObj = null |
||
| ) |
Adds a hint to the storage.
- Parameters
-
type The type of hint that it is. originSystem The system that originated this hint. hintDomain An arbitrary contextual grouping for the hint. uniqueId An id, unique when combined with hintDomain , that identifies the hint. hintContextObj Any arbitrary data that you wish to tie to the hint.
Implemented in Beamable.Common.Assistant.BeamHintGlobalStorage, and Beamable.Common.Assistant.BeamHintStorage.
◆ AddOrReplaceHints() [1/2]
| void Beamable.Common.Assistant.IBeamHintStorage.AddOrReplaceHints | ( | IEnumerable< BeamHint > | bakedHints | ) |
Adds the given BeamHints.
Implemented in Beamable.Common.Assistant.BeamHintGlobalStorage, and Beamable.Common.Assistant.BeamHintStorage.
◆ AddOrReplaceHints() [2/2]
| void Beamable.Common.Assistant.IBeamHintStorage.AddOrReplaceHints | ( | IEnumerable< BeamHintHeader > | headers, |
| IEnumerable< object > | hintContextObjs | ||
| ) |
Takes in two parallel IEnumerable<T> (same-length arrays) of BeamHintHeader/object pairs and add them to the storage.
Implemented in Beamable.Common.Assistant.BeamHintGlobalStorage, and Beamable.Common.Assistant.BeamHintStorage.
◆ GetHint()
| BeamHint Beamable.Common.Assistant.IBeamHintStorage.GetHint | ( | BeamHintHeader | header | ) |
Given a header , returns a BeamHint containing it's associated BeamHint.ContextObject.
Implemented in Beamable.Common.Assistant.BeamHintGlobalStorage, and Beamable.Common.Assistant.BeamHintStorage.
◆ RemoveAllHints() [1/3]
| int Beamable.Common.Assistant.IBeamHintStorage.RemoveAllHints | ( | BeamHintType | type | ) |
Remove all hints of the given type .
- Parameters
-
type The BeamHintTypes to remove.
- Returns
- The amount of BeamHints removed.
Implemented in Beamable.Common.Assistant.BeamHintGlobalStorage, and Beamable.Common.Assistant.BeamHintStorage.
◆ RemoveAllHints() [2/3]
| int Beamable.Common.Assistant.IBeamHintStorage.RemoveAllHints | ( | IEnumerable< string > | hintDomains, |
| IEnumerable< string > | hintIds | ||
| ) |
Removes all hints that Regex.Match(string) of any of the given hintDomains and hintIds .
Implemented in Beamable.Common.Assistant.BeamHintGlobalStorage, and Beamable.Common.Assistant.BeamHintStorage.
◆ RemoveAllHints() [3/3]
| int Beamable.Common.Assistant.IBeamHintStorage.RemoveAllHints | ( | string | hintDomainRegex = ".*", |
| string | idRegex = ".*" |
||
| ) |
Removes all hints that Regex.Match(string) of the given hintDomainRegex and idRegex .
Implemented in Beamable.Common.Assistant.BeamHintGlobalStorage, and Beamable.Common.Assistant.BeamHintStorage.
◆ RemoveHint() [1/2]
| void Beamable.Common.Assistant.IBeamHintStorage.RemoveHint | ( | BeamHint | hint | ) |
Removes the given hint from the storage.
Implemented in Beamable.Common.Assistant.BeamHintGlobalStorage, and Beamable.Common.Assistant.BeamHintStorage.
◆ RemoveHint() [2/2]
| void Beamable.Common.Assistant.IBeamHintStorage.RemoveHint | ( | BeamHintHeader | header | ) |
Removes the BeamHint identified by the header .
Implemented in Beamable.Common.Assistant.BeamHintGlobalStorage, and Beamable.Common.Assistant.BeamHintStorage.
◆ RemoveHints() [1/2]
| void Beamable.Common.Assistant.IBeamHintStorage.RemoveHints | ( | IEnumerable< BeamHint > | hints | ) |
Removes the given hints from the storage.
Implemented in Beamable.Common.Assistant.BeamHintGlobalStorage, and Beamable.Common.Assistant.BeamHintStorage.
◆ RemoveHints() [2/2]
| void Beamable.Common.Assistant.IBeamHintStorage.RemoveHints | ( | IEnumerable< BeamHintHeader > | headers | ) |
Removes the BeamHints identified by the given headers from the storage.
Implemented in Beamable.Common.Assistant.BeamHintGlobalStorage, and Beamable.Common.Assistant.BeamHintStorage.
The documentation for this interface was generated from the following file:
- com.beamable/Common/Runtime/BeamHints/IBeamHintStorage.cs
