Inheritance diagram for Beamable.Common.Assistant.BeamHintGlobalStorage:

[legend]

Collaboration diagram for Beamable.Common.Assistant.BeamHintGlobalStorage:

[legend]

Public Member Functions
IEnumerator< BeamHint >	GetEnumerator ()

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...

void	BatchAddBeamHints (string domainOwner, IEnumerable< BeamHintHeader > headers, IEnumerable< object > hintContextObj)
	More performant version of IBeamHintStorage.AddOrReplaceHints(System.Collections.Generic.IEnumerable<Common.Runtime.BeamHints.BeamHintHeader>,System.Collections.Generic.IEnumerable<object>) for the global case. Call this if you know that all hints are either BeamHintDomains.IsBeamableDomain or BeamHintDomains.IsUserDomain. More...

void	BatchAddBeamHints (string domainOwner, IEnumerable< BeamHint > hints)
	More performant version of IBeamHintStorage.AddOrReplaceHints(System.Collections.Generic.IEnumerable<Common.Runtime.BeamHints.BeamHint>) for the global case. Call this if you know that all hints are either BeamHintDomains.IsBeamableDomain or BeamHintDomains.IsUserDomain. More...

Properties
IBeamHintStorage	UserDefinedStorage `[get]`

IBeamHintStorage	BeamableStorage `[get]`

IEnumerable< BeamHint >	All `[get]`

IEnumerable< BeamHint >	ReflectionCacheHints `[get]`

IEnumerable< BeamHint >	CSharpMSHints `[get]`

IEnumerable< BeamHint >	ContentHints `[get]`

IEnumerable< BeamHint >	AssistantHints `[get]`

Properties inherited from Beamable.Common.Assistant.IBeamHintGlobalStorage
IEnumerable< BeamHint >	All `[get]`
	The combined hints of all internal IBeamHintStorages.

IBeamHintStorage	UserDefinedStorage `[get]`
	User-defined domains go into this storage (see BeamHintDomains.IsUserDomain). Our Beamable Assistant UI continuously detects hints added to this storage automatically and displays it in a special section for User domains.

IBeamHintStorage	BeamableStorage `[get]`
	Beamable-defined hints are stored here.

IEnumerable< BeamHint >	ReflectionCacheHints `[get]`
	Contains the BeamHint for the entire BeamHintDomains.BEAM_REFLECTION_CACHE domain.

IEnumerable< BeamHint >	CSharpMSHints `[get]`
	Contains the BeamHints for the entire BeamHintDomains.BEAM_CSHARP_MICROSERVICES domain.

IEnumerable< BeamHint >	ContentHints `[get]`
	Contains the BeamHints for the entire BeamHintDomains.BEAM_CONTENT domain.

IEnumerable< BeamHint >	AssistantHints `[get]`
	Contains the BeamHints for the entire BeamHintDomains.BEAM_ASSISTANT domain.

Member Function Documentation

◆ AddOrReplaceHint() [1/2]

void Beamable.Common.Assistant.BeamHintGlobalStorage.AddOrReplaceHint	(	BeamHintHeader	header,
		object	hintContextObj = `null`
	)

inline

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.

Implements Beamable.Common.Assistant.IBeamHintStorage.

◆ AddOrReplaceHint() [2/2]

void Beamable.Common.Assistant.BeamHintGlobalStorage.AddOrReplaceHint	(	BeamHintType	type,
		string	hintDomain,
		string	uniqueId,
		object	hintContextObj = `null`
	)

inline

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.

Implements Beamable.Common.Assistant.IBeamHintStorage.

◆ AddOrReplaceHints() [1/2]

void Beamable.Common.Assistant.BeamHintGlobalStorage.AddOrReplaceHints ( IEnumerable< BeamHint > bakedHints )

inline

Adds the given BeamHints.

Implements Beamable.Common.Assistant.IBeamHintStorage.

◆ AddOrReplaceHints() [2/2]

void Beamable.Common.Assistant.BeamHintGlobalStorage.AddOrReplaceHints	(	IEnumerable< BeamHintHeader >	headers,
		IEnumerable< object >	hintContextObjs
	)

inline

Takes in two parallel IEnumerable<T> (same-length arrays) of BeamHintHeader/object pairs and add them to the storage.

Implements Beamable.Common.Assistant.IBeamHintStorage.

◆ BatchAddBeamHints() [1/2]

void Beamable.Common.Assistant.BeamHintGlobalStorage.BatchAddBeamHints	(	string	domainOwner,
		IEnumerable< BeamHint >	hints
	)

inline

More performant version of IBeamHintStorage.AddOrReplaceHints(System.Collections.Generic.IEnumerable<Common.Runtime.BeamHints.BeamHint>) for the global case. Call this if you know that all hints are either BeamHintDomains.IsBeamableDomain or BeamHintDomains.IsUserDomain.

