Uri class

الحزمة:

azure-devops-extension-api

الفئة التي تمثل Uri وتسمح بتحليل/الحصول على وإعداد الأجزاء الفردية

المنشئون

Uri(string, IUriParseOptions)

إنشاء Uri جديد.

الخصائص

absoluteUri	تعيين سلسلة uri المطلقة ل Uri هذا. استبدال كافة القيم الموجودة
hashString	سلسلة التجزئة ل uri
host	اسم مضيف uri (لا يتضمن منفذا أو مخططا)
noSchemeSeparator	إذا كان صحيحا، فلا تنبعث من فاصل "//" بعد المخطط: تعيين إلى صحيح لمخططات مثل mailto (على سبيل المثال mailto:foo@bar)
path	المسار النسبي ل uri
port	رقم منفذ uri كما هو وارد في عنوان URL. 0 إذا تم تركه في عنوان url (على سبيل المثال، المنفذ الافتراضي للمخطط).
queryParameters	صفيف معلمات الاستعلام في uri
queryString	تعيين سلسلة الاستعلام ل Uri هذا. استبدال القيمة الموجودة
scheme	نظام uri مثل http أو https

الأساليب

addQueryParam(string, null | string, boolean)	إضافة معلمة سلسلة استعلام إلى uri الحالي
addQueryParams({[key: string]: QueryParameterValueType}, boolean, string)	إضافة معلمات سلسلة الاستعلام إلى uri الحالي
getEffectivePort()	الحصول على رقم المنفذ الفعال، مع إرجاع رقم المنفذ الافتراضي إذا تم حذفه للمخطط المحدد.
getQueryParam(string)	الحصول على قيمة معلمة الاستعلام باستخدام المفتاح المحدد
removeQueryParam(string)	إزالة معلمة سلسلة استعلام

تفاصيل المنشئ

Uri(string, IUriParseOptions)

إنشاء Uri جديد.

new Uri(uri?: string, options?: IUriParseOptions)

المعلمات

uri

string

سلسلة uri اختيارية لتعبئة القيم باستخدام

options

IUriParseOptions

خيارات لتحليل سلسلة uri

تفاصيل الخاصية

absoluteUri

تعيين سلسلة uri المطلقة ل Uri هذا. استبدال كافة القيم الموجودة

absoluteUri: string

قيمة الخاصية

string

hashString

سلسلة التجزئة ل uri

hashString: string

قيمة الخاصية

string

host

اسم مضيف uri (لا يتضمن منفذا أو مخططا)

host: string

قيمة الخاصية

string

noSchemeSeparator

إذا كان صحيحا، فلا تنبعث من فاصل "//" بعد المخطط: تعيين إلى صحيح لمخططات مثل mailto (على سبيل المثال mailto:foo@bar)

noSchemeSeparator: boolean

قيمة الخاصية

boolean

path

المسار النسبي ل uri

path: string

قيمة الخاصية

string

port

رقم منفذ uri كما هو وارد في عنوان URL. 0 إذا تم تركه في عنوان url (على سبيل المثال، المنفذ الافتراضي للمخطط).

port: number

قيمة الخاصية

number

queryParameters

صفيف معلمات الاستعلام في uri

queryParameters: IQueryParameter[]

قيمة الخاصية

IQueryParameter[]

queryString

تعيين سلسلة الاستعلام ل Uri هذا. استبدال القيمة الموجودة

queryString: string

قيمة الخاصية

string

scheme

نظام uri مثل http أو https

scheme: string

قيمة الخاصية

string

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

addQueryParam(string, null | string, boolean)

إضافة معلمة سلسلة استعلام إلى uri الحالي

function addQueryParam(name: string, value: null | string, replaceExisting?: boolean)

المعلمات

name

string

اسم معلمة الاستعلام

value

null | string

قيمة معلمة الاستعلام

replaceExisting

boolean

إذا كان صحيحا، فاستبدل جميع المعلمات الموجودة بنفس الاسم

addQueryParams({[key: string]: QueryParameterValueType}, boolean, string)

إضافة معلمات سلسلة الاستعلام إلى uri الحالي

function addQueryParams(parameters: {[key: string]: QueryParameterValueType}, replaceExisting?: boolean, keyPrefix?: string)

المعلمات

parameters

{[key: string]: QueryParameterValueType}

معلمات الاستعلام المراد إضافتها

replaceExisting

boolean

إذا كان صحيحا، فاستبدل جميع المعلمات الموجودة بنفس الاسم

keyPrefix

string

إذا تم تحديدها، قيمة يتم إلحاقها بكافة مفاتيح معلمات الاستعلام

getEffectivePort()

الحصول على رقم المنفذ الفعال، مع إرجاع رقم المنفذ الافتراضي إذا تم حذفه للمخطط المحدد.

function getEffectivePort(): number

المرتجعات

number

getQueryParam(string)

الحصول على قيمة معلمة الاستعلام باستخدام المفتاح المحدد

function getQueryParam(name: string): undefined | null | string

المعلمات

name

string

اسم معلمة الاستعلام

المرتجعات

undefined | null | string

removeQueryParam(string)

إزالة معلمة سلسلة استعلام

function removeQueryParam(name: string)

المعلمات

name

string

اسم معلمة الاستعلام