.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Net::Async::Matrix::Room::State 3pm" .TH Net::Async::Matrix::Room::State 3pm "2019-08-12" "perl v5.28.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" "Net::Async::Matrix::Room::State" \- represents the state events in a matrix room .SH "DESCRIPTION" .IX Header "DESCRIPTION" Instances of this class represent all of the known state events in a Net::Async::Matrix::Room at some instant in time. These objects are mutable so a \*(L"live\*(R" state object obtained from a room will change to keep track of newly received state events. .SH "METHODS" .IX Header "METHODS" .SS "get_event" .IX Subsection "get_event" .Vb 1 \& $event = $state\->get_event( $type, $state_key ) .Ve .PP Returns a \s-1HASH\s0 reference containing the raw event stored for the given type name and optional state key. .SS "get_events" .IX Subsection "get_events" .Vb 1 \& $events = $state\->get_events( $type ) .Ve .PP Returns a multi-level \s-1HASH\s0 reference mapping all of the known state keys for a given event type name to their raw stored events. Typically this is useful for \&\f(CW\*(C`m.room.member\*(C'\fR events as the state keys will be user IDs. .SH "CONVENIENCE ACCESSORS" .IX Header "CONVENIENCE ACCESSORS" The following accessors all fetch single values out of certain events, as they are commonly used. .SS "name" .IX Subsection "name" .Vb 1 \& $name = $state\->name .Ve .PP Returns the \f(CW\*(C`name\*(C'\fR field of the \f(CW\*(C`m.room.name\*(C'\fR event, if it exists. .SS "join_rule" .IX Subsection "join_rule" .Vb 1 \& $join_rule = $state\->join_rule .Ve .PP Returns the \f(CW\*(C`join_rule\*(C'\fR field of the \f(CW\*(C`m.room.join_rules\*(C'\fR event, if it exists. .SS "topic" .IX Subsection "topic" .Vb 1 \& $topic = $state\->topic .Ve .PP Returns the \f(CW\*(C`topic\*(C'\fR field of the \f(CW\*(C`m.room.topic\*(C'\fR event, if it exists. .SS "aliases" .IX Subsection "aliases" .Vb 1 \& @aliases = $state\->aliases .Ve .PP Returns a list of the room alias from all the \f(CW\*(C`m.room.aliases\*(C'\fR events, in no particular order. .SS "members" .IX Subsection "members" .Vb 1 \& @members = $state\->members .Ve .PP Returns a list of Member instances representing all of the members of the room from the \f(CW\*(C`m.room.member\*(C'\fR events whose membership state is not \f(CW\*(C`leave\*(C'\fR. .SS "all_members" .IX Subsection "all_members" .Vb 1 \& @members = $state\->members .Ve .PP Similar to \*(L"members\*(R" but even includes members in \f(CW\*(C`leave\*(C'\fR state. This is not normally what you want. .SS "member" .IX Subsection "member" .Vb 1 \& $member = $state\->member( $user_id ) .Ve .PP Returns a Member instance representing a room member of the given user \s-1ID,\s0 or \&\f(CW\*(C`undef\*(C'\fR if none exists. .SS "member_level" .IX Subsection "member_level" .Vb 1 \& $level = $state\->member_level( $user_id ) .Ve .PP Returns a number indicating the power level that the given user \s-1ID\s0 would have according to room state, taken from the \f(CW\*(C`m.room.power_levels\*(C'\fR event. This takes into account the \f(CW\*(C`users_default\*(C'\fR field, if no specific level exists for the given user \s-1ID.\s0 .SH "AUTHOR" .IX Header "AUTHOR" Paul Evans