Parameters

domainOwner	Either BeamHintDomains.BEAM_DOMAIN_PREFIX or BeamHintDomains.USER_DOMAIN_PREFIX.
hints	The BeamHints to add.

Implements Beamable.Common.Assistant.IBeamHintGlobalStorage.

◆ BatchAddBeamHints() [2/2]

void Beamable.Common.Assistant.BeamHintGlobalStorage.BatchAddBeamHints	(	string	domainOwner,
		IEnumerable< BeamHintHeader >	headers,
		IEnumerable< object >	hintContextObj
	)

inline

More performant version of IBeamHintStorage.AddOrReplaceHints(System.Collections.Generic.IEnumerable<Common.Runtime.BeamHints.BeamHintHeader>,System.Collections.Generic.IEnumerable<object>) for the global case. Call this if you know that all hints are either BeamHintDomains.IsBeamableDomain or BeamHintDomains.IsUserDomain.

Parameters

domainOwner	Either BeamHintDomains.BEAM_DOMAIN_PREFIX or BeamHintDomains.USER_DOMAIN_PREFIX.
headers	List of headers to add. Parallel to hintContextObj .
hintContextObj	List of context objects to add. Parallel to headers .

Implements Beamable.Common.Assistant.IBeamHintGlobalStorage.

◆ GetHint()

BeamHint Beamable.Common.Assistant.BeamHintGlobalStorage.GetHint ( BeamHintHeader header )

inline

Given a header , returns a BeamHint containing it's associated BeamHint.ContextObject.

Implements Beamable.Common.Assistant.IBeamHintStorage.

◆ RemoveAllHints() [1/3]

int Beamable.Common.Assistant.BeamHintGlobalStorage.RemoveAllHints ( BeamHintType type )

inline

Remove all hints of the given type .

Parameters

type	The BeamHintTypes to remove.

Returns: The amount of BeamHints removed.

Implements Beamable.Common.Assistant.IBeamHintStorage.

◆ RemoveAllHints() [2/3]

int Beamable.Common.Assistant.BeamHintGlobalStorage.RemoveAllHints	(	IEnumerable< string >	hintDomains,
		IEnumerable< string >	hintIds
	)

inline

Removes all hints that Regex.Match(string) of any of the given hintDomains and hintIds .

Implements Beamable.Common.Assistant.IBeamHintStorage.

◆ RemoveAllHints() [3/3]

int Beamable.Common.Assistant.BeamHintGlobalStorage.RemoveAllHints	(	string	hintDomainRegex = `".*"`,
		string	idRegex = `".*"`
	)

inline

Removes all hints that Regex.Match(string) of the given hintDomainRegex and idRegex .

Implements Beamable.Common.Assistant.IBeamHintStorage.

◆ RemoveHint() [1/2]

void Beamable.Common.Assistant.BeamHintGlobalStorage.RemoveHint ( BeamHint hint )

inline

Removes the given hint from the storage.

Implements Beamable.Common.Assistant.IBeamHintStorage.

◆ RemoveHint() [2/2]

void Beamable.Common.Assistant.BeamHintGlobalStorage.RemoveHint ( BeamHintHeader header )

inline

Removes the BeamHint identified by the header .

Implements Beamable.Common.Assistant.IBeamHintStorage.

◆ RemoveHints() [1/2]

void Beamable.Common.Assistant.BeamHintGlobalStorage.RemoveHints ( IEnumerable< BeamHint > hints )

inline

Removes the given hints from the storage.

Implements Beamable.Common.Assistant.IBeamHintStorage.

◆ RemoveHints() [2/2]

void Beamable.Common.Assistant.BeamHintGlobalStorage.RemoveHints ( IEnumerable< BeamHintHeader > headers )

inline

Removes the BeamHints identified by the given headers from the storage.

Implements Beamable.Common.Assistant.IBeamHintStorage.

The documentation for this class was generated from the following file:

com.beamable/Common/Runtime/BeamHints/IBeamHintGlobalStorage.cs

Public Member Functions

Properties

Member Function Documentation

◆ AddOrReplaceHint() [1/2]

◆ AddOrReplaceHint() [2/2]

◆ AddOrReplaceHints() [1/2]

◆ AddOrReplaceHints() [2/2]

◆ BatchAddBeamHints() [1/2]

◆ BatchAddBeamHints() [2/2]

◆ GetHint()

◆ RemoveAllHints() [1/3]

◆ RemoveAllHints() [2/3]

◆ RemoveAllHints() [3/3]

◆ RemoveHint() [1/2]

◆ RemoveHint() [2/2]

◆ RemoveHints() [1/2]

◆ RemoveHints() [2/2]