From 9da9134f0b28c0e4c69537b54fd96dca3a66aaed Mon Sep 17 00:00:00 2001 From: Matias Linares Date: Mon, 11 Jan 2021 22:19:00 -0300 Subject: [DOC] .pod6 -> .rakudoc extension & better layout --- docs/basics.pod6 | 103 ------------------------------------------------------- 1 file changed, 103 deletions(-) delete mode 100644 docs/basics.pod6 (limited to 'docs/basics.pod6') diff --git a/docs/basics.pod6 b/docs/basics.pod6 deleted file mode 100644 index 5770f4f..0000000 --- a/docs/basics.pod6 +++ /dev/null @@ -1,103 +0,0 @@ -=begin pod - -=head1 Basic tutorial - -=head2 Client creation - -The first thing to do is create a C pointing to -the homeserver, and C into it. - - my Matrix::Client $client .= new: - :home-server; - $client.login($username, $password); - say $client.access-token; - -In case you have an access-token, you can pass it as a parameter -to C. In this case is not necessary to call C. - - my Matrix::Client $client .= new: - :home-server, - :access-token($access-token); - - say $client.whoami; # @yourusername:home-server - -=head2 Syncing - -Calling sync will return a C 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 - -Beware that the C<.next-batch> will have the C<:since> argument -that is passed to the next C. 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.say; - } - } - - # Sync again with the since parameter - my $new-response = $client.sync(:$since); - -There's a C argument that you could use to filter the response. To -see available parameters to the filter you can go L. - - # limit the messages per room to 1 - - # Passing a hash. - my $response = $client.sync( - sync-filter => { room => timeline => limit => 1} - ); - - # Passing a json as parameter - my $json-response = $client.sync( - sync-filter => '{"room":{"timeline":{ "limit": 1}}}' - ); - -As for now, you can't send a filter_id of an already created filter. - -=head2 Sending events - -There's two ways to send events to a channel. The only event supported -is C - - -=item C<.send($room-id, $message, :$type)> from C -=item C<.send($message, :$type)> from C - -Here's an example of the two: - - my $room = $client.joined-rooms.first; - $client.send($room.id, 'Hello'); - $room.send('hello'); - -=head2 Async loop - -C supports an async loop that can replace a C -since it's a common thing to do. It starts a new thread that runs that loop -sending all the events through a C. - - 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::StateEvent { - say "Got a room event from {$s.room-id}"; - } - } - } - -=end pod -- cgit v1.2.3-70-g09d2