TheCommonUtils Methods

Converts a Unicode-encoded byte array to a string.

Converts a portion of a Unicode-encoded byte array to a string.

Converts a byte array using UTF8 encoding to a character string.

Converts a byte array using UTF8 encoding to a character string.

Converts a byte array using UTF8 encoding to a character string.

Converts a byte array using UTF8 encoding to a character string.

Converts an object to boolean.

Converts an object to a byte.

Converts an object to a character.

Converts a string to a date.

Convert an object to a date.

Converts an input date into the JSON Date(ticks) notation.

Convert an object to double.

Converts an object to Double.

Abstracts Buffer.BlockCopy for older OS/.NET Versions

Compress a portion of a byte array.

Compress a string to a byte array. Reverse the process by calling cdeDecompressToString.

Query a list of tokens for the presence of a specific token.

Create an XML element.

Create an XML element.

Decompresses data that was originally compressed with a call to cdeCompressString.

Decompress data from a portion of a byte array to a string.

Deletes a setting from the app.config

Remove duplicates from a list of tokens.

Add web address URL encoding.

Add escapes for XML special characters.

Add escapes for XML special characters plus newline break.

Modify a file path as required to enable compatibilty across different target platforms.

Retrieves a setting from the App.config/web.config "Configuration" Settings

Retrieves a setting from the App.config/web.config "Configuration" Settings

Converts a Guid to a string.

Quickly verifies whether an object holds a lock or not.

Removes Javascript special characters.

Removes Javascript special characters.

Removes Javascript special characters.

Converst a NameValueCollection to a Dictionary

Opens a file in the local filesystem securely. The file will ONLY be opened under clientbin The path is automatically set and fixed up for MONO and Linux environments

Add escapes for back-slash and apostrophe.

Creates new RSA Keys

Returns a decrypted string agains the RSA Key stored in the session

Returns a decrypted string agains the RSA Key stored in the session

decrypts byte array with given string key

Encrypts a string against the RSA Key inside a session

Encrypt a string to a byte array using a given RSA Key

Runs code asynchronously without waiting for the result.

Runs code asynchronously and lets the caller wait for the code to finish

