blob: 5770f4fcb04e8a62e33174394b6ab8fbe911d087 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
=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);
say $client.access-token;
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);
say $client.whoami; # @yourusername:home-server
=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
Beware 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(
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<m.room.message>
=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
C<Matrix::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::StateEvent {
say "Got a room event from {$s.room-id}";
}
}
}
=end pod
|
