LinkGenerator.GetUriByAddress Метод

Определение

Пространство имен:

Microsoft.AspNetCore.Routing

Сборка:

Microsoft.AspNetCore.Routing.Abstractions.dll

Пакет:

Microsoft.AspNetCore.App.Ref v8.0.0

Перегрузки

GetUriByAddress<TAddress>(TAddress, RouteValueDictionary, String, HostString, PathString, FragmentString, LinkOptions)	Создает абсолютный URI на основе предоставленных значений.
GetUriByAddress<TAddress>(HttpContext, TAddress, RouteValueDictionary, RouteValueDictionary, String, Nullable<HostString>, Nullable<PathString>, FragmentString, LinkOptions)	Создает абсолютный URI на основе предоставленных значений и HttpContext.

GetUriByAddress<TAddress>(TAddress, RouteValueDictionary, String, HostString, PathString, FragmentString, LinkOptions)

Создает абсолютный URI на основе предоставленных значений.

public abstract string? GetUriByAddress<TAddress> (TAddress address, Microsoft.AspNetCore.Routing.RouteValueDictionary values, string scheme, Microsoft.AspNetCore.Http.HostString host, Microsoft.AspNetCore.Http.PathString pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions? options = default);

abstract member GetUriByAddress : 'Address * Microsoft.AspNetCore.Routing.RouteValueDictionary * string * Microsoft.AspNetCore.Http.HostString * Microsoft.AspNetCore.Http.PathString * Microsoft.AspNetCore.Http.FragmentString * Microsoft.AspNetCore.Routing.LinkOptions -> string

Public MustOverride Function GetUriByAddress(Of TAddress) (address As TAddress, values As RouteValueDictionary, scheme As String, host As HostString, Optional pathBase As PathString = Nothing, Optional fragment As FragmentString = Nothing, Optional options As LinkOptions = Nothing) As String

Параметры типа

TAddress

Тип адреса.

Параметры

address

TAddress

Значение адреса. Используется для разрешения конечных точек.

values

RouteValueDictionary

Значения маршрута. Используется для развертывания параметров в шаблоне маршрута.

scheme

String

Схема URI, примененная к результирующему URI.

host

HostString

Узел или центр URI, примененный к результирующему URI. Дополнительные сведения о последствиях для безопасности см. в разделе примечаний host.

pathBase

PathString

Необязательный путь URI. Добавляется к пути в результирующем универсальном коде ресурса (URI).

fragment

FragmentString

Необязательный фрагмент URI. Добавляется к результирующему универсальному коду ресурса (URI).

options

LinkOptions

Необязательный класс LinkOptions. Параметры предоставленного объекта переопределяют параметры с соответствующими именами из RouteOptions.

Возвращаемое значение

String

Абсолютный URI или null.

Комментарии

Значение host должно быть доверенным значением. Использование значения текущего запроса может позволить ненадежным входным данным влиять на результирующий универсальный Host код ресурса (URI), если только заголовок не был проверен. Инструкции по правильной проверке заголовка Host в среде развертывания см. в документации по развертыванию.

GetUriByAddress<TAddress>(HttpContext, TAddress, RouteValueDictionary, RouteValueDictionary, String, Nullable<HostString>, Nullable<PathString>, FragmentString, LinkOptions)

Создает абсолютный URI на основе предоставленных значений и HttpContext.

public abstract string? GetUriByAddress<TAddress> (Microsoft.AspNetCore.Http.HttpContext httpContext, TAddress address, Microsoft.AspNetCore.Routing.RouteValueDictionary values, Microsoft.AspNetCore.Routing.RouteValueDictionary? ambientValues = default, string? scheme = default, Microsoft.AspNetCore.Http.HostString? host = default, Microsoft.AspNetCore.Http.PathString? pathBase = default, Microsoft.AspNetCore.Http.FragmentString fragment = default, Microsoft.AspNetCore.Routing.LinkOptions? options = default);

abstract member GetUriByAddress : Microsoft.AspNetCore.Http.HttpContext * 'Address * Microsoft.AspNetCore.Routing.RouteValueDictionary * Microsoft.AspNetCore.Routing.RouteValueDictionary * string * Nullable<Microsoft.AspNetCore.Http.HostString> * Nullable<Microsoft.AspNetCore.Http.PathString> * Microsoft.AspNetCore.Http.FragmentString * Microsoft.AspNetCore.Routing.LinkOptions -> string

Public MustOverride Function GetUriByAddress(Of TAddress) (httpContext As HttpContext, address As TAddress, values As RouteValueDictionary, Optional ambientValues As RouteValueDictionary = Nothing, Optional scheme As String = Nothing, Optional host As Nullable(Of HostString) = Nothing, Optional pathBase As Nullable(Of PathString) = Nothing, Optional fragment As FragmentString = Nothing, Optional options As LinkOptions = Nothing) As String

Параметры типа

TAddress

Тип адреса.

Параметры

httpContext

HttpContext

Объект , HttpContext связанный с текущим запросом.

address

TAddress

Значение адреса. Используется для разрешения конечных точек.

values

RouteValueDictionary

Значения маршрута. Используется для развертывания параметров в шаблоне маршрута.

ambientValues

RouteValueDictionary

Значения, связанные с текущим запросом. Необязательный элемент.

scheme

String

Схема URI, примененная к результирующему URI. Необязательный элемент. Если значение не указано, будет использоваться значение Scheme .

host

Nullable<HostString>

Узел или центр URI, примененный к результирующему URI. Необязательный элемент. Если значение не указано, будет использоваться значение Host . Дополнительные сведения о последствиях для безопасности см. в разделе примечаний host.

pathBase

Nullable<PathString>

Необязательный путь URI. Добавляется к пути в результирующем универсальном коде ресурса (URI). Если значение не указано, будет использоваться значение PathBase .

fragment

FragmentString

Необязательный фрагмент URI. Добавляется к результирующему универсальному коду ресурса (URI).

options

LinkOptions

Необязательный класс LinkOptions. Параметры предоставленного объекта переопределяют параметры с соответствующими именами из RouteOptions.

Возвращаемое значение

String

Универсальный код ресурса (URI) с абсолютным путем или null.

Комментарии

Значение host должно быть доверенным значением. Использование значения текущего запроса может позволить ненадежным входным данным влиять на результирующий универсальный Host код ресурса (URI), если только заголовок не был проверен. Инструкции по правильной проверке заголовка Host в среде развертывания см. в документации по развертыванию.