kamax-matrix / matrix-java-sdk Goto Github PK

• Adapt Matrix ID class
• Adapt tests
• URL-encode properly

I need support for m.receipt next:
https://matrix.org/docs/spec/client_server/r0.3.0.html#id57

The method getJoinedUsers in the class MatrixHttpRoom currenly only returns a MatrixID. The response also contains the avatar's url and the display name. These two strings should be somehow accessible to the caller, too.

I need to be able to set the device name during login to resolve https://github.com/MrCustomizer/palaver/issues/46.

I think it's the parameter initial_device_display_name, which probably has to be added to the MatrixClientContext.

The spec allows the access token to be provided in headers or in query parameter.
We need to support both and leave the option of which to use at the client object creation time.
Headers will be the default option.

please publish it somewhere :)

This is a list of event Types that I currently manually need to match as they don't get parsed to a java type.

• m.direct
• m.tag
• m.room.canonical_alias

https://github.com/kamax-io/matrix-java-sdk/blob/9f8fa1de7f0069b2457b5c517ca28998b25bf692/src/main/java/io/kamax/matrix/client/regular/MatrixHttpClient.java#L116

Currently it's not possible to query the contents of an event with an image via the API. Image events have next to the body an info JSON-object which contains the necessary information like mimetype information, the mxc-URL of the image etc. It would be nice to be able to query this stuff via the API instead of having to parse the JSON-info object itself.

Room message events can contain formatted text. Several clients also seem to more or less use this feature. Especially Riot makes excessive use of it. I stumbled upon it when learning about the mechanisms of how Riot handles mentions. Mention pills are html link tags, where href follows a certain formatting standard.

Several other html tags for formatting text are also supported.

Long story short: MatrixJsonRoomMessageEvent should be extended, so that clients are able to access the formatted text body sent by other clients instead of only the raw text body. I propose adding the methods getFormattedBody and getFormat to access the JSON fields formatted_body and format in the content object of the event.

I suggest adding a new event which implements MatrixJsonEvent with the name MatrixJsonRoomTopicEvent. This event should be a represantation of a timeline event of a room with the type m.room.topic.

As part of the initial implementation, be able to receive core events from the HS for a very basic usage, in the lines of a bot client which would act on messages from regular users and can navigate rooms.

List events to support:

• Rooms
  • Invite
  • Join
  • Leave/kick/ban
• Messages
  • Incoming basic text messages

• Initial global sync
• Initial per-room sync
• Room peek

One of the state events returned when calling sync is the event which contains a room's topic. It would be nice if the SDK's interface could be expanded to query these topics.

https://matrix.to/#/!njlAtOfBXEoOokPxeW:matrix.ffslfl.net/$1540672301485SgUKO:matrix.ffslfl.net

The object JoinedRoom in SyncData needs a new object to read the unread notifications and highlights. Relevant part of the spec: https://matrix.org/docs/spec/client_server/r0.3.0.html#get-matrix-client-r0-sync

HttpRequests need three timeouts to be set, so that the requests automatically return on a bad connection. The default for these timeouts sadly is "infinity". The timeouts can be set like this:

int timeout = <suitableTimeout>
RequestConfig.Builder configBuilder = request.getConfig().custom();
if (request.getConfig() != null) {
    configBuilder = RequestConfig.copy(request.getConfig());
}
configBuilder.setConnectionRequestTimeout(timeout);
configBuilder.setConnectTimeout(timeout);
configBuilder.setSocketTimeout(timeout);
httpRequest.setConfig(configBuilder.build());

Androids new D8 Dex merger does complain if building the sdk sometimes :/

Error I get is:

AGPBI: {"kind":"error","text":"Default interface methods are only supported starting with Android N (--min-api 24): void io.kamax.matrix.hs._MatrixRoom.sendReadReceipt(java.lang.String)","sources":[{}],"tool":"D8"}

MatrixJsonRoomMembershipEvent has to be extended, so that it is possible to query the membership parameter of the JSON object. According to the spec it can contain the following values: "invite", "join", "knock", "leave" and "ban".

I would like to be able to query a room's avatar. The SDK has to support the endpoint m.room.avatar for that.

https://matrix.org/speculator/spec/HEAD/client_server/unstable.html#id49

