26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
-
+
-
+
-
+
-
-
+
-
-
+
-
|
/**
* @brief A block which will be treated as a single transaction for the storage.
*
* @return Whether the transaction should be committed (`true`) or rolled back
* (`false`).
*/
typedef bool (^mtx_storage_transaction_block_t)(void);
typedef bool (^MTXStorageTransactionBlock)(void);
/**
* @brief A protocol for a storage to be used by @ref MTXClient.
*/
@protocol MTXStorage <OFObject>
/**
* @brief Performs all operations inside the block as a transaction.
*/
- (void)transactionWithBlock: (mtx_storage_transaction_block_t)block;
- (void)transactionWithBlock: (MTXStorageTransactionBlock)block;
/**
* @brief Stores the next batch for the specified device.
*
* @param nextBatch The next batch for the device
* @param deviceID The device for which to store the next batch
*/
- (void)setNextBatch: (OFString *)nextBatch
- (void)setNextBatch: (OFString *)nextBatch forDeviceID: (OFString *)deviceID;
forDeviceID: (OFString *)deviceID;
/**
* @brief Returns the next batch for the specified device.
*
* @param deviceID The device ID for which to return the next batch
* @return The next batch for the specified device, or `nil` if none is
* available.
*/
- (nullable OFString *)nextBatchForDeviceID: (OFString *)deviceID;
/**
* @brief Adds the specified room ID to the list of joined rooms for the
* specified user ID.
*
* @param roomID The room ID to add to the list of joined rooms
* @param userID The user ID for which to add the room
*/
- (void)addJoinedRoom: (OFString *)roomID
- (void)addJoinedRoom: (OFString *)roomID forUser: (OFString *)userID;
forUser: (OFString *)userID;
/**
* @brief Removes the specified room ID to the list of joined rooms for the
* specified user ID.
*
* @param roomID The room ID to add to the list of joined rooms
* @param userID The user ID for which to add the room
*/
- (void)removeJoinedRoom: (OFString *)roomID
- (void)removeJoinedRoom: (OFString *)roomID forUser: (OFString *)userID;
forUser: (OFString *)userID;
/**
* @brief Returns the joined room IDs for the specified user ID.
*
* @param userID The user ID for which to return the joined rooms
* @return The joined room IDs for the specified user ID
*/
- (OFArray<OFString *> *)joinedRoomsForUser: (OFString *)userID;
@end
OF_ASSUME_NONNULL_END
|