#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Member Functions
void	clear ()

virtual void	initForDocumenting ()

Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase
virtual std::string	toString ()

virtual bool	isDocumenting () const

Public Attributes
std::string	nodeId
	[Optional, Default: Auto Generated] This is the Node ID to use to represent instance on the network.

std::string	userId
	[Optional, Default: empty string] The user ID to be used to represent the user.

std::string	displayName
	[Optional, Default: empty string] The display name to be used for the user.

std::string	avatar
	[Optional, Default: empty string] This is a application defined field used to indicate a users avatar. The Engine doesn't not process this data and is a pass through.

Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json	_attached

Additional Inherited Members
Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool	_documenting

Detailed Description

Users Identity.

Helper C++ class to serialize and de-serialize Identity JSON

This configuration will be used by the Engine when transmitting presence data on behalf of the application.

Example JSON:

{
   "avatar": "",
   "displayName": "",
   "nodeId": "",
   "userId": ""
}

See also: engageInitialize, PresenceDescriptor

Definition at line 1501 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ Identity()

AppConfigurationObjects::Identity::Identity ( )

inline

Definition at line 1525 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::Identity::clear ( )

inline

Definition at line 1530 of file ConfigurationObjects.h.

◆ initForDocumenting()

virtual void AppConfigurationObjects::Identity::initForDocumenting ( )

inlinevirtual

Reimplemented from AppConfigurationObjects::ConfigurationObjectBase.

Definition at line 1538 of file ConfigurationObjects.h.

Member Data Documentation

◆ avatar

std::string AppConfigurationObjects::Identity::avatar

[Optional, Default: empty string] This is a application defined field used to indicate a users avatar. The Engine doesn't not process this data and is a pass through.

Definition at line 1523 of file ConfigurationObjects.h.

◆ displayName

std::string AppConfigurationObjects::Identity::displayName

[Optional, Default: empty string] The display name to be used for the user.

Definition at line 1520 of file ConfigurationObjects.h.

◆ nodeId

std::string AppConfigurationObjects::Identity::nodeId

[Optional, Default: Auto Generated] This is the Node ID to use to represent instance on the network.

The application can generate and persist this Id or if an Id is not provided, the Engage Engine will generate a random Id and will be advertised in the PresenceDescriptor JSON with the self attribute set to true in the PFN_ENGAGE_GROUP_NODE_DISCOVERED event

See also: PresenceDescriptor.

Definition at line 1514 of file ConfigurationObjects.h.

◆ userId

std::string AppConfigurationObjects::Identity::userId

[Optional, Default: empty string] The user ID to be used to represent the user.

Definition at line 1517 of file ConfigurationObjects.h.

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

c/include/ConfigurationObjects.h

Public Member Functions

Public Attributes

Additional Inherited Members