SessionList (Object function): Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
mNo edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Object:SessionList subtitle}} | {{Template:Object:SessionList subtitle}} | ||
==Syntax== | ==Syntax== | ||
{{Template:Object:SessionList syntax}} | {{Template:Object:SessionList syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%persObjList</th><td>Object</td></tr> | <tr><th>%persObjList</th> | ||
<td>An <var>Arraylist of Object [[PersistentObjectInfo class|PersistentObjectInfo]]</var> object variable.</td></tr> | |||
<tr><th nowrap="true"><var>%(Object)</var></th> | <tr><th nowrap="true"><var>%(Object)</var></th> | ||
<td>The class name in parentheses denotes a shared method. <var>SessionList</var> can also be invoked via | <td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared method]]. <var>SessionList</var> can also be invoked via an <var>Object</var> class object variable, which may be <var>Null</var>.</td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td>string< | <td>An optional, case-sensitive, pattern-matching string that identifies the name(s) of the session(s) whose information is to be returned to <var class="term">%persObjList</var>. The default if no string is provided is to return the information of all sessions.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<var>SessionList</var> is also a shared method in the <var>PersistentObjectInfo</var> class. | |||
Consequently: | |||
<ul> | |||
<li>Both of these statements are valid: | |||
<p class="code">%persInfoList = %(object):sessionList | |||
%persInfoList = %(persistentObjectInfo):sessionList</p></li> | |||
<li>You can use the <var>Object</var> class <var>SessionList</var> method the same way the the <var>PersistentObjectInfo</var> class <var>GlobalList</var> method is used in the example in [[PersistentObjectInfo class#Using GlobalList or SessionList|Using GlobalList or SessionList]].</li> | |||
</ul> | |||
==Examples== | ==Examples== | ||
See [[Global and session objects#Using system class methods to access global and session objects|Using system class methods to access global and session objects]]. | |||
==See also== | ==See also== | ||
{{Template:Object:SessionList footer}} | {{Template:Object:SessionList footer}} | ||
Latest revision as of 19:21, 27 August 2014
Get list of session objects (Object class)
[Introduced in Sirius Mods 7.8]
Syntax
%persObjList = %(Object):SessionList[( [string])]
Syntax terms
| %persObjList | An Arraylist of Object PersistentObjectInfo object variable. |
|---|---|
| %(Object) | The class name in parentheses denotes a shared method. SessionList can also be invoked via an Object class object variable, which may be Null. |
| string | An optional, case-sensitive, pattern-matching string that identifies the name(s) of the session(s) whose information is to be returned to %persObjList. The default if no string is provided is to return the information of all sessions. |
Usage notes
SessionList is also a shared method in the PersistentObjectInfo class. Consequently:
- Both of these statements are valid:
%persInfoList = %(object):sessionList %persInfoList = %(persistentObjectInfo):sessionList
- You can use the Object class SessionList method the same way the the PersistentObjectInfo class GlobalList method is used in the example in Using GlobalList or SessionList.
Examples
See Using system class methods to access global and session objects.