Runs a sequence of asynchronous tasks (task continuations or a method that uses the C# async keyword) and lets the caller wait for the entire chain to finish. The call returns immediately and not when the first continuation is hit.

Converts a string into a string array. if you don't need the Remove.. parameter, please use .NET .split() function. if you need the remove... parameter use the override with the string sep(erator)

Converts a string into a string array.

Process a string to remove all HTML tags.

Removes the return, linefeed, and tab characters from a string.

Truncates strings longer than a specified maximum length.

Truncates a Float to the amount of digits specified.

Truncates a double to the amount of digits specified.

Remove web address URL encoding.

Remove XML special character escapes.

Normalize a UUID to conform to the Microsoft GUID format.

Converts an object to a float.

Converts an object to a Guid.

Converts an object to a signed short integer.

Converts a JSON notation date 'Date(ticks)' to a DateTimeOffset value. Supports input like this: "Date(1335205592410)" Or this: "\"\\/Date(1335205592410-0500)\\/", as produced by the .NET DataContractJsonSerializer.

Returns a specified number of characters from the left side of a string.

Converts a collection into a string.

Converts a collection into a string.

Converts an array of strings a single string.

Converts a collection into a string.

Converts an object to signed long integer.

Create a shallow copy of an object.

Creates nested folder hierarchy for a file being created.

Creates folder hierarchy, optionally omitting file name.

Converts an object to an 8-bit signed integer.

Converts an object to a short signed integer.

Converts an object to a string.

Search for a token in a compound string,

Convert a string to a byte array.

Split a string into a list.

Convert a Unicode-encoded string to a memory stream.

Converts an incoming object to a TimeSpan

Converts an object to an unsigned integer.

Converts an object to an unsigned long integer.

Converts a string into a byte array using Unicode encoding.

Safely converts an object (likely a string) to a System.Uri object.

Converts an object to an unsigned short integer.

Converts a string to a byte array using UTF8 encoding.

Decrypt incoming buffer array to a Dictionary.

Decrypts a byte array to a string using internal AES encryption

Decrypts an encrypted string against a given token GUID

Deserializes an object from a JSON string

Determines whether any of the URLs in the provided input string are a reference to the current host. Note that this function always ignores the hard-coded value of "LOCALHOST".

Determines whether any of the URLs in the provided input string are a reference to the current host.

New in V4.105: Allows to fire a generic event on all supported platforms

New in V4.105: Allows to fire a generic event on all supported platforms

Cross-check two strings containing one or more Guids separated by semi-colons, searching for any match between the two lists.

Encryptes a dictionary to a byte array

Encrypts a string against a token GUID

Performs macro substitutions to generate a final output string.

Performs macro substitutions to generate a final output string.

Performs macro substitutions to generate a final output string.

Retrieve exception details in a string, including the stack trace.

Retrieve exception details in a string, optionally including the stack trace.

NEWV4: Returns a known http resource on this node (TODOV4: Security Review)

Request the version number of a specific plugin.

Returns the Calendar Week for a given DateTime. The calculation is done using Sunday as the first day of the week, and first week as the one with at least four days.

Retrieves a Value for a Key provided at application host startup for values provided as parameters in the call to TheBaseApplication.StartBaseApplication.

Formats a date as a string.

Returns a cultural correct string representation of a DateTimeOffset. Only use for Displaying DateTimeOffsets in UX! Do not use for Messaging or Storage!

Gets a Markup encoded version of a DeviceID for the System Log. If "ShowMInLog" is true. Otherwise just returns the pDeviceID.ToString()

Gets a Markup encoded version of all DeviceIDs in an ORG for the System Log. If "ShowMInLog" is true. Otherwise just returns the pORG

Parse a string containing a list of Guid values for the first one in the list.

Retrieves a value from a parsed JSON data structure based on a JSON path lookup/query. Obtain the parsed JSON using TheCommonUtils.DeserializeJSONStringToObject(). JSON Path details follow those in NewtonSoft's JObject.SelectToken().

Parse a string containing a list of Guid values for the last one in the list.

Query for an LCID.

Returns the Maximum Message Size allowed for a given SenderType

Query for a mime type from a file extension.

Returns the Node Name of this node

Parse a string containing a list of Guid values for the Nth one in the list.

Returns the value of a property.

A dictionary lookup.

Generate a pseudo-random number.

Generate a pseudo-random number.

Returns a file name where all reserved characters are replaced with underscore ("_"). Optionally add a timestamp to the file name. Example: GetSafeFileName("a+b:c/d", "json", true) returns a+b_c_d_201801241106123.json.

Returns a setting either known in the current Settings array or set as an environment variable or in App.Config First it looks into App.config and if this does not contain the setting it falls back to the existing MySettings and if that does not have the entry it looks in the environment variables.

A debug helper to format the call stack in HTML.

Retrieves a section of a string given the parameter of this function. Can be used to parse HTML or other string snippets.

Fetch a resource from an assembly file.

Returns a TimeStamp that can be used for Files up to the millisecond.

Returns the eWebPlatform of a given UserAgent

Extract a section from a string containing XML. The section consists of everything between an opening and a closing tag (but not including the tag itself).

Returns true if a sendery type is a device

Check for a Guid.

Query whether the current host is an end-user device or not, such as a browser or a phone.

Determines whether a node ID references the current host.

Returns true if the UserAgent is a mobile device.

Only use this method if you need to know if you are running in the MONO Runtime. If you want to find out if you are running on Linux use TheCommonUtils.cdeIsFileSystemCaseSensitive or IsOnLinux insted

Only use this method if you need to know if you are running in the MONO Runtime. If you want to find out if you are running on Linux use TheCommonUtils.cdeIsFileSystemCaseSensitive or IsOnLinux insted

Detect the presence of the portable .NET Core platform.

Safe check for strings with no content.

This function provides a platform-independent way to validate string references. It enables support for String.IsNullOrWhiteSpace() under the .NET Framework version 3.5.

Query whether underlying platform is Linux.

Query whether underlying platform is Apple Mac OS.

Determines whether provided URL specifies the current host on which process is running.

Uses JsonConvert.SerializeObject to serialize an object to JSON. (New in V4).

Loads the content of a file into a byte array owned by a plugin

Loads the content of a file into a string owned by a plugin

Loads the content of a file using a given path (under ClientBin)

Logs a session in the Session log for this Application in the StorageService If there is no StorageService Role defined for this application this call does not do anything

Parse a web address for parameters.

Rotates a point in 2-dimensional space around an arbitrary rotation point by the number the specified angle of rotation.

Rounds a date value to a given minute interval.

Rounds a date value to a given second interval.

Saves a message to disk in a directory for a given plugin

Serializes an object/class to JSON.

A safe sleep function.

Set the cancel token to a 'signaled' state.

Creates a cancel token for C-DEngine safe sleep functions.

A safe sleep function.

A safe sleep function.

A safe sleep function.

Retrieves the task that was running when an exception occured.

A portable helper function that resolves platform-specific differences in the handling of System.Threading.Tasks.Task.Result.

Returns a task that completes when the task completes or the cancelToken was canceled. Note that the underlying task will NOT be canceled, only the await/Wait for the returned task will be canceled.

Returns a task that completes when the task completes or a timeout occurrs.

Returns a task that completes when the task completes or a timeout occurrs.

Creates a task that completes when all of the provided tasks are complete.

Creates a task that completes when any of the provided tasks completes.

Convert a hex string into a byte array.

Convert a byte array into a hex string.

Removes a trailing slash from a URL.