--- title: "Functions (RSCI)" canonical: "https://docs.cuesystem.com/space/CVCAPPLETS/284852338/Functions%20(RSCI)" format: markdown --- > Macro (toc) --- ## ExtendMeeting This function extends the current meeting (which takes place in the room managed with reservation panel) by the **extendtime**. #### Syntax ```visualbasic Function ExtendMeeting(extendtime As Time) As Boolean ``` The function returns True on success or False if an error occurs. ## ExtendMeetingAndGetMeetingInfo This function extends the current meeting (which takes place in the room managed with the reservation panel) by the **extendtime **and returns the status of the current meeting, which takes place in the room managed with the reservation panel. #### Syntax ```visualbasic Function ExtendMeetingAndGetMeetingInfo( extendtime As Time, ByRef meetinginfo As MeetingInfoStructure) As Boolean ``` The function returns True on success or False if an error occurs. ## FinishMeeting This function finishes the current meeting, which takes place in the room managed with a reservation panel. #### Syntax ```visualbasic Function FinishMeeting() As Boolean ``` The function returns True on success or False if an error occurs. ## FinishMeetingAndGetMeetingInfo This function finishes the current meeting, which takes place in the room managed with the reservation panel, and returns the status of the current meeting, which takes place in the room managed with the reservation panel. #### Syntax ```visualbasic Function FinishMeetingAndGetMeetingInfo(ByRef meetinginfo As MeetingInfoStructure) As Boolean ``` The function returns True on success or False if an error occurs. ## GetMeetingInfo This function returns the status of the current meeting, which takes place in the room managed with the reservation panel. The function returns True on success or False if an error occurs. Example: Control system touchpanel displays room status text on page1, object StaticText. Status is refreshed with PushButton2 #### Syntax ```visualbasic Function GetMeetingInfo(ByRef meetinginfo As MeetingInfoStructure) As Boolean ``` ## GetNearestMeetingInfo This function returns the status of the nearest meeting (maximum 7 days in advance), which takes place in the room managed with the reservation panel. This function is only supported for Exchange and Microsoft 365 servers. The function returns True on success or False if an error occurs. #### Syntax ```visualbasic Function GetNearestMeetingInfo(ByRef nearestmeetinginfo As NearestMeetingInfoStructure) As Boolean ``` ## GetOnline This function returns True if the RS panel is online and communicates with the control system, otherwise, it returns False. #### Syntax ```visualbasic Function GetOnline() As Boolean ``` ## ReserveNow This function creates a meeting in the room managed with a reservation panel from the current time. #### Syntax ```visualbasic Function ReserveNow( subject As Text, durationtime As Time, Optional sensitivity As Long := SENSITIVITY_PUBLIC) As Boolean ``` #### Parameters - subjekt - Event name - durationtime - duration of the event - sensitivity 1 = SENSITIVITY_PUBLIC 2 = SENSITIVITY_PRIVATE The function returns True on success or False if an error occurs. ## ReserveNowAndGetMeetingInfo This function creates a meeting in the room managed with the reservation panel from the current time and returns the status of the current meeting, which takes place in the room managed with the reservation panel. #### Syntax ```visualbasic Function ReserveNowAndGetMeetingInfo( subject As Text, durationtime As Time, ByRef meetinginfo As MeetingInfoStructure, Optional sensitivity As Long := SENSITIVITY_PUBLIC) As Boolean ``` #### Parameters - subjekt - Event name - durationtime - duration of the event - meetinginfo - status of the current meeting sensitivity 1 = SENSITIVITY_PUBLIC 2 = SENSITIVITY_PRIVATE The function returns True on success or False if an error occurs. ## SetButtonIndication This function switch on or off the indication “LED“ in the button corner. #### Syntax ```visualbasic Function SetButtonIndication( groupnumber As Long, buttonnumber As Long, newindication As Boolean, Optional updateimmediately As Boolean := True) As Boolean ``` #### Parameters - groupnunber - number of group, values: 1,2,3 - buttonnumber - number of button, values: 1,2,3,4 - newindication - state of the “LED“ indication (True = on, False = off). - updateimmediately - if True, new button settings are sent immediately to the RS panel. If False, the new setting is stored in memory and it is sent to the RS panel with some next communication. It is useful when you need to set more buttons at the same time. In this case call any settings commands with flag updateimmediately = False, just the last command call with flag updateimmediately = True. The function returns True on success or False if an error occurs. ## SetButtonParams This function sets the keypad button parameter on the RS panel. #### Syntax ```visualbasic Function SetButtonParams( groupnumber As Long, buttonnumber As Long, newtext As AddressOf Text, enabled As Boolean, indicationenabled As Boolean, Optional longpresstime As Time := -:1.0, Optional updateimmediately As Boolean := True) As Boolean ``` #### Parameters - groupnunber - number of group, values: 1,2,3 - buttonnumber - number of button, values: 1,2,3,4 - newtext - text displayed on the button - enabled - enable (True, show) or disable (False, hide) the button - indicationenabled - enable (True) or disable (False) the indication “LED“ displayed in the button corner. - longpresstime - this is the long press time, use 0:0 for push button, 1000:00 for release button, :0.4 for Long Press Button :0.4 sec. or :0.8 for Long Press Button :0.8 sec. You can also use any other reasonable time for button long press time. - updateimmediately - see description above The function returns True on success or False if an error occurs. ## SetGroupStatusDescription This function sets the status description text on the bottom part of the button group of the control keypad. #### Syntax ```visualbasic Function SetGroupStatusDescription( groupnumber As Long, newtext As Text, Optional updateimmediately As Boolean := True) As Boolean ``` #### Parameters - groupnumber - number of group, values: 1,2,3 - newtext - text of the status description - updateimmediately - see description above The function returns True on success or False if an error occurs. ## SetGroupText #### Syntax This function sets the name of the button group displayed on the top of the button group. ```visualbasic Function SetGroupText( groupnumber As Long, newtext As Text, Optional updateimmediately As Boolean := True) As Boolean ``` #### Parameters - groupnumber - number of group, values: 1,2,3 - newtext - new value of the group name. - updateimmediately - see description above The function returns True on success or False if an error occurs. ## SetCleanUpRequest #### Syntax This function sets the status of the cleaning screen (room waiting to be cleaned / room not waiting to be cleaned). You can email a cleanup request if cleanup is enabled on the panel. To send an email with a cleanup request, set activate = True. ```visualbasic Function SetCleanUpRequest( activate As Boolean, Optional emailtext As Text := "") As Boolean ``` #### Parameters - activate - True - room waiting to be cleaned and send email with a cleanup request. False - room not waiting to be cleaned - emailtext - specify any details of your order The function returns True on success or False if an error occurs. ## GetCleanUpRequest This function returns the status of the cleaning screen. The function returns True on success or False if an error occurs. #### Syntax ```visualbasic Function GetCleanUpRequest(ByRef activate As Boolean) As Boolean ``` ## SetCateringRequest #### Syntax You can send email a catering request if catering is enabled on the panel. ```visualbasic Function SetCateringRequest( list As Array[10] As Long, Optional emailtext As Text := "") As Boolean ``` #### Parameters - list - specify the number of requested refreshments - emailtext - specify any details of your order The function returns True on success or False if an error occurs. ## GetCateringRequest This function returns the list of the catering screen. The function returns True on success or False if an error occurs. #### Syntax ```visualbasic Function GetCateringRequest(ByRef list As Array[10] As Text) As Boolean ``` ## SetService1Request #### Syntax You can send email a service 1 request if service 1 is enabled on the panel. ```visualbasic Function SetService1Request( list As Array[10] As Boolean, Optional emailtext As Text := "") As Boolean ``` #### Parameters - list - True - An item from the list is requested, False An item from the list is not requested. - emailtext - specify any details of your order The function returns True on success or False if an error occurs. ## GetService1Request This function returns the list of the service 1 screen. The function returns True on success or False if an error occurs. #### Syntax ```visualbasic Function GetService1Request(ByRef list As Array[10] As Boolean) As Boolean ``` ## SetService2Request #### Syntax You can send email a service 2 request if service 2 is enabled on the panel. ```visualbasic Function SetService2Request( list As Array[10] As Boolean, Optional emailtext As Text := "") As Boolean ``` #### Parameters - list - True - An item from the list is requested, False An item from the list is not requested. - emailtext - specify any details of your order The function returns True on success or False if an error occurs. ## GetService2Request This function returns the list of the service 2 screen. The function returns True on success or False if an error occurs. #### Syntax ```visualbasic Function GetService2Request(ByRef list As Array[10] As Boolean) As Boolean ``` ## VerifyUserPIN #### Syntax This function verify the User PIN. ```visualbasic Function VerifyUserPIN( pin As Text) As Boolean ``` #### Parameters - pin - PIN of user The function returns True on success or False if an error occurs. ## VerifyServicePIN #### Syntax This function verify the Service PIN. ```visualbasic Function VerifyUserPIN( pin As Text) As Boolean ``` #### Parameters - pin - PIN of service The function returns True on success or False if an error occurs. ## VerifyCleanUpPIN #### Syntax This function verify the CleanUp PIN. ```visualbasic Function CleanUp( pin As Text) As Boolean ``` #### Parameters - pin - PIN of cleanup The function returns True on success or False if an error occurs. ## ConfirmActualMeeting #### Syntax This function confirm the actual meeting. ```visualbasic Function ConfirmActualMeeting() As Boolean ``` The function returns True on success or False if an error occurs. ## SetRSMagicNameOrIPAddress #### Syntax This function set the magic name or IP address of panel. ```visualbasic Function SetRSMagicNameOrIPAddress( newrsmagicnameoripaddress As Text) As Boolean ``` #### Parameters - newrsmagicnameoripaddress - magic name or IP address The function returns True on success or False if an error occurs. ## GetRSMagicNameOrIPAddress This function returns the magic name or IP address of panel. The function returns True on success or False if an error occurs. #### Syntax ```visualbasic Function GetRSMagicNameOrIPAddress(ByRef newrsmagicnameoripaddress As Text) As Boolean ``` ## WaitWhilePressed This function waits until the button is released. If an optional timeout parameter is used, the maximum wait time is limited by the timeout value. In case of timeout excess, the function returns False, otherwise, it returns True. #### Syntax ```visualbasic Function WaitWhilePressed(Optional timeout As Time := _TIME_INFINITE) As Boolean ```