1
- [ ![ Quality Gate] ( https://sonarcloud.io/api/project_badges/measure?project=matrix.android.sdk&metric=alert_status )] ( https://sonarcloud.io/dashboard?id=matrix.android.sdk ) [ ![ Vulnerabilities] ( https://sonarcloud.io/api/project_badges/measure?project=matrix.android.sdk&metric=vulnerabilities )] ( https://sonarcloud.io/dashboard?id=matrix.android.sdk ) [ ![ Bugs] ( https://sonarcloud.io/api/project_badges/measure?project=matrix.android.sdk&metric=bugs )] ( https://sonarcloud.io/dashboard?id=matrix.android.sdk )
1
+ [ ![ Jenkins] ( https://img.shields.io/jenkins/s/https/matrix.org/jenkins/view/MatrixView/job/MatrixAndroidSDKDevelop.svg )] ( https://matrix.org/jenkins/view/MatrixView/job/MatrixAndroidSDKDevelop/ )
2
+ [ ![ Quality Gate] ( https://sonarcloud.io/api/project_badges/measure?project=matrix.android.sdk&metric=alert_status )] ( https://sonarcloud.io/dashboard?id=matrix.android.sdk )
3
+ [ ![ Vulnerabilities] ( https://sonarcloud.io/api/project_badges/measure?project=matrix.android.sdk&metric=vulnerabilities )] ( https://sonarcloud.io/project/issues?id=matrix.android.sdk&resolved=false&types=VULNERABILITY )
4
+ [ ![ Bugs] ( https://sonarcloud.io/api/project_badges/measure?project=matrix.android.sdk&metric=bugs )] ( https://sonarcloud.io/project/issues?id=matrix.android.sdk&resolved=false&types=BUG )
2
5
3
6
matrix-android-sdk
4
7
==================
@@ -19,20 +22,14 @@ Basic usage is:
19
22
20
23
Bugs / Feature Requests
21
24
-----------------------
22
- Think you've found a bug? Want a new feature on the client? Please open an issue
23
- on JIRA:
24
-
25
- - Create an account and login to https://matrix.org/jira
26
- - Navigate to the `` SYAND `` project.
27
- - Click ** Create Issue** - Please be as descriptive as possible, with reproduction
28
- steps if possible.
29
-
30
- All issues in JIRA are ** public** .
25
+ Think you've found a bug? Please check if an issue
26
+ does not exist yet, then, if not, open an issue on this Github repo. If an issue already
27
+ exists, feel free to upvote for it.
31
28
32
29
Contributing
33
30
------------
34
- Want to fix a bug or add a new feature? Check JIRA first to see if someone else is
35
- handling this issue. If no one is actively working on the issue, then please fork
31
+ Want to fix a bug or add a new feature? Check if there is an corresponding opened issue.
32
+ If no one is actively working on the issue, then please fork
36
33
the `` develop `` branch when writing your fix, and open a pull request when you're
37
34
ready. Do not base your pull requests off `` master `` .
38
35
@@ -41,7 +38,9 @@ Logging in
41
38
To log in, use an instance of the login API client.
42
39
43
40
``` java
44
- HomeServerConnectionConfig hsConfig = new HomeServerConnectionConfig (Uri . parse(" https://matrix.org" ));
41
+ HomeServerConnectionConfig hsConfig = new HomeServerConnectionConfig .Builder ()
42
+ .withHomeServerUri(Uri . parse(" https://matrix.org" ))
43
+ .build();
45
44
new LoginRestClient (hsConfig). loginWithUser(username, password, new SimpleApiCallback<Credentials > ());
46
45
```
47
46
@@ -52,7 +51,8 @@ Starting the matrix session
52
51
The session represents one user's session with a particular home server. There can potentially be multiple sessions for handling multiple accounts.
53
52
54
53
``` java
55
- MXSession session = new MXSession (hsConfig, new MXDataHandler (store, credentials), getApplicationContext());
54
+ MXSession session = new MXSession .Builder (hsConfig, new MXDataHandler (store, credentials), getApplicationContext())
55
+ .build();
56
56
```
57
57
58
58
sets up a session for interacting with the home server.
@@ -109,18 +109,6 @@ MXDataHandler dataHandler = new MXDataHandler(new MXMemoryStore());
109
109
110
110
creates a data handler with the default in-memory storage implementation.
111
111
112
- ### Setting up the session
113
-
114
- ``` java
115
- MXSession session = new MXSession (credentials, dataHandler);
116
- ```
117
-
118
- ### Starting the event stream
119
-
120
- ``` java
121
- session. startEventStream();
122
- ```
123
-
124
112
### Registering a listener
125
113
To be informed of events, the app needs to implement an event listener.
126
114
@@ -217,9 +205,13 @@ content can now be found.
217
205
218
206
** See the sample app and Javadoc for more details.**
219
207
208
+ References
209
+ ----------
210
+ - [ Matrix home page] ( https://matrix.org )
211
+ - [ Matrix api documentation] ( https://matrix.org/docs/spec/client_server/latest.html )
212
+ - [ Matrix api] ( https://matrix.org/docs/api/client-server/ )
213
+
220
214
License
221
215
-------
222
216
Apache 2.0
223
217
224
- [ Matrix ] :http://matrix.org
225
- [ matrix api ] :http://matrix.org/docs/api/client-server/
0 commit comments