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

IsUserFree()

This function returns true if the given user is logged in and free.

Please see the Introduction chapter for some usage instructions.

------------------------------------------------------------------  
-- IsUserFree 
--  
-- Checks if given user is free or not. 
--  
-- Parameter:
--   sNumber     extension  
--  
-- Return:
--   boolean 
------------------------------------------------------------------  
function IsUserFree( sNumber ) 
    PBXScript.OutputTrace ("-------------> IsUserFree ( 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 ("<------------- IsUserFree")

    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.

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