Javascript URI

From Yate Documentation
(Difference between revisions)
Jump to: navigation, search
(Created page with "== Constructor == == Methods ==")
 
Line 1: Line 1:
 +
== General ==
 +
 +
URI (Uniform Resource Identifier encapsulation) object.<br>
 +
 +
 +
Supported format:
 +
[description] [proto:][//][user@]host[:port][/path][;params][?params][&params]
 +
 +
 
== Constructor ==
 
== Constructor ==
 +
 +
* '''new Engine.URI(str)'''
 +
Parameters:<br/>
 +
'''str''' String with URI data<br/>
  
  
 
== Methods ==
 
== Methods ==
 +
 +
* '''getDescription()'''
 +
Return: String with URI description part<br/>
 +
 +
* '''getProtocol()'''
 +
Return: String with URI protocol part<br/>
 +
 +
* '''getUser()'''
 +
Return: String with URI user part<br/>
 +
 +
* '''getHost()'''
 +
Return: String with URI host part<br/>
 +
 +
* '''getPort()'''
 +
Return: Numeric with URI port part. 0 if missing<br/>
 +
 +
* '''getExtra()'''
 +
Return: String with URI extra (parameters) part<br/>
 +
 +
* '''getCanonical()'''
 +
Return: String with URI canonical representation<br/>
 +
 +
Canonical representation (user present or not):<br/>
 +
[proto:][user@[host[:port]]]:<br/>
 +
[proto:][host[:port]]]:<br/>

Revision as of 16:26, 6 September 2024

General

URI (Uniform Resource Identifier encapsulation) object.


Supported format:

[description] [proto:][//][user@]host[:port][/path][;params][?params][&params]


Constructor

  • new Engine.URI(str)

Parameters:
str String with URI data


Methods

  • getDescription()

Return: String with URI description part

  • getProtocol()

Return: String with URI protocol part

  • getUser()

Return: String with URI user part

  • getHost()

Return: String with URI host part

  • getPort()

Return: Numeric with URI port part. 0 if missing

  • getExtra()

Return: String with URI extra (parameters) part

  • getCanonical()

Return: String with URI canonical representation

Canonical representation (user present or not):

[proto:][user@[host[:port]]]:
[proto:][host[:port]]]:
Personal tools
Namespaces

Variants
Actions
Preface
Configuration
Administrators
Developers