46 Star 176 Fork 4.8K

OpenHarmony/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.uri.d.ts 33.43 KB
一键复制 编辑 原始数据 按行查看 历史
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175
/*
* Copyright (c) 2021-2022 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit ArkTS
*/
/**
* The uri module provides utilities for URI resolution and parsing.
*
* @namespace uri
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* The uri module provides APIs for parsing URI strings that comply with the RFC3986 standard.
* This standard defines how to encode and parse the identifiers used to locate network resources.
* The module does not support parsing of URIs in non-standard scenarios.
*
* @namespace uri
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The uri module provides APIs for parsing URI strings that comply with the RFC3986 standard.
* This standard defines how to encode and parse the identifiers used to locate network resources.
* The module does not support parsing of URIs in non-standard scenarios.
*
* @namespace uri
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
declare namespace uri {
/**
* URI Represents a Uniform Resource Identifier (URI) reference.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
* @name URI
*/
/**
* URI Represents a Uniform Resource Identifier (URI) reference.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
* @name URI
*/
/**
* URI Represents a Uniform Resource Identifier (URI) reference.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
* @name URI
*/
class URI {
/**
* URI constructor, which is used to instantiate a URI object.
* uri: Constructs a URI by parsing a given string.
*
* @param { string } uri - uri uri
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200002 - Invalid uri string.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* A constructor used to create a URI instance.
*
* @param { string } uri - Input object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200002 - Invalid uri string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* A constructor used to create a URI instance.
*
* @param { string } uri - Input object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200002 - Invalid uri string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
constructor(uri: string);
/**
* Returns the serialized URI as a string.
*
* @returns { string } Returns the serialized URI as a string.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Converts this URI into an encoded string.
*
* @returns { string } URI in a serialized string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Converts this URI into an encoded string.
*
* @returns { string } URI in a serialized string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
toString(): string;
/**
* Check whether this URI is equivalent to other URI objects.
*
* @param { URI } other - other other URI object to be compared
* @returns { boolean } boolean Tests whether this URI is equivalent to other URI objects.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.uri.URI.equalsTo
*/
equals(other: URI): boolean;
/**
* Check whether this URI is equivalent to other URI objects.
*
* @param { URI } other - other other URI object to be compared
* @returns { boolean } boolean Tests whether this URI is equivalent to other URI objects.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Checks whether this URI is the same as another URI object.
*
* @param { URI } other - URI object to compare.
* @returns { boolean } boolean Tests whether this URI is equivalent to other URI objects.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Checks whether this URI is the same as another URI object.
*
* @param { URI } other - URI object to compare.
* @returns { boolean } boolean Tests whether this URI is equivalent to other URI objects.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
equalsTo(other: URI): boolean;
/**
* Indicates whether this URI is an absolute URI.
*
* @returns { boolean } boolean Indicates whether the URI is an absolute URI (whether the scheme component is defined).
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Checks whether this URI is an absolute URI (whether the scheme component is defined).
*
* @returns { boolean } boolean Indicates whether the URI is an absolute URI (whether the scheme component is defined).
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Checks whether this URI is an absolute URI (whether the scheme component is defined).
*
* @returns { boolean } boolean Indicates whether the URI is an absolute URI (whether the scheme component is defined).
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
checkIsAbsolute(): boolean;
/**
* Normalize the path of this URI, It is not safe to call the normalize interface with URI.
*
* @returns { URI } URI Used to normalize the path of this URI and return a URI object whose path has been normalized.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Normalizes the path of this URI.
*
* @returns { URI } URI Used to normalize the path of this URI and return a URI object whose path has been normalized.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Normalizes the path of this URI.
*
* @returns { URI } URI Used to normalize the path of this URI and return a URI object whose path has been normalized.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'11', '1.2':'20'}
* @arkts 1.1&1.2
*/
normalize(): URI;
/**
* Obtains the first value of a given key from the query component of this URI. If the query component contains encoded content,
* this API decodes the key before obtaining the value.
*
* @param { string } key - Given the first value of the key.
* @returns { string } Return decoded value.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
getQueryValue(key: string): string;
/**
* Obtains the first value of a given key from the query component of this URI. If the query component contains encoded content,
* this API decodes the key before obtaining the value.
*
* @param { string } key - Given the first value of the key.
* @returns { string | null } Return decoded value, If no corresponding value is found return a null object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
getQueryValue(key: string): string | null;
/**
* Adds a query parameter to this URI to create a new URI, while keeping the existing URI unchanged.
*
* @param { string } [key] - Key of the query parameter.
* @param { string } [value] - Value of the query parameter.
* @returns { URI } Return URI object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
addQueryValue(key: string, value: string): URI;
/**
* Obtains all non-repeated keys in the query component of this URI.
*
* @returns { string[] } Return a set of decoded names.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
getQueryNames(): string[];
/**
* Obtains all non-repeated keys in the query component of this URI.
*
* @returns { Array<string> } Return a set of decoded names.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
getQueryNames(): Array<string>;
/**
* Obtains the values of a given key from the query component of this URI.
*
* @param { string } key - Key of the URI query parameter.
* @returns { string[] } Return a set of decoded values.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
getQueryValues(key: string): string[];
/**
* Obtains the values of a given key from the query component of this URI.
*
* @param { string } key - Key of the URI query parameter.
* @returns { Array<string> } Return a set of decoded values.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
getQueryValues(key: string): Array<string>;
/**
* Obtains the value of the Boolean type of a query parameter in this URI.
*
* @param { string } key - Indicates the key value to be queried.
* @param { boolean } defaultValue - The default value returned when the key has no query parameters.
* @returns { boolean } Query with key value returns true, otherwise returns false.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
getBooleanQueryValue(key: string, defaultValue: boolean): boolean;
/**
* Clears the query component of this URI to create a new URI, while keeping the existing URI object unchanged.
*
* @returns { URI } After clearing, return the URI object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
clearQuery(): URI;
/**
* Obtains the last segment of this URI.
*
* @returns { string } Returns the last decoded segment, or null if the path is empty.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
getLastSegment(): string;
/**
* Gets the decoded path segments.
*
* @returns { string[] } Return decoded path segments, each without a leading or trailing "/".
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
getSegment(): string[];
/**
* Obtains all segments of this URI.
*
* @returns { Array<string> } Return decoded path segments, each without a leading or trailing "/".
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
getSegment(): Array<string>;
/**
* Encodes a given field, appends it to the path component of this URI to create a new URI, and returns the new URI,
* while keeping the existing URI unchanged.
*
* @param { string } [pathSegment] - path segment to be added.
* @returns { URI } After adding, return the URI object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
addSegment(pathSegment: string): URI;
/**
* Appends an encoded field to the path component of this URI to create a new URI and returns the new URI,
* while keeping the existing URI unchanged.
*
* @param { string } pathSegment - Encoding path segment to be added.
* @returns { URI } After adding, return the URI object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
addEncodedSegment(pathSegment: string): URI;
/**
* Checks whether this URI is a hierarchical URI. The URI that starts with a slash (/) in scheme-specific-part is a
* hierarchical URI. Relative URIs are also hierarchical.
*
* @returns { boolean } Return true as Hierarchical, otherwise return false.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
checkHierarchical(): boolean;
/**
* Checks whether this URI is an opaque URI. The URI that does not start with a slash (/) is an opaque URI.
*
* @returns { boolean } Return true as Opaque, otherwise return false.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
checkOpaque(): boolean;
/**
* Determine whether URI is Relative.
*
* @returns { boolean } Return true as Relative, otherwise return false.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
checkRelative(): boolean;
/**
* Creates a URI based on the provided scheme, scheme-specific-part, and fragment components.
*
* @param { string } scheme - of the URI.
* @param { string } ssp -scheme-specific-part, everything between the scheme separator (':') and the fragment
* separator ('#'), which will get encoded.
* @param { string } fragment - fragment, everything after the '#', null if undefined, will get encoded.
* @returns { URI } Return Uri consisting of a given scheme, SSP, and fragment.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since arkts {'1.1':'12', '1.2':'20'}
* @arkts 1.1&1.2
*/
static createFromParts(scheme: string, ssp: string, fragment: string): URI;
/**
* Gets the protocol part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Gets the protocol part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets the protocol part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Gets/Sets the protocol part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
scheme: string;
/**
* Obtains the user information part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Obtains the user information part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the user information part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Gets/Sets Obtains the user information part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
userInfo: string;
/**
* Gets the hostname portion of the URI without a port.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Gets the hostname portion of the URI without a port.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets the hostname portion of the URI without a port.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
host: string;
/**
* Gets the port portion of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Gets the port portion of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets the port portion of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
port: string;
/**
* Gets the path portion of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Gets the path portion of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets the path portion of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Gets/Sets the path portion of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
path: string;
/**
* Gets the query portion of the URI
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Gets the query portion of the URI
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets the query portion of the URI
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Gets/Sets the query portion of the URI
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
query: string;
/**
* Gets the fragment part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Gets the fragment part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets the fragment part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Gets/Sets the fragment part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
fragment: string;
/**
* Gets the decoding permission component part of this URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Gets the decoding permission component part of this URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets the decoding permission component part of this URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Gets/Sets the decoding permission component part of this URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
authority: string;
/**
* Gets the decoding scheme-specific part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Gets the decoding scheme-specific part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets the decoding scheme-specific part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Gets/Sets the decoding scheme-specific part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
ssp: string;
/**
* Gets/Sets Obtains the encoded user information part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
encodedUserInfo: string;
/**
* Gets/Sets the encoded path portion of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
encodedPath: string;
/**
* Gets/Sets the encoded query component from this URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
encodedQuery: string;
/**
* Gets/Sets the encoded fragment part of this URI, everything after the '#'.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
encodedFragment: string;
/**
* Gets/Sets the encoded authority part of this URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
encodedAuthority: string;
/**
* Gets/Sets the scheme-specific part of this URI, i.e. everything between the scheme separator ':' and
* the fragment separator '#'.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
encodedSSP: string;
/**
* Gets the protocol part of the URI.
*
* @type { string | null }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
get scheme(): string | null;
/**
* Sets the protocol part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
set scheme(input: string | null);
/**
* Gets Obtains the user information part of the URI.
*
* @type { string | null }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
get userInfo(): string | null;
/**
* Sets Obtains the user information part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
set userInfo(input: string | null);
/**
* Gets the hostname portion of the URI without a port.
*
* @type { string | null }
* @syscap SystemCapability.Utils.Lang
* @since 20
* @arkts 1.2
*/
get host(): string | null;
/**
* Gets the port portion of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 20
* @arkts 1.2
*/
get port(): string;
/**
* Gets the path portion of the URI.
*
* @type { string | null }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
get path(): string | null;
/**
* Sets the path portion of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
set path(input: string | null);
/**
* Gets the query portion of the URI
*
* @type { string | null }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
get query(): string | null;
/**
* Sets the query portion of the URI
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
set query(input: string | null);
/**
* Gets the fragment part of the URI.
*
* @type { string | null }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
get fragment(): string | null;
/**
* Sets the fragment part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
set fragment(input: string | null);
/**
* Gets the decoding permission component part of this URI.
*
* @type { string | null }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
get authority(): string | null;
/**
* Sets the decoding permission component part of this URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
set authority(input: string | null);
/**
* Gets the decoding scheme-specific part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
get ssp(): string;
/**
* Sets the decoding scheme-specific part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
set ssp(input: string | null);
/**
* Gets Obtains the encoded user information part of the URI.
*
* @type { string | null }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
get encodedUserInfo(): string | null;
/**
* Sets Obtains the encoded user information part of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
set encodedUserInfo(input: string | null);
/**
* Gets the encoded path portion of the URI.
*
* @type { string | null }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
get encodedPath(): string | null;
/**
* Sets the encoded path portion of the URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
set encodedPath(input: string | null);
/**
* Gets the encoded query component from this URI.
*
* @type { string | null }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
get encodedQuery(): string | null;
/**
* Sets the encoded query component from this URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
set encodedQuery(input: string | null);
/**
* Gets the encoded fragment part of this URI, everything after the '#'.
*
* @type { string | null }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
get encodedFragment(): string | null;
/**
* Sets the encoded fragment part of this URI, everything after the '#'.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
set encodedFragment(input: string | null);
/**
* Gets the encoded authority part of this URI.
*
* @type { string | null }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
get encodedAuthority(): string | null;
/**
* Sets the encoded authority part of this URI.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
set encodedAuthority(input: string | null);
/**
* Gets the scheme-specific part of this URI, i.e. everything between the scheme separator ':' and
* the fragment separator '#'.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
get encodedSSP(): string;
/**
* Sets the scheme-specific part of this URI, i.e. everything between the scheme separator ':' and
* the fragment separator '#'.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 20
* @arkts 1.2
*/
set encodedSSP(input: string | null);
}
}
export default uri;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助