IsGroupLoggedOff()

This function returns true if all members of the given group are logged off.

Please see the Introduction chapter for some usage instructions.

---------------------------------------------------------------------
-- Name:     IsGroupLoggedOff
--           ================
-- 
-- Checks if all members of a given SwyxWare user group are logged off.
--
-- Parameter
--      sGroup      group number or name
-- 
-- Return:
--      boolean     True  - all members of the given group are logged off (or status can't be requested)
--                  False - at least one member of the given group is logged on
----------------------------------------------------------------------
function IsGroupLoggedOff ( sGroup )
 
    PBXScript.OutputTrace ("-------------> IsGroupLoggedOff ( sGroup = " .. sGroup .. " )")
 
    local bReturn = true
    local oUsers  = nil

    oUsers = PBXScript.GetUserByAddress(sGroup)
    if (oUsers ~= nil) then

        for i = 1, #oUsers do

            PBXScript.OutputTrace ("Found user '" .. oUsers[i]:Name() .. "' with current state '" .. oUsers[i]:State() .. "'")
            if (oUsers[i]:State() > 1) then 
                bReturn = false
            end

        end

    end    
 
    PBXScript.OutputTrace ("bReturn = " .. tostring(bReturn))
    PBXScript.OutputTrace ("<------------- IsGroupLoggedOff")
 
    return bReturn
end

This function makes use of the Server Script API functions PBXConfig.GetUserByAddress() to resolve all users in the given group and PBXScript.OutputTrace() to write trace information into the SwyxServer trace file.

Please note: if you are on SwyxWare v13.27 (or higher) and need to know if all users of the group the current script is running for are logged in/off, you can also use the new Server Script API function PBXGroup.IsLoggedIn().

This function was converted from VBScript into Lua from the initially posted version in this forum topic.

By Tom Wellige

June 5, 2022

Sign In

Function Collection (Lua)

Introduction

Functions

IsGroupLoggedOff()

User Feedback

Recommended Comments

Create an account or sign in to comment

Create an account

Sign in

Important Information