scheme
scheme: (HttpUrlBuilder, string) -> HttpUrlBuilderhttp or https; anything else is IllegalArgumentException.
HttpUrlBuilder.new()
HttpUrl.get(…):newBuilder()| Method | Returns | Description |
|---|---|---|
scheme(string) | HttpUrlBuilder | http or https; anything else is IllegalArgumentException. |
host(string) | HttpUrlBuilder | The host; one OkHttp cannot canonicalize is IllegalArgumentException. |
port(number) | HttpUrlBuilder | The port, 1 to 65535. |
username(string) | HttpUrlBuilder | The user name. |
password(string) | HttpUrlBuilder | The password. |
addPathSegment(string) | HttpUrlBuilder | One path segment (a / in it is encoded); .. removes the last. |
addPathSegments(string) | HttpUrlBuilder | /-separated path segments. |
addEncodedPathSegment(string) | HttpUrlBuilder | One path segment, already encoded. |
addEncodedPathSegments(string) | HttpUrlBuilder | Path segments, already encoded. |
encodedPath(string) | HttpUrlBuilder | The whole path, encoded, starting with /. |
query(string?) | HttpUrlBuilder | The whole query (nil for none). |
addQueryParameter(string, string?) | HttpUrlBuilder | One more query parameter (value nil for a bare name). |
addEncodedQueryParameter(string, string?) | HttpUrlBuilder | One more query parameter, already encoded. |
setQueryParameter(string, string?) | HttpUrlBuilder | Replace every value of name with this one, at the end. |
removeAllQueryParameters(string) | HttpUrlBuilder | Remove every value of name. |
fragment(string?) | HttpUrlBuilder | The fragment (nil for none). |
build() | HttpUrl | The URL; without a scheme or host it is IllegalStateException. |
new() | HttpUrlBuilder | An empty builder. |
| Method | Returns | Description |
|---|---|---|
HttpUrl.newBuilder | HttpUrlBuilder | A builder holding this URL. |
HttpUrlBuilderClass.new | HttpUrlBuilder | An empty builder. |
schemescheme: (HttpUrlBuilder, string) -> HttpUrlBuilderhttp or https; anything else is IllegalArgumentException.
hosthost: (HttpUrlBuilder, string) -> HttpUrlBuilderThe host; one OkHttp cannot canonicalize is IllegalArgumentException.
portport: (HttpUrlBuilder, number) -> HttpUrlBuilderThe port, 1 to 65535.
usernameusername: (HttpUrlBuilder, string) -> HttpUrlBuilderThe user name.
passwordpassword: (HttpUrlBuilder, string) -> HttpUrlBuilderThe password.
addPathSegmentaddPathSegment: (HttpUrlBuilder, string) -> HttpUrlBuilderOne path segment (a / in it is encoded); .. removes the last.
addPathSegmentsaddPathSegments: (HttpUrlBuilder, string) -> HttpUrlBuilder/-separated path segments.
addEncodedPathSegmentaddEncodedPathSegment: (HttpUrlBuilder, string) -> HttpUrlBuilderOne path segment, already encoded.
addEncodedPathSegmentsaddEncodedPathSegments: (HttpUrlBuilder, string) -> HttpUrlBuilderPath segments, already encoded.
encodedPathencodedPath: (HttpUrlBuilder, string) -> HttpUrlBuilderThe whole path, encoded, starting with /.
queryquery: (HttpUrlBuilder, string?) -> HttpUrlBuilderThe whole query (nil for none).
addQueryParameteraddQueryParameter: (HttpUrlBuilder, string, string?) -> HttpUrlBuilderOne more query parameter (value nil for a bare name).
addEncodedQueryParameteraddEncodedQueryParameter: (HttpUrlBuilder, string, string?) -> HttpUrlBuilderOne more query parameter, already encoded.
setQueryParametersetQueryParameter: (HttpUrlBuilder, string, string?) -> HttpUrlBuilderReplace every value of name with this one, at the end.
removeAllQueryParametersremoveAllQueryParameters: (HttpUrlBuilder, string) -> HttpUrlBuilderRemove every value of name.
fragmentfragment: (HttpUrlBuilder, string?) -> HttpUrlBuilderThe fragment (nil for none).
buildbuild: (HttpUrlBuilder) -> HttpUrlThe URL; without a scheme or host it is IllegalStateException.
newnew: () -> HttpUrlBuilderAn empty builder.