Mirrors/chatmail-core
1
0
Fork 0
mirror of https://github.com/chatmail/core.git synced 2026-05-02 21:06:31 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: add more get_next_event docs

Browse Source
This commit is contained in:
WofWca
2025-09-17 09:37:17 +04:00
committed by l
parent 40b866117e
commit bf3dfa4ab6
1 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
deltachat-jsonrpc/src/api.rs
View File

@@ -91,7 +91,8 @@ pub struct CommandApi {
/// Receiver side of the event channel. /// Receiver side of the event channel.
/// ///
/// Events from it can be received by calling `get_next_event` method. /// Events from it can be received by calling
/// [`CommandApi::get_next_event`] method.
event_emitter: Arc<EventEmitter>, event_emitter: Arc<EventEmitter>,
states: Arc<Mutex<BTreeMap<u32, AccountState>>>, states: Arc<Mutex<BTreeMap<u32, AccountState>>>,
@@ -173,7 +174,15 @@ impl CommandApi {
get_info() get_info()
} }
/// Get the next event. /// Get the next event, and remove it from the event queue.
///
/// If no events have happened since the last `get_next_event`
/// (i.e. if the event queue is empty), the response will be returned
/// only when a new event fires.
///
/// Note that if you are using the `BaseDeltaChat` JavaScript class
/// or the `Rpc` Python class, this function will be invoked
/// by those classes internally and should not be used manually.
async fn get_next_event(&self) -> Result<Event> { async fn get_next_event(&self) -> Result<Event> {
self.event_emitter self.event_emitter
.recv() .recv()