URLBuilder class

الحزمة:

@azure/ms-rest-js

فئة تتعامل مع إنشاء عناوين URL وتعديلها وتحليلها.

الأساليب

appendPath(undefined | string)	إلحاق المسار المتوفر بمسار URL الحالي. إذا كان المسار المتوفر يحتوي على استعلام، فستتم إضافته إلى عنوان URL هذا أيضا.
getHost()	احصل على المضيف الذي تم تعيينه في عنوان URL هذا.
getPath()	احصل على المسار الذي تم تعيينه في عنوان URL هذا.
getPort()	احصل على المنفذ الذي تم تعيينه في عنوان URL هذا.
getQuery()	احصل على الاستعلام في عنوان URL هذا.
getQueryParameterValue(string)	احصل على قيمة معلمة الاستعلام مع اسم معلمة الاستعلام المتوفرة. إذا لم تكن هناك معلمة استعلام بالاسم المقدم، إرجاع غير معرف.
getScheme()	احصل على النظام الذي تم تعيينه في عنوان URL هذا.
parse(string)
replaceAll(string, string)	إذا تم العثور على searchValue المتوفر في URLBuilder هذا، فاستبدله ب replaceValue المتوفر.
setHost(undefined | string)	تعيين المضيف لعنون URL هذا. إذا كان المضيف المتوفر يحتوي على أجزاء أخرى من عنوان URL (مثل منفذ أو مسار أو استعلام)، فستتم إضافة هذه الأجزاء إلى عنوان URL هذا أيضا.
setPath(undefined | string)	تعيين مسار عنوان URL هذا. إذا كان المسار المتوفر يحتوي على استعلام، فستتم إضافته إلى عنوان URL هذا أيضا.
setPort(undefined | string | number)	تعيين المنفذ لعنون URL هذا. إذا كان المنفذ المتوفر يحتوي على أجزاء أخرى من عنوان URL (مثل مسار أو استعلام)، فستتم إضافة هذه الأجزاء إلى عنوان URL هذا أيضا.
setQuery(undefined | string)	تعيين الاستعلام في عنوان URL هذا.
setQueryParameter(string, any)	تعيين معلمة استعلام بالاسم والقيمة المتوفرين في استعلام URL هذا. إذا كانت قيمة معلمة الاستعلام المتوفرة غير معرفة أو فارغة، فستتم إزالة معلمة الاستعلام إذا كانت موجودة.
setScheme(undefined | string)	تعيين المخطط/البروتوكول لعنون URL هذا. إذا كان النظام المقدم يحتوي على أجزاء أخرى من عنوان URL (مثل مضيف أو منفذ أو مسار أو استعلام)، فستتم إضافة هذه الأجزاء إلى عنوان URL هذا أيضا.
toString()

تفاصيل الأسلوب

appendPath(undefined | string)

إلحاق المسار المتوفر بمسار URL الحالي. إذا كان المسار المتوفر يحتوي على استعلام، فستتم إضافته إلى عنوان URL هذا أيضا.

function appendPath(path: undefined | string)

المعلمات

path

undefined | string

getHost()

احصل على المضيف الذي تم تعيينه في عنوان URL هذا.

function getHost(): undefined | string

المرتجعات

undefined | string

getPath()

احصل على المسار الذي تم تعيينه في عنوان URL هذا.

function getPath(): undefined | string

المرتجعات

undefined | string

getPort()

احصل على المنفذ الذي تم تعيينه في عنوان URL هذا.

function getPort(): undefined | string

المرتجعات

undefined | string

getQuery()

احصل على الاستعلام في عنوان URL هذا.

function getQuery(): undefined | string

المرتجعات

undefined | string

getQueryParameterValue(string)

احصل على قيمة معلمة الاستعلام مع اسم معلمة الاستعلام المتوفرة. إذا لم تكن هناك معلمة استعلام بالاسم المقدم، إرجاع غير معرف.

function getQueryParameterValue(queryParameterName: string): undefined | string | string[]

المعلمات

queryParameterName

string

المرتجعات

undefined | string | string[]

getScheme()

احصل على النظام الذي تم تعيينه في عنوان URL هذا.

function getScheme(): undefined | string

المرتجعات

undefined | string

parse(string)

static function parse(text: string): URLBuilder

المعلمات

text

string

المرتجعات

URLBuilder

replaceAll(string, string)

إذا تم العثور على searchValue المتوفر في URLBuilder هذا، فاستبدله ب replaceValue المتوفر.

function replaceAll(searchValue: string, replaceValue: string)

المعلمات

searchValue

string

replaceValue

string

setHost(undefined | string)

تعيين المضيف لعنون URL هذا. إذا كان المضيف المتوفر يحتوي على أجزاء أخرى من عنوان URL (مثل منفذ أو مسار أو استعلام)، فستتم إضافة هذه الأجزاء إلى عنوان URL هذا أيضا.

function setHost(host: undefined | string)

المعلمات

host

undefined | string

setPath(undefined | string)

تعيين مسار عنوان URL هذا. إذا كان المسار المتوفر يحتوي على استعلام، فستتم إضافته إلى عنوان URL هذا أيضا.

function setPath(path: undefined | string)

المعلمات

path

undefined | string

setPort(undefined | string | number)

تعيين المنفذ لعنون URL هذا. إذا كان المنفذ المتوفر يحتوي على أجزاء أخرى من عنوان URL (مثل مسار أو استعلام)، فستتم إضافة هذه الأجزاء إلى عنوان URL هذا أيضا.

function setPort(port: undefined | string | number)

المعلمات

port

undefined | string | number

setQuery(undefined | string)

تعيين الاستعلام في عنوان URL هذا.

function setQuery(query: undefined | string)

المعلمات

query

undefined | string

setQueryParameter(string, any)

تعيين معلمة استعلام بالاسم والقيمة المتوفرين في استعلام URL هذا. إذا كانت قيمة معلمة الاستعلام المتوفرة غير معرفة أو فارغة، فستتم إزالة معلمة الاستعلام إذا كانت موجودة.

function setQueryParameter(queryParameterName: string, queryParameterValue: any)

المعلمات

queryParameterName

string

queryParameterValue

any

setScheme(undefined | string)

تعيين المخطط/البروتوكول لعنون URL هذا. إذا كان النظام المقدم يحتوي على أجزاء أخرى من عنوان URL (مثل مضيف أو منفذ أو مسار أو استعلام)، فستتم إضافة هذه الأجزاء إلى عنوان URL هذا أيضا.

function setScheme(scheme: undefined | string)

المعلمات

scheme

undefined | string

toString()

function toString(): string

المرتجعات

string