Exception message is: Unable to invoke no-args constructor for interface io.kamax.matrix._MatrixID. Registering an InstanceCreator with Gson for this type may fix this problem.

Related to https://sentry.io/share/issue/83ef2528d719440fac33341327d36002/

The MatrixErrorInfo class should make the server response Json object accessible (if available).

For example, when encountering an error because of rate-limiting, the response informs the client, when it may retry. This information is necessary for well behaving clients.
See https://matrix.org/docs/spec/client_server/r0.4.0.html#rate-limiting

_SyncData contains the types InvitedRoom, JoinedRoom and LeftRoom. Currently they don't have a generalized type. This leads to code duplication and in some cases triplication.

All three types contain synchronisation data for a specific room. Common properties are the room ID #getId() and the state events #getState().

A generalized type RoomData (or some other name) could be

interface RoomData {
   String getId(); // room ID
   State getState(); // state events
}

For better distinction between the RoomData subtypes add a RoomDataKind enum

enum RoomDataKind {
  JOINED,
  INVITED,
  LEFT
  ;
}
interface RoomData {
  …
  RoomDataKind getKind();
}

There is currently no official way in the spec to discover the client endpoint for a given Matrix domain, which would be the equivalent of the SRV record for the S2S API.

Following several conversations and exchanges [1] [2], we'll use a .well-known URL [RFC 5785].

For the domain example.org, the discovery URL will be: https://example.org/.well-known/matrix
It will return a status code 200 and body as JSON object like so:

{
  "m.hs": {
    "base_urls": [
      "https://a.mxhsd.example.org",
      "https://b.mxhsd.example.org",
      "https://c.mxhsd.example.org/with/prefix/path",
      "https://d.mxhsd.example.org:12345"
    ]
  },
  "m.is": {
    "base_urls": [
      "https://a.mxisd.example.org",
      "https://b.mxisd.example.org",
      "https://c.mxisd.example.org/with/prefix/path",
      "https://d.mxisd.example.org:12345"
    ]
  },
  "im.vector.riot.integrations": {
    "ui_url": "https://dimension.example.org/riot",
    "rest_url": "https://dimension.example.org/api/v1/scalar",
    "widgets_urls": [
      "https://dimension.example.org/widgets"
    ]
  }
}

For base_urls in m.hs and m.is:

• Will not include the /_matrix/... path.
• Will be tried in order, going to the next in case of error.
• A Base URL is valid if:
  • For m.hs, /_matrix/client/versions is reachable and contains valid data
  • For m.is, /_matrix/identity/versions is reachable and contains valid data

Every other entry will be DNS namespace, like other parts of the Matrix protocol, so custom features in clients can also receive dedicated configuration, or rely on other other clients supported configuration.
In this case, im.vector.riot.integrations would reference to the Riot Integration Manager and any other client that supports it.

/_matrix/identity/versions will be defined at https://kamax.io/matrix/api/identity_service/unstable.html

This implementation will be documented at https://kamax.io/matrix/api/client_server/unstable.html

Some event types are missing:

• m.room.guest_access
• m.room.join_rules
• m.room.redaction

Add support for setting the user avatar image.
See https://matrix.org/docs/spec/client_server/r0.4.0.html#put-matrix-client-r0-profile-userid-avatar-url

There is a currently a method defined for uploading files and specifying the content-type:
MatrixHttpClient.putMedia(File data, String type).

There should be an additional method which accepts a filename parameter:
MatrixHttpClient.putMedia(File data, String type, String filename)

The specification defines the URL query parameter filename.
See https://matrix.org/docs/spec/client_server/r0.4.0.html#post-matrix-media-r0-upload

The m.room.message with message type m.image specifies only the name that is displayed. However when downloading a file, the matrix client gets a random filename such as AgTxPeyqwuCUpoyPjAgBcVxH.png

Full Stacktrace: https://sentry.io/share/issue/80ab39b6f90b43d79a5828e179c77b87/

This happened on login in SimpleMatrix with Android 6.0.1

Describe how to perform basic actions with the SDK:

• Login with password
• List joined rooms
• Join room
• Leave room
• Send message to room
• Handle events
  • Incoming message from room