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
|
/**
* @brief A block called when a new login succeeded or failed.
*
* @param client If the login succeeded, the newly created client
* @param exception If the login failed, an exception
*/
typedef void (^mtx_client_login_block_t)(MTXClient *_Nullable client,
id _Nullable exception);
/**
* @brief A block called when the response for an operation was received.
*
* @param exception `nil` on success, otherwise an exception
*/
typedef void (^mtx_client_response_block_t)(id _Nullable exception);
/**
* @brief A block called when an exception occurred during sync.
*
* @param exception The exception which occurred during sync
*/
typedef void (^mtx_sync_exception_handler_block_t)(id exception);
/**
* @brief A block called when the room list was fetched.
*
* @param rooms An array of joined rooms, or nil on error
* @param exception An exception if fetching the room list failed
*/
typedef void (^mtx_client_room_list_block_t)(
OFArray<OFString *> *_Nullable rooms, id _Nullable exception);
/**
* @brief A block called when a room was joined.
*
* @param roomID The room ID that was joined, or nil on error. This can be used
* to get the room ID if a room alias was joined.
* @param exception An exception if joining the room failed
*/
typedef void (^mtx_client_room_join_block_t)(OFString *_Nullable roomID,
id _Nullable exception);
/**
* @brief A class that represents a client.
*/
@interface MTXClient: OFObject
/**
|
|
|
|
|
|
|
|
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
|
/**
* @brief A block called when a new login succeeded or failed.
*
* @param client If the login succeeded, the newly created client
* @param exception If the login failed, an exception
*/
typedef void (^MTXClientLoginBlock)(MTXClient *_Nullable client,
id _Nullable exception);
/**
* @brief A block called when the response for an operation was received.
*
* @param exception `nil` on success, otherwise an exception
*/
typedef void (^MTXClientResponseBlock)(id _Nullable exception);
/**
* @brief A block called when an exception occurred during sync.
*
* @param exception The exception which occurred during sync
*/
typedef void (^MTXSyncExceptionHandlerBlock)(id exception);
/**
* @brief A block called when the room list was fetched.
*
* @param rooms An array of joined rooms, or nil on error
* @param exception An exception if fetching the room list failed
*/
typedef void (^MTXClientRoomListBlock)(OFArray<OFString *> *_Nullable rooms,
id _Nullable exception);
/**
* @brief A block called when a room was joined.
*
* @param roomID The room ID that was joined, or nil on error. This can be used
* to get the room ID if a room alias was joined.
* @param exception An exception if joining the room failed
*/
typedef void (^MTXClientRoomJoinBlock)(OFString *_Nullable roomID,
id _Nullable exception);
/**
* @brief A class that represents a client.
*/
@interface MTXClient: OFObject
/**
|
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
@property (readonly, nonatomic) id <MTXStorage> storage;
/**
* @brief The timeout for sync requests.
*
* Defaults to 5 minutes.
*/
@property (nonatomic) of_time_interval_t syncTimeout;
/**
* @brief A block to handle exceptions that occurred during sync.
*/
@property (copy, nonatomic)
mtx_sync_exception_handler_block_t syncExceptionHandler;
/**
* @brief Creates a new client with the specified access token on the specified
* homeserver.
*
* @param userID The user ID for the client
* @param deviceID The device ID for the client
|
|
|
<
|
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
@property (readonly, nonatomic) id <MTXStorage> storage;
/**
* @brief The timeout for sync requests.
*
* Defaults to 5 minutes.
*/
@property (nonatomic) OFTimeInterval syncTimeout;
/**
* @brief A block to handle exceptions that occurred during sync.
*/
@property (copy, nonatomic) MTXSyncExceptionHandlerBlock syncExceptionHandler;
/**
* @brief Creates a new client with the specified access token on the specified
* homeserver.
*
* @param userID The user ID for the client
* @param deviceID The device ID for the client
|
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
* @param storage The storage the client should use
* @param block A block to call once login succeeded or failed
*/
+ (void)logInWithUser: (OFString *)user
password: (OFString *)password
homeserver: (OFURL *)homeserver
storage: (id <MTXStorage>)storage
block: (mtx_client_login_block_t)block;
/**
* @brief Initializes an already allocated client with the specified access
* token on the specified homeserver.
*
* @param userID The user ID for the client
* @param deviceID The device ID for the client
|
|
|
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
* @param storage The storage the client should use
* @param block A block to call once login succeeded or failed
*/
+ (void)logInWithUser: (OFString *)user
password: (OFString *)password
homeserver: (OFURL *)homeserver
storage: (id <MTXStorage>)storage
block: (MTXClientLoginBlock)block;
/**
* @brief Initializes an already allocated client with the specified access
* token on the specified homeserver.
*
* @param userID The user ID for the client
* @param deviceID The device ID for the client
|
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/**
* @brief Logs out the device and invalidates the access token.
*
* @warning The client can no longer be used after this succeeded!
*
* @param block A block to call when logging out succeeded or failed
*/
- (void)logOutWithBlock: (mtx_client_response_block_t)block;
/**
* @brief Fetches the list of joined rooms.
*
* @param block A block to call with the list of joined room
*/
- (void)fetchRoomListWithBlock: (mtx_client_room_list_block_t)block;
/**
* @brief Joins the specified room.
*
* @param room The room to join. Either a room ID or a room alias.
* @param block A block to call when the room was joined
*/
- (void)joinRoom: (OFString *)room
block: (mtx_client_room_join_block_t)block;
/**
* @brief Leaves the specified room.
*
* @param roomID The room ID to leave
* @param block A block to call when the room was left
*/
- (void)leaveRoom: (OFString *)roomID
block: (mtx_client_response_block_t)block;
/**
* @brief Sends the specified message to the specified room ID.
*
* @param message The message to send
* @param roomID The room ID to which to send the message
* @param block A block to call when the message was sent
*/
- (void)sendMessage: (OFString *)message
roomID: (OFString *)roomID
block: (mtx_client_response_block_t)block;
@end
OF_ASSUME_NONNULL_END
|
|
|
|
<
|
<
|
|
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
/**
* @brief Logs out the device and invalidates the access token.
*
* @warning The client can no longer be used after this succeeded!
*
* @param block A block to call when logging out succeeded or failed
*/
- (void)logOutWithBlock: (MTXClientResponseBlock)block;
/**
* @brief Fetches the list of joined rooms.
*
* @param block A block to call with the list of joined room
*/
- (void)fetchRoomListWithBlock: (MTXClientRoomListBlock)block;
/**
* @brief Joins the specified room.
*
* @param room The room to join. Either a room ID or a room alias.
* @param block A block to call when the room was joined
*/
- (void)joinRoom: (OFString *)room block: (MTXClientRoomJoinBlock)block;
/**
* @brief Leaves the specified room.
*
* @param roomID The room ID to leave
* @param block A block to call when the room was left
*/
- (void)leaveRoom: (OFString *)roomID block: (MTXClientResponseBlock)block;
/**
* @brief Sends the specified message to the specified room ID.
*
* @param message The message to send
* @param roomID The room ID to which to send the message
* @param block A block to call when the message was sent
*/
- (void)sendMessage: (OFString *)message
roomID: (OFString *)roomID
block: (MTXClientResponseBlock)block;
@end
OF_ASSUME_NONNULL_END
|