Class AgentHiveClient

This is the base class for Agent Hive

Hierarchy

AgentHiveClient

Index

Constructors

constructor

Properties

Accessors

instance

Methods

Constructors

constructor

new AgentHiveClient(): AgentHiveClient

- Defined in user-chat-sdk/src/lib/agent-hive-client.ts:32
get instance for agent auth and session
example
```
const cxoneAgentHiveClient = new CXoneAgentHiveClient();
```
Returns AgentHiveClient

Properties

agentHiveChatPreferencesService

agentHiveChatPreferencesService: AgentHiveChatPreferencesService = ...

agentHiveFavoritesService

agentHiveFavoritesService: AgentHiveFavoritesService = ...

agentHiveGroupsService

agentHiveGroupsService: AgentHiveGroupsService = ...

agentHiveOutboundMessageService

agentHiveOutboundMessageService: AgentHiveOutboundMessageService = ...

agentHiveUsersService

agentHiveUsersService: AgentHiveUsersService = ...

auth

auth: CXoneAuth = ...

cxoneTenant

cxoneTenant: CXoneTenant = ...

cxoneUser

cxoneUser: CXoneUser = ...

Private logger

logger: Logger = ...

Static Private singleton

singleton: AgentHiveClient

Accessors

Static instance

get instance(): AgentHiveClient

- Defined in user-chat-sdk/src/lib/agent-hive-client.ts:44
Method to create singleton object of the class
```
@example
const AgentHiveClient = AgentHiveClient.instance();
```
Returns AgentHiveClient

Methods

freshStandaloneLogin

freshStandaloneLogin(): Promise<void>

- Defined in user-chat-sdk/src/lib/agent-hive-client.ts:132
Method to start fresh login everytime
example
- this.freshStandaloneLogin();
Returns Promise<void>

initAgentHiveDigitalEngagement

initAgentHiveDigitalEngagement(): void

- Defined in user-chat-sdk/src/lib/agent-hive-client.ts:58
method to initialize AgentHiveDigitalEngagement
example
```
initAgentHiveDigitalEngagement();
```
Returns void

isConversationsProductEnabledFromTM

isConversationsProductEnabledFromTM(): Promise<boolean>

- Defined in user-chat-sdk/src/lib/agent-hive-client.ts:109
method to check if Conversations product is enabled from tenant management
example
```
isConversationsProductEnabledFromTM();
```
Returns Promise<boolean>

Generated using TypeDoc