Class AgentHiveChatPreferencesService

Service to handle Chat Preferences API calls on Agent Hive

Hierarchy

AgentHiveChatPreferencesService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AgentHiveChatPreferencesService(): AgentHiveChatPreferencesService

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-chat-preferences-service.ts:32
example
```
const agentHivePrefSvc = new AgentHiveChatPreferencesService();
```
Returns AgentHiveChatPreferencesService

Properties

Private auth

auth: CXoneAuth

Private baseUrl

baseUrl: string = ''

logger

logger: CcfLogger = ...

Protected utilService

utilService: HttpUtilService = ...

Methods

getChatPreferences

getChatPreferences(): Promise<AssertsShape<{ createdAt: default<string, AnyObject, string>; preferences: OptionalObjectSchema<{ notificationMuted: default<boolean, AnyObject, boolean> }, AnyObject, TypeOfShape<{ notificationMuted: default<boolean, AnyObject, boolean> }>>; updatedAt: default<string, AnyObject, string>; userId: default<string, AnyObject, string> }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-chat-preferences-service.ts:44
Method to get the current chat notification preferences for the authenticated user
example
```
getChatPreferences();
```
Returns Promise<AssertsShape<{ createdAt: default<string, AnyObject, string>; preferences: OptionalObjectSchema<{ notificationMuted: default<boolean, AnyObject, boolean> }, AnyObject, TypeOfShape<{ notificationMuted: default<boolean, AnyObject, boolean> }>>; updatedAt: default<string, AnyObject, string>; userId: default<string, AnyObject, string> }>>

updateChatPreferences

updateChatPreferences(preferencesRequest: AgentHiveChatPreferencesRequest): Promise<AssertsShape<{ createdAt: default<string, AnyObject, string>; preferences: OptionalObjectSchema<{ notificationMuted: default<boolean, AnyObject, boolean> }, AnyObject, TypeOfShape<{ notificationMuted: default<boolean, AnyObject, boolean> }>>; updatedAt: default<string, AnyObject, string>; userId: default<string, AnyObject, string> }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-chat-preferences-service.ts:81
Method to update the chat notification preferences for the authenticated user
example
```
updateChatPreferences({ preferences: { notificationMuted: true } });
```
Parameters
- preferencesRequest: AgentHiveChatPreferencesRequest
  
  object containing the preferences to update
Returns Promise<AssertsShape<{ createdAt: default<string, AnyObject, string>; preferences: OptionalObjectSchema<{ notificationMuted: default<boolean, AnyObject, boolean> }, AnyObject, TypeOfShape<{ notificationMuted: default<boolean, AnyObject, boolean> }>>; updatedAt: default<string, AnyObject, string>; userId: default<string, AnyObject, string> }>>

Generated using TypeDoc