diff options
| author | Matias Linares <matias@deprecated.org> | 2018-06-05 23:52:07 -0300 |
|---|---|---|
| committer | Matias Linares <matias@deprecated.org> | 2018-06-05 23:52:07 -0300 |
| commit | b108bfae64edb309ec0553e928b973c9f3e0f8e9 (patch) | |
| tree | 72c336947a7a44818f073591a67d6504bd76476c | |
| parent | 539171acddfd36ae8f18cfa7db07ffafc3e469d9 (diff) | |
| download | perl6-matrix-client-b108bfae64edb309ec0553e928b973c9f3e0f8e9.tar.gz | |
Add basic tutorial.
| -rw-r--r-- | docs/basics.pod6 | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/docs/basics.pod6 b/docs/basics.pod6 new file mode 100644 index 0000000..a6f5d45 --- /dev/null +++ b/docs/basics.pod6 @@ -0,0 +1,99 @@ +=begin pod + +=head1 Basic tutorial + +=head2 Client creation + +The first thing to do is create a C<Matrix::Client> pointing to +the homeserver, and C<login> into it. + + my Matrix::Client $client .= new: + :home-server<https://matrix.org>; + $client.login($username, $password); + +In case you have an access-token, you can pass it as a parameter +to C<new>. In this case is not necessary to call C<login> + + my Matrix::Client $client .= new: + :home-server<https://matrix.org>, + :access-token($access-token); + +=head2 Syncing + +Calling sync will return a C<Matrix::Response::Sync> that abstract the +response from the server. This structure should have all the information +from the server like: + +=item presence +=item joined rooms +=item room invites + +It should be noted that the C<.next-batch> will have the C<:since> argument +that is passed to the next C<sync>. If not provided, the response will have +repeated data. + + my $response = $client.sync; + my $since = $response.next-batch; + + # print all messages + for $response.joined-rooms -> $room { + for $room.timeline.events + .grep(*.type eq 'm.room.message') -> $msg { + $msg.content<body>.say; + } + } + + # Sync again with the since parameter + my $new-response = $client.sync(:$since); + +There's a C<filter> argument that you could use to filter the response. To +see available parameters to the filter you can go +L<here|https://matrix.org/docs/spec/client_server/r0.3.0.html#post-matrix-client-r0-user-userid-filter>. + + # limit the messages per room to 1 + + # Passing a hash. + my $response = $client.sync( + filter => { room => timeline => limit => 1} + ); + + # Passing a json as parameter + my $response = $client.sync( + filter => '{"room":{"timeline":{ "limit": 1}}}' + ); + +As for now, you can't send a filter_id of an already created filter. + +=head2 Sending messages + +There's two ways to send messages to a channel. + +=item C<.send($room-id, $message, :$type)> from C<Matrix::Client> +=item C<.send($message, :$type)> from C<Matrix::Client::Room> + +Here's an example of the two: + + my $room = $client.joined-rooms.first; + $client.send($room.id, 'Hello'); + $room.send('hello'); + +=head2 Async loop + +The client supports an async loop that can replace a C<loop { $client.sync; … }> +since it's a common thing to do. It starts a new thread that runs that loop +sending all the events through a C<Supplier>. + + my $supply = $client.run(); + + react { + whenever $supply -> $s { + when $s ~~ Matrix::Response::InviteInfo { + say "Got an invite from {$s.room-id} + } + when $s ~~ Matrix::Response::RoomInfo { + say "Got a room event from {$s.room-id} + } + } + } + +=end pod |