Beamable.Common.Assistant.BeamHintIds Class Reference

BeamHint ids are unique identifiers that translates to a single displayed hint and for which notifications are tracked. There are 3 primary ways of thinking about ids:

• Identify several instances of the same problem and display all of them in a single consistent hint (see BeamHintDomains.BEAM_CSHARP_MICROSERVICES_CODE_MISUSE, or any other Code Misuse, as examples).
• Identify a single hint/tip that may be interesting to communicate and create a hint Id for it.
• Embed a content/player or some other unique identifier into the id to guarantee uniqueness and display relevant data. Be careful with this approach as it can easily flood the Assistant window making it less useful.

Ids cannot have "¬" or "₢" they are reserved characters (see BeamHintDomains.SUB_DOMAIN_SEPARATOR, BeamHintHeader.AS_KEY_SEPARATOR and BeamHintSharedConstants.BEAM_HINT_PREFERENCES_SEPARATOR). Use GenerateHintId to ensure the immutable part of the hint's id is valid when declaring it. Use AppendHintIdParams methods to ensure you are respecting the Id creation rules and you are embedding parameters into the id (for cases like the third item in the bullet point list). More...

Inheritance diagram for Beamable.Common.Assistant.BeamHintIds:

Collaboration diagram for Beamable.Common.Assistant.BeamHintIds:

Static Public Member Functions
static string	GenerateHintId (string id, string prefix=null)
	Generates a given id . Asserts it is a valid id as per system assumptions.
static string	AppendHintIdParams (string id, string separator="_", params object[] appendedParams)
	Given a hint generated with GenerateHintId, appends – split by the given separator – the given list of parameters (calling object.ToString to generate them).

Static Public Attributes
const string	ATTRIBUTE_VALIDATION_ID_PREFIX = "AttributeValidation"
	Prefix added to all hints whose context objects are known to be lists of Reflection.AttributeValidationResult.
const string	ATTRIBUTE_NAME_COLLISION_ID_PREFIX = "AttributeNameCollision"
	Prefix added to all hints whose context objects are known to be lists of Reflection.UniqueNameCollisionData.
static readonly string	ID_UNSUPPORTED_REGISTER_BEAMABLE_DEPENDENCY_SIGNATURE = GenerateHintId("UnsupportedRegisterBeamableDependencySignature", ATTRIBUTE_VALIDATION_ID_PREFIX)
static readonly string	ID_MISCONFIGURED_HINT_DETAILS_PROVIDER = GenerateHintId("MisconfiguredHintDetailsProvider", ATTRIBUTE_VALIDATION_ID_PREFIX)
static readonly string	ID_MISCONFIGURED_HINT_SYSTEM_ATTRIBUTE = GenerateHintId("MisconfiguredHintSystemAttribute", ATTRIBUTE_VALIDATION_ID_PREFIX)
static readonly string	ID_MICROSERVICE_ATTRIBUTE_MISSING = GenerateHintId("MicroserviceAttributeMissing", ATTRIBUTE_VALIDATION_ID_PREFIX)
static readonly string	ID_MICROSERVICE_NAME_COLLISION = GenerateHintId("MicroserviceNameCollision", ATTRIBUTE_NAME_COLLISION_ID_PREFIX)
static readonly string	ID_STORAGE_OBJECT_ATTRIBUTE_MISSING = GenerateHintId("StorageObjectAttributeMissing", ATTRIBUTE_VALIDATION_ID_PREFIX)
static readonly string	ID_STORAGE_OBJECT_NAME_COLLISION = GenerateHintId("StorageObjectNameCollision", ATTRIBUTE_NAME_COLLISION_ID_PREFIX)
static readonly string	ID_CLIENT_CALLABLE_ASYNC_VOID = GenerateHintId("ClientCallableAsyncVoid", ATTRIBUTE_VALIDATION_ID_PREFIX)
static readonly string	ID_CLIENT_CALLABLE_UNSUPPORTED_PARAMETERS = GenerateHintId("ClientCallableUnsupportedParameters", ATTRIBUTE_VALIDATION_ID_PREFIX)
static readonly string	ID_INSTALL_DOCKER_PROCESS = GenerateHintId("InstallDockerProcess")
static readonly string	ID_DOCKER_PROCESS_NOT_RUNNING = GenerateHintId("DockerProcessNotRunning")
static readonly string	ID_DOCKER_OVERLAPPING_PORTS = GenerateHintId("DockerOverlappingPorts")
static readonly string	ID_CHANGES_NOT_DEPLOYED_TO_LOCAL_DOCKER = GenerateHintId("ChangesNotDeployedToLocalDocker")

Detailed Description

BeamHint ids are unique identifiers that translates to a single displayed hint and for which notifications are tracked.

There are 3 primary ways of thinking about ids:

• Identify several instances of the same problem and display all of them in a single consistent hint (see BeamHintDomains.BEAM_CSHARP_MICROSERVICES_CODE_MISUSE, or any other Code Misuse, as examples).
• Identify a single hint/tip that may be interesting to communicate and create a hint Id for it.
• Embed a content/player or some other unique identifier into the id to guarantee uniqueness and display relevant data. Be careful with this approach as it can easily flood the Assistant window making it less useful.

Ids cannot have "¬" or "₢" they are reserved characters (see BeamHintDomains.SUB_DOMAIN_SEPARATOR, BeamHintHeader.AS_KEY_SEPARATOR and BeamHintSharedConstants.BEAM_HINT_PREFERENCES_SEPARATOR).

Use GenerateHintId to ensure the immutable part of the hint's id is valid when declaring it.

Use AppendHintIdParams methods to ensure you are respecting the Id creation rules and you are embedding parameters into the id (for cases like the third item in the bullet point list).

---

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

• com.beamable/Common/Runtime/BeamHints/BeamHintIds.cs