other-events.md

Index

• Retrieve Messages
• Delete Messages
• Retrieve DID
• Delete Contact
• Register Contact

Retrieve Messages

The retrieval of messages has the following calls:

1. Initial Sync (or Cache Miss Detection and Full Sync)
2. Periodic Retrieve (Incremental Sync)
3. User Scrolls Up - Polling (On-Demand Fetching for Older Messages)

Messages on the frontend will have a pile structure based on dates. Meaning, the frontend will keep the latest messages and will drop older ones. Call number 1 will populate this pile. This call will be called when the app is initialized or if errors are detected. Imagine this pile populates the messages view of a messaging app.

Call number 2 will bring new messages to the previously mentioned pile.

Call number 3 will bring a paginated set of messages for older conversations. The user will select a specific conversation and this call will be triggered to request older messages.

This approach aims to reduce the calls load yet providing a consistent and lightweight approach to handle messages communication between the FE and BE.

The pile will have a specific configurable cache size criteria based on amount of messages and dates (e.g., the last N messages, messages within the past X days, etc.).

Initial Sync (or Cache Miss Detection and Full Sync)

Example input:

RetrieveMessagesInitial();

Example response:

{
  "status": "success",
  "payload": [
    {
      "did": "did:peer(..)",
      "contact": "Alice",
      "message": {"Hey Peter, bring bread."},
      "id": 3,
      "timestamp": "2024-11-19T23:50:00Z"
    },
    {
      "did": "did:peer(..)",
      "contact": "Bob",
      "message": {"Hey Bob, bring butter."},
      "id": 2,
      "timestamp": "2024-11-19T23:50:00Z"
    },
    {
      "did": "did:peer(..)",
      "contact": "Hugo",
      "message": {"Hey Jan, bring Salt."},
      "id": 1,
      "timestamp": "2024-11-19T23:50:00Z"
    }
  ]
}

Event channel name:

RetrieveMessagesInitial

Periodic Retrieve (Incremental Sync)

This event will retrieve new messages that recently came from the mediator.

Example input:

RetrieveMessagesPeriodic((date = '2024-11-20T00:00:00Z'));

Example response:

{
  "status": "success",
  "payload": [
    {
      "did": "did:peer(..)",
      "contact": "Alice",
      "message": {"Hey Peter, bring bread."},
      "id": 3,
      "timestamp": "2024-11-19T23:50:00Z"
    },
    {
      "did": "did:peer(..)",
      "contact": "Bob",
      "message": {"Hey Bob, bring butter."},
      "id": 2,
      "timestamp": "2024-11-19T23:50:00Z"
    },
    {
      "did": "did:peer(..)",
      "contact": "Hugo",
      "message": {"Hey Jan, bring Salt."},
      "id": 1,
      "timestamp": "2024-11-19T23:50:00Z"
    }
  ]
}

{
  "status": "error",
  "error": "No messages to retrieve"
}

Event channel name:

RetrieveMessagesPeriodic

User Scrolls Up - Polling (On-Demand Fetching for Older Messages)

This event will retrieve old messages under user demand.

Example input:

RetrieveMessagesPaginated(
  (did = 'did:peer:12345'),
  (date = '2024-11-20T00:00:00Z'),
  (pollSize = 50),
);

Example response:

{
  "status": "success",
  "payload": [
    {
      "did": "did:peer:12345",
      "contact": "Alice",
      "message": "Do you need anything else?",
      "id": 45,
      "timestamp": "2024-11-19T23:55:00Z"
    },
    {
      "did": "did:peer:12345",
      "contact": "Alice",
      "message": "Don’t forget the bread!",
      "id": 44,
      "timestamp": "2024-11-19T23:50:00Z"
    }
  ]
}

{
  "status": "error",
  "error": "Conversation not found"
}

Event channel name:

RetrieveMessagesPaginated

Delete Messages

This event will delete specific messages.

Example input:

DeleteMessages(messageId);
DeleteMessages(3);

Example response:

{
  "status": "false",
  "message": "Error, format not valid"
}

{
  "status": "true",
  "message": "Success"
}

Event channel name:

DeleteMessages

Retrieve DIDWithMediator

This event will retrieve the DID where the mediator will receive messages for the user.

Example input:

RetrieveDIDWithMediator();

Example response:

{
  "did_for_mediation": "did:peer:2.Ez6LSiopL5aJjRbTu8ZB8uinhodhP7GiSix9DFG5rr2Xp93mg.Vz6MkrnJCtTmSuhoVXUSS8CxZkesWuwHaeHbyp7NT3Z3c9ZoA",
  "status": "true",
  "message": "Success"
}

{
  "status": "false",
  "message": "error"
}

Event channel name:

RetrieveDIDWithMediator

Delete Contact

This event will delete a registered contact.

Example input:

DeleteContact(
  'did:peer:2.Ez6LSiopL5aJjRbTu8ZB8uinhodhP7GiSix9DFG5rr2Xp93mg.Vz6MkrnJCtTmSuhoVXUSS8CxZkesWuwHaeHbyp7NT3Z3c9ZoA',
);

Example response:

{
  "status": "true",
  "message": "Success"
}

{
  "status": "false",
  "message": "error"
}

Event channel name:

DeleteContact

Register contact

This event will add a new contact.

Example input:

AddContact(
  'did:peer:2.Ez6LSiopL5aJjRbTu8ZB8uinhodhP7GiSix9DFG5rr2Xp93mg.Vz6MkrnJCtTmSuhoVXUSS8CxZkesWuwHaeHbyp7NT3Z3c9ZoA',
);

Example response:

{
  "status": "true",
  "message": "Success"
}

{
  "status": "false",
  "message": "error"
}

Event channel name:

AddContact