https://community.telligent.com/community/12/w/api-documentation/70018/url-in-process-api-serviceDeveloping on Verint Community? Use the API documentation as a reference for all supported interactions with Verint Community.en-US14.0.0.586 14https://community.telligent.com/community/12/w/api-documentation/70018/url-in-process-api-serviceFri, 13 May 2022 19:29:51 GMT4f3ff664-9acd-4864-82ff-37507e64e413Former Memberhttps://community.telligent.com/community/12/w/api-documentation/70018/url-in-process-api-service#commentsCurrent Revision posted to API Documentation by Former Member on 05/13/2022 19:29:51<br /> <hr class="generated-documentation-start" style="border-width:0;" /><div class="documentation"><p>This service is available via <code>Telligent.Evolution.Extensibility.Apis.Get&lt;Telligent.Evolution.Extensibility.Api.Version1.IUrl&gt;()</code> and is defined in Telligent.Evolution.Platform.dll</p><div class="documentation-members properties"><h2><a id="Properties" name="Properties"></a>Properties</h2><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>CurrentContext</td><td><code>[[PageContext In-Process API Supplementary Type|PageContext]]</code></td><td>Exposes the current contextual information about the incoming url</td><td></td><td></td></tr></tbody></table></div><div class="documentation-members methods"><h2><a id="Methods" name="Methods"></a>Methods</h2><h3> string Absolute(string url); </h3><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>url</td><td><code>string</code></td><td>Url</td><td>Required</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>string</code></p><h3> string Adjust(string url, string queryStringAdjustment = null, string targetAdjustment = null); </h3><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>url</td><td><code>string</code></td><td>Url</td><td>Required</td><td></td><td></td></tr><tr><td>queryStringAdjustment</td><td><code>string</code></td><td>Query String Adjustment</td><td>Optional</td><td></td><td></td></tr><tr><td>targetAdjustment</td><td><code>string</code></td><td>Target Adjustment</td><td>Optional</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>string</code></p><h3> string ApplicationEscape(string url); </h3><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>url</td><td><code>string</code></td><td>Url</td><td>Required</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>string</code></p><h3> string ApplicationUnescape(string url); </h3><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>url</td><td><code>string</code></td><td>Url</td><td>Required</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>string</code></p><h3> string BuildUrl(string urlName, int groupId, Dictionary&lt;string,string&gt; parameters = null); </h3><p>Generates a relative url based on the given parameters including the group path</p><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>urlName</td><td><code>string</code></td><td>Url Name</td><td>Required</td><td></td><td></td></tr><tr><td>groupId</td><td><code>int</code></td><td>Group Id</td><td>Required</td><td></td><td></td></tr><tr><td>parameters</td><td><code>Dictionary&lt;string,string&gt;</code></td><td>Parameters</td><td>Optional</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>string</code></p><h3> string BuildUrl(string urlName, Dictionary&lt;string,string&gt; parameters = null); </h3><p>Generates a relative url based on the given parameters</p><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>urlName</td><td><code>string</code></td><td>Url Name</td><td>Required</td><td></td><td></td></tr><tr><td>parameters</td><td><code>Dictionary&lt;string,string&gt;</code></td><td>Parameters</td><td>Optional</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>string</code></p><h3> string ConvertQueryStringToHash(string url); </h3><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>url</td><td><code>string</code></td><td>Url</td><td>Required</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>string</code></p><h3> string Decode(string text); </h3><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>text</td><td><code>string</code></td><td>Text</td><td>Required</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>string</code></p><h3> string DecodeFileComponent(string text); </h3><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>text</td><td><code>string</code></td><td>Text</td><td>Required</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>string</code></p><h3> string DecodePathComponent(string text); </h3><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>text</td><td><code>string</code></td><td>Text</td><td>Required</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>string</code></p><h3> string Encode(string text); </h3><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>text</td><td><code>string</code></td><td>Text</td><td>Required</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>string</code></p><h3> string EncodeFileComponent(string text); </h3><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>text</td><td><code>string</code></td><td>Text</td><td>Required</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>string</code></p><h3> string EncodePathComponent(string text); </h3><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>text</td><td><code>string</code></td><td>Text</td><td>Required</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>string</code></p><h3> bool IsSafe(string url); </h3><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>url</td><td><code>string</code></td><td>Url</td><td>Required</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>bool</code></p><h3> bool IsSafe(Guid contentTypeId, string url); </h3><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>contentTypeId</td><td><code>Guid</code></td><td>Content Type Id</td><td>Required</td><td></td><td></td></tr><tr><td>url</td><td><code>string</code></td><td>Url</td><td>Required</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>bool</code></p><h3> SafeUrlValidation IsSafe(string url, SafeUrlOptions options); </h3><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>url</td><td><code>string</code></td><td>Url</td><td>Required</td><td></td><td></td></tr><tr><td>options</td><td><code>[[SafeUrlOptions In-Process API Supplementary Type|SafeUrlOptions]]</code></td><td>Options</td><td>Required</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>[[SafeUrlValidation In-Process API Supplementary Type|SafeUrlValidation]]</code></p><h3> string MakeQueryString(NameValueCollection queryStringValues); </h3><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>queryStringValues</td><td><code>NameValueCollection</code></td><td>Query String Values</td><td>Required</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>string</code></p><h3> PageContext ParsePageContext(string localUrl); </h3><p>Extracts contextual information for a given relative local Evolution url</p><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>localUrl</td><td><code>string</code></td><td>A local, relative Evolution url without &#39;~&#39;</td><td>Required</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>[[PageContext In-Process API Supplementary Type|PageContext]]</code></p><h3> NameValueCollection ParseQueryString(string queryString); </h3><h4><a id="Parameters" name="Parameters"></a>Parameters</h4><table cellspacing="0" cellpadding="2" width="99%" class="WikiTable"><thead><tr class="WikiTableBgBlue"><th>Name</th><th>Type</th><th>Description</th><th>Required</th><th>Default</th><th>Options</th></tr></thead><tbody><tr><td>queryString</td><td><code>string</code></td><td>Query String</td><td>Required</td><td></td><td></td></tr></tbody></table><h4><a id="Return_Type" name="Return_Type"></a>Return Type</h4><p><code>NameValueCollection</code></p></div></div><hr class="generated-documentation-end" style="border-width:0;" /><div style="clear:both;"></div>