Javascript URI
From Yate Documentation
(Difference between revisions)
(Created page with "== Constructor == == Methods ==") |
|||
| (2 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
| + | == General == | ||
| + | |||
| + | URI (Uniform Resource Identifier) object.<br> | ||
| + | |||
| + | |||
| + | Supported format: | ||
| + | [description] [proto:][//][user@]host[:port][/path][;params][?params][¶ms] | ||
| + | |||
| + | |||
== 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]]] | ||
| + | [proto:][host[:port]]] | ||
Latest revision as of 16:26, 6 September 2024
[edit] General
URI (Uniform Resource Identifier) object.
Supported format:
[description] [proto:][//][user@]host[:port][/path][;params][?params][¶ms]
[edit] Constructor
- new Engine.URI(str)
Parameters:
str String with URI data
[edit] 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]]]
