ChatService Specification

From MacroDeckDevWiki

This is a draft document. It may change at any time.

ChatService provides the front-end interface for the planned MacroDeck Chat feature. It's designed for use by applications or widgets, and it should not be used for storing conversation data (use ConversationService).

Contents 1 Local Features 2 Remote Features 3 Widget-Specific Features 4 Application-Specific Features 5 Synchronizable Data 6 Interaction With Other Services 7 Technical Data 7.1 UUIDs 7.2 APIs 7.3 Front End

Local Features

• Buddy List (add buddy, delete buddy, etc.)
• Persona management (change your nickname, go away, busy, etc.)
• Send a message
• Poll for message updates (specific to a conversation)

Remote Features

• Buddy List (add buddy, delete buddy, etc.)
• Persona management (change your nickname, go away, busy, etc.)
• Send a message
• Poll for message updates (specific to a conversation)

Widget-Specific Features

• Buddy List (add buddy, delete buddy, etc.)
• Persona management (change your nickname, go away, busy, etc.)
• Send a message
• Poll for message updates (specific to a conversation)

Application-Specific Features

This service is designed for widgets, though it could be used by applications outside of MacroDeck.

Synchronizable Data

• Buddy Lists
• Conversation Data (via ConversationService)

Interaction With Other Services

• UserService will be used for access control
• ConversationService will be used for storing conversations/messages

Technical Data

UUIDs

No UUIDs are currently defined.

APIs

No APIs are currently defined.

Front End

This service's front end will be a widget placed in a special place on the page (the corner). This widget will be present at all times.