Function Collection (Lua)
Function Collection (Lua)
Introduction
- Introduction
Functions

IsUserLoggedOn()

This function returns true of the given user is logged on.

Please see the Introduction chapter for some usage instructions.

------------------------------------------------------------------
-- IsUserLoggedOn
--
-- Checks if given user is logged on
--
-- Parameter:
--   sNumber         user name or extension
--
-- Return:
--	boolean
------------------------------------------------------------------
function IsUserLoggedOn( sNumber )
    PBXScript.OutputTrace ("-------------> IsUserLoggedOn ( sNumber = " .. sNumber .. " )")

    local bReturn = false
    local oUsers  = nil

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

        for i = 1, #oUsers do

            PBXScript.OutputTrace ("Found user '" .. oUsers[i]:Name() .. "' with current state '" .. oUsers[i]:State() .. "'")
            bReturn = (oUsers[i]:State() >= 2)

        end
    end 

    PBXScript.OutputTrace ("bReturn = " .. tostring(bReturn))
    PBXScript.OutputTrace ("<------------- IsUserLoggedOn")

    return bReturn
end

This function makes use of the Server Script API functions PBXConfig.GetUserByAddress() to get the current status of the given user and PBXScript.OutputTrace() to write trace information into the SwyxServer trace file.

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