IPWorks 2024 API Changes
In most cases upgrading is seamless and requires no code changes, as efforts have been made to maintain backwards compatibility. However, the release of IPWorks 2024 includes several API changes that may require code changes. The table below is a list of major changes between IPWorks 2022 and IPWorks 2024.
Upgrading to IPWorks 2024 is designed to be a quick process and involve only minimal code changes while offering additional functionality and options for new and existing users. Please contact us at support@nsoftware.com with any questions or comments.
Components with Changes
API Changes
The table below describes API changes in IPWorks 2024. Please refer to the notes for each entry for details.
| CalDAV | |||
| Property | Calendars | New | |
| Property | Created | Removed | |
| Property | Depth | Removed | |
| Property | DisplayName | Removed | |
| Property | RelatedTo | New | |
| Property | StatusLine | Removed | |
| Method | CopyCalendarEvent | Removed | |
| Method | CopyEvent | New | |
| Method | CreateEvent | New | |
| Method | DeleteCalendar | New | |
| Method | DeleteCalendarEvent | Removed | |
| Method | DeleteEvent | New | |
| Method | GetCalendarEvent | Removed | |
| Method | GetEvent | New | |
| Method | ListCalendars | New | |
| Method | MoveCalendarEvent | Removed | |
| Method | MoveEvent | New | |
| Method | PutCalendarEvent | Removed | |
| Method | SendCustomRequest | New | |
| Method | UpdateCalendar | New | |
| Method | UpdateEvent | New | |
| CardDAV | New Component | ||
| CertMgr | |||
| Method | CheckCRL | New | |
| Method | CheckOCSP | New | |
| DNS | |||
| Property | DNSPort | Typechange: LONG is now INT | |
| FileMailer | |||
| Property | Command | Removed (previously deprecated) | |
| Property | MailPort | Typechange: LONG is now INT | |
| FTP | |||
| Property | Command | Removed (previously deprecated) | |
| Property | FileExists | Removed (previously deprecated) | |
| Property | FileSize | Removed (previously deprecated) | |
| Property | FileTime | Removed (previously deprecated) | |
| Property | RemotePath | Removed (previously deprecated) | |
| Property | RemotePort | Typechange: LONG is now INT | |
| HTMLMailer | |||
| Property | Command | Removed (previously deprecated) | |
| Property | MailPort | Typechange: LONG is now INT | |
| HTTP | |||
| Property | URLPort | Typechange: LONG is now INT | |
| Method | Patch | New | |
| ICMP | |||
| Property | DataToSend | Removed (previously deprecated) | |
| IMAP | |||
| Property | Command | Removed (previously deprecated) | |
| Property | MailPort | Typechange: LONG is now INT | |
| Property | MessageCount | Typechange: LONG is now INT | |
| Property | RecentMessageCount | Typechange: LONG is now INT | |
| Method | FetchMessageHeaders | Removed | |
| Method | FetchMessageInfo | Removed | |
| Method | FetchMessagePart | Removed | |
| Method | FetchMessagePartHeaders | Removed | |
| Method | FetchMessageText | Removed | |
| Method | RetrieveMessageHeaders | New | |
| Method | RetrieveMessageInfo | New | |
| Method | RetrieveMessagePart | New | |
| Method | RetrieveMessagePartHeaders | New | |
| Method | RetrieveMessageText | New | |
| IPInfo | |||
| Property | RequestId | Typechange: LONG is now INT | |
| Property | ServicePort | Typechange: LONG is now INT | |
| LDAP | |||
| Property | ServerPort | Typechange: LONG is now INT | |
| MCast | |||
| Property | DataToSend | Removed (previously deprecated) | |
| Property | LocalPort | Typechange: LONG is now INT | |
| Property | RemotePort | Typechange: LONG is now INT | |
| MX | |||
| Property | DNSPort | Typechange: LONG is now INT | |
| NetClock | |||
| Property | TimePort | Typechange: LONG is now INT | |
| Ping | |||
| Property | RequestId | Typechange: LONG is now INT | |
| Property | ResponseTime | Typechange: LONG is now INT | |
| POP | |||
| Property | Command | Removed (previously deprecated) | |
| Property | MailPort | Typechange: LONG is now INT | |
| Property | MaxLines | Typechange: LONG is now INT | |
| Property | MessageCount | Typechange: LONG is now INT | |
| Property | MessageNumber | Typechange: LONG is now INT | |
| Property | MessageSize | Removed (previously deprecated) | |
| Property | MessageUID | Removed (previously deprecated) | |
| Property | TotalSize | Removed (previously deprecated) | |
| RCP | |||
| Property | LocalPort | Typechange: LONG is now INT | |
| Property | RemotePort | Typechange: LONG is now INT | |
| S3 | |||
| Property | VersioningEnabled | Removed (previously deprecated) | |
| SMTP | |||
| Property | Command | Removed (previously deprecated) | |
| Property | MailPort | Typechange: LONG is now INT | |
| SysLog | |||
| Property | LocalPort | Typechange: LONG is now INT | |
| Property | RemotePort | Typechange: LONG is now INT | |
| TCPClient | |||
| Property | BytesSent | Typechange: LONG is now INT | |
| Property | DataToSend | Removed (previously deprecated) | |
| Property | LocalPort | Typechange: LONG is now INT | |
| Property | RemotePort | Typechange: LONG is now INT | |
| TCPServer | |||
| Property | LocalPort | Typechange: LONG is now INT | |
| Telnet | |||
| Property | BytesSent | Typechange: LONG is now INT | |
| Property | Command | Removed (previously deprecated) | |
| Property | DataToSend | Removed (previously deprecated) | |
| Property | DontOption | Removed (previously deprecated) | |
| Property | DoOption | Removed (previously deprecated) | |
| Property | DoSubOption | Removed (previously deprecated) | |
| Property | LocalPort | Typechange: LONG is now INT | |
| Property | RemotePort | Typechange: LONG is now INT | |
| Property | UrgentData | Removed (previously deprecated) | |
| Property | WillOption | Removed (previously deprecated) | |
| Property | WontOption | Removed (previously deprecated) | |
| TFTPClient | |||
| Property | TFTPPort | Typechange: LONG is now INT | |
| TFTPServer | |||
| Property | LocalPort | Typechange: LONG is now INT | |
| Property | Timeout | Removed | |
| UDP | |||
| Property | DataToSend | Removed (previously deprecated) | |
| Property | LocalPort | Typechange: LONG is now INT | |
| Property | RemotePort | Typechange: LONG is now INT | |
| WebDAV | |||
| Property | ResourceData | New | |
| Property | TransferredDataLimit | Removed | |
| Method | CheckFileExists | New | |
| Method | SendCustomRequest | New | |
| WSClient | |||
| Property | BytesSent | Typechange: LONG is now INT | |
| Property | DataToSend | Removed (previously deprecated) | |
| Property | LocalPort | Typechange: LONG is now INT | |
| WSServer | |||
| Property | LocalPort | Typechange: LONG is now INT | |
| Property | SSLProvider | New | |
We appreciate your feedback. If you have any questions, comments, or suggestions about this article please contact our support team at kb@nsoftware